Skip to content

Revise the README#11

Merged
MasterJH5574 merged 1 commit intomlc-ai:mainfrom
haok1402:0404-readme-revision
Apr 4, 2026
Merged

Revise the README#11
MasterJH5574 merged 1 commit intomlc-ai:mainfrom
haok1402:0404-readme-revision

Conversation

@haok1402
Copy link
Copy Markdown
Collaborator

@haok1402 haok1402 commented Apr 4, 2026

  1. Move "Model Compatibility and Evaluation" section into the fourth step for getting started, as evaluation is the natural next step after the training completes.
  2. Revise the "Attribution" section to include the CMU FLAME center and DGX B200 from NVIDIA for providing us with the compute resources.
  3. uv venv would prompt the user what to do if the virtual environment exists, so we can remove that separate line of comment for "skipping". It is the uv's responsiblity.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README.md to provide a more detailed and structured 'Getting Started' guide, covering dataset preparation, training configuration, and checkpoint export. It also updates the attribution section to acknowledge CMU, the FLAME Center, and NVIDIA. The review feedback suggests several improvements for better documentation clarity and consistency, including adding trailing slashes to directory links, providing direct links to configuration files, refining the description of the export step, and ensuring the attribution to original sources remains complete.

@haok1402 haok1402 force-pushed the 0404-readme-revision branch 11 times, most recently from 6588867 to 6502b70 Compare April 4, 2026 15:48

```bash
git clone https://github.com/mlc-ai/Pith-Train.git && cd Pith-Train
uv venv # skip if you already have a virtual environment
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this intentional?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MasterJH5574 Good catch. I just want to remove that in-line comment with uv venv. Fixed.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah no I mean the comment was added intentionally, since when there is already an existing environment, running uv venv will reset that environment.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it ; I've reverted this line to keep the comment.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay thank you!

@haok1402 haok1402 force-pushed the 0404-readme-revision branch 2 times, most recently from 36e1940 to 408126d Compare April 4, 2026 19:20
@haok1402 haok1402 force-pushed the 0404-readme-revision branch from 408126d to cc44cb3 Compare April 4, 2026 21:03
@MasterJH5574 MasterJH5574 merged commit 1dd6375 into mlc-ai:main Apr 4, 2026
1 check passed
@haok1402 haok1402 deleted the 0404-readme-revision branch April 4, 2026 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants