docs: switch default install to pip install nemo-gym#1311
Draft
cwing-nvidia wants to merge 10 commits into
Draft
docs: switch default install to pip install nemo-gym#1311cwing-nvidia wants to merge 10 commits into
cwing-nvidia wants to merge 10 commits into
Conversation
Collapse the 4-page get-started folder (quickstart, detailed setup, rollout collection, index) into a single Getting Started page that covers the full user journey: install, CLI, list environments, run evaluation, run training, and next steps. Place it directly after the Home page in the sidebar navigation. Signed-off-by: Chris Wing <cwing@nvidia.com> Made-with: Cursor
Slim down README Quick Start to git clone install, ng_help, ng_list_benchmarks, and 3-step evaluation flow. Add requirements one-liner (Python 3.12+, x86_64/ARM64, no GPU). Align Next Steps with Getting Started cards. Update Getting Started page: git clone tab first, simplified container link, requirements detail. Add redirects for deleted get-started/* pages. Update all internal links across docs to point to /getting-started instead of the old /get-started/* paths. Signed-off-by: Chris Wing <cwing@nvidia.com> Made-with: Cursor
…ages Move the single getting-started page into a get-started/ directory as quickstart.mdx and add a new prerequisites page with hardware/software requirements. Signed-off-by: Chris Wing <cwing@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Extract installation steps from quickstart into a dedicated installation page with ng_version verification. Update prerequisites to link to installation, and add Info callout to quickstart linking back to installation for users arriving from search. Signed-off-by: Chris Wing <cwing@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Use mcqa environment with real paths instead of placeholders so users can copy-paste and verify each step. Add env.yaml configuration section, expected output after each command, uv install steps to git clone path, and clarify ng_list_benchmarks scope. Signed-off-by: Chris Wing <cwing@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Update README quickstart with expected output, mcqa link, model compatibility note, and consistent wording. Reorder docs quickstart to Configure Model → Run Evaluation → Explore, moving CLI and environment listing after the user's first successful run. Signed-off-by: Chris Wing <cwing@nvidia.com> Co-authored-by: Cursor <cursoragent@cursor.com>
- Replace heredoc with plain YAML block for env.yaml in README - Move uv to prerequisites, use uv consistently for both git and pip paths - Add simple_agent mention to eval intro text - Update expected output to match current ng_collect_rollouts format - Simplify container tab and installation intro wording - Update model server note to reference Configure Model page - Use +limit=5 +num_repeats=1 for quickstart eval command Signed-off-by: Chris Wing <cwing@nvidia.com>
Training connection is better served by the Next Steps cards at the end of the quickstart rather than mid-flow where it confuses eval-only users. Signed-off-by: Chris Wing <cwing@nvidia.com>
The quickstart CLI commands require features not yet available in the current PyPI release (v0.2.1). Remove the pip tab to avoid a broken user experience. Will be re-added when 0.3.0 ships (#1191). Signed-off-by: Chris Wing <cwing@nvidia.com>
Make pip the default/first tab on the installation page and the README quick start. Git clone moves to second tab for contributors and users who need the latest unreleased features. Signed-off-by: Chris Wing <cwing@nvidia.com>
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
pip install nemo-gymthe default (first tab) on the installation pageBlocked on
This PR should merge after NeMo Gym 0.3.0 is published to PyPI. The quickstart CLI commands (
ng_list_benchmarks, updatedng_collect_rolloutsflags) are not available in v0.2.1.Ref #1191
Test plan
pip install nemo-gyminstalls 0.3.0+ with all quickstart CLI commands