Minimize README contents #3020
Open
Minimize README contents #3020
+206
−373
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: meg miranda <mmiranda@nvidia.com>
…tall Signed-off-by: meg miranda <mmiranda@nvidia.com>
…n(it is in the sglang), moved our quick start link after the news. Signed-off-by: meg miranda <mmiranda@nvidia.com>
…>ecosystem libraries) to overview, merged a bit of my draft overview content from before. Overview needs some technical massage, I have some points wrong in my descriptions. Signed-off-by: meg miranda <mmiranda@nvidia.com>
…ility with doc team structure template Signed-off-by: meg miranda <mmiranda@nvidia.com>
Signed-off-by: meg miranda <mmiranda@nvidia.com>
Signed-off-by: meg miranda <mmiranda@nvidia.com>
Signed-off-by: meg miranda <mmiranda@nvidia.com>
Phlip79
requested changes
Jan 22, 2026
| ``` | ||
| **Megatron-LM**: GitHub repository that includes Megatron-Core, as well as example training loops utilizing Megatron-Core. | ||
|
|
||
| **Megatron-Bridge**: a separate repository that is ideal for users who wish to train a Hugging Face model. |
Member
There was a problem hiding this comment.
Please add link: https://github.com/NVIDIA-NeMo/Megatron-Bridge.
| It serves as a powerful bridge, conversion, and verification layer between Hugging Face and Megatron Core. | ||
|
|
||
| **→ [Complete Installation Guide](#installation)** - Docker, pip variants (dev,lts,etc.), and system requirements | ||
| **NeMo RL**: library that streamlines and scales reinforcement learning, that leverages Megatron-Core. |
| Megatron-Core and Megatron-LM are open-source tools that are typically used together to train LLMs at scale across GPUs. Megatron-Core expands the capability of Megatron-LM. Megatron Bridge connects Megatron-Core and Megatron-LM to other popular training models, such as Hugging Face. | ||
|
|
||
|
|
||
| ## Megatron-LM: |
Member
There was a problem hiding this comment.
Suggested change
| ## Megatron-LM: | |
| ## Megatron-LM |
| - End-to-end examples from data prep to evaluation | ||
| - Research-focused tools and utilities | ||
|
|
||
| ## Megatron Core |
Member
There was a problem hiding this comment.
Please put the Megatron Core section before Megatron-LM
|
|
||
| Megatron-Core is compatible with all NVIDIA Tensor Core GPUs and popular LLM architectures such as GPT, BERT, T5, and RETRO. | ||
|
|
||
| [](https://docs.nvidia.com/Megatron-Core/developer-guide/latest/index.html) |
Member
There was a problem hiding this comment.
Can you fix section titles to make them use ## instead of #. Also, can we remove colons from titles?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do ?
Contribution process
flowchart LR A[Pre-checks] --> B[PR Tests] subgraph Code Review/Approval C1[Expert Review] --> C2[Final Review] end B --> C1 C2 --> D[Merge]Pre-checks
Core 0.8)Code review
The following process is enforced via the CODEOWNERS file for changes into
megatron/core. For changes outside ofmegatron/core, it is up to the PR author whether or not to tag the Final Reviewer team.For MRs into `main` branch
Feel free to message or comment the @mcore-oncall to help accelerate your merge into main. The less complex your PR is, the faster it will be approved and merged!
(Step 1): Add PR label
Expert Review(Step 2): Collect the expert reviewers reviews
Expert Reviewlabel when your PR is ready for review.Final Review might get declined if these requirements are not fulfilled.
(Step 3): Final Review
Final Reviewlabel(Optional Step 4): Cherry-pick into release branch
If this PR also needs to be merged into
core_r*release branches, after this PR has been merged, selectCherry-pickto open a new PR into the release branch.For MRs into `dev` branch
The proposed review process for `dev` branch is under active discussion.MRs are mergable after one approval by either
eharper@nvidia.comorzijiey@nvidia.com.Merging your PR
Any member of core-adlr and
core-nemowill be able to merge your PR.