Skip to content

docs: Restructure README with backend-specific quick start and setup guides#1091

Merged
terrykong merged 37 commits intomainfrom
euronymous-aithal-patch-1
Sep 24, 2025
Merged

docs: Restructure README with backend-specific quick start and setup guides#1091
terrykong merged 37 commits intomainfrom
euronymous-aithal-patch-1

Conversation

@euronymous-aithal
Copy link
Copy Markdown
Contributor

@euronymous-aithal euronymous-aithal commented Sep 7, 2025

What does this PR do ?

Add a one line overview of what this PR aims to accomplish.
updating readme

Issues

List issues that this PR closes (syntax):

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you run the unit tests and functional tests locally? Visit our Testing Guide for how to run tests
  • Did you add or update any necessary documentation? Visit our Document Development Guide for how to write, build and test the docs.

Additional Information

  • ...

Summary by CodeRabbit

  • Documentation
    • README redesigned into an onboarding/architecture guide with a new Overview emphasizing scalability, multimodal support, and open-source design.
    • Added a collapsible "Previous News" block and reorganized navigation into a two-column Quick Start and Support Matrix/TOC.
    • Introduced explicit Training (DTensor, Megatron) and Generation (vLLM, Megatron) backend sections with auto-detection and config guidance.
    • Expanded prerequisites, detailed setup/run examples (single-/multi-node), GRPO and finetuning runnable examples, and clearer environment/build warnings.

terrykong
terrykong previously approved these changes Sep 7, 2025
@euronymous-aithal euronymous-aithal marked this pull request as ready for review September 7, 2025 21:07
Comment thread README.md Outdated
Comment thread README.md Outdated
@terrykong
Copy link
Copy Markdown
Collaborator

@euronymous-aithal did you want to fold any of this PR into yours? https://github.com/NVIDIA-NeMo/RL/pull/965/files

@euronymous-aithal
Copy link
Copy Markdown
Contributor Author

@terrykong i folded changes from "https://github.com/NVIDIA-NeMo/RL/pull/965/files" to the current PR. please review and let me know

@terrykong terrykong changed the title Update README.md doc: Update README.md Sep 9, 2025
@terrykong
Copy link
Copy Markdown
Collaborator

lgtm. thanks @euronymous-aithal

@terrykong terrykong changed the title doc: Update README.md docs: Update README.md Sep 9, 2025
euronymous-aithal and others added 15 commits September 24, 2025 18:20
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
Co-authored-by: jgerh <163925524+jgerh@users.noreply.github.com>
Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
updated based on @jgerh 's feedback

Signed-off-by: Ashwath Aithal <aaithal@nvidia.com>
@terrykong terrykong force-pushed the euronymous-aithal-patch-1 branch from 105af25 to e99331a Compare September 24, 2025 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants