docs: offer pip install nemo-gym as default install path#1623
Conversation
Re-applies the surviving intent of #1311 on top of the docs migration: add a Pip install option (uv pip install nemo-gym) as the default in the README quick start and as the first tab on the installation page, keeping git clone as the path for contributors / unreleased features. The migration already absorbed the rest of #1311 (README rewrite, installation/prerequisites split, link cleanups), and nemo-gym 0.3.x is now on PyPI with quickstart configs/data shipped in the wheel, so the 0.3.0-release blocker is resolved. Ref #1191, supersedes #1311 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Lawrence Lane <llane@nvidia.com>
|
🌿 Preview your docs: https://nvidia-preview-lbliii-fix-pr-1311-conflicts.docs.buildwithfern.com/nemo/gym Here are the markdown pages you've updated: |
|
Could you use this python version file instead of the hard coded version? https://github.com/NVIDIA-NeMo/Gym/blob/main/.python-version |
kajalj22
left a comment
There was a problem hiding this comment.
Left a minor ask to keep python version dynamic
The cloned repo ships a .python-version (3.12), which uv venv reads automatically, so drop the hard-coded --python 3.12 there to keep the flow dynamic across future version bumps. The pip install path runs outside the checkout where no .python-version is present, so it keeps the explicit version to avoid landing on an older default interpreter. Addresses review feedback on #1623. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Lawrence Lane <llane@nvidia.com>
|
Thanks @kajalj22 — good call. Updated the git clone path to use a bare I kept the explicit |
|
I do not think pypi should be the default path yet. I don't know many people using it like this, it creates 2 level subdirs for venvs, and its not the best experience for developing locally. I think that it should only become default path as we use it ourselves this way more, or if we develop a environment package registry |
|
Closing in favor of #1675, which covers the same PyPI install changes to as part of a broader CLI reference update. |
Summary
Re-applies the surviving intent of #1311 on top of the docs migration that landed since it was opened.
uv pip install nemo-gym, withgit clone … uv synckept directly below for contributors / unreleased features.Why this supersedes #1311
The docs migration independently absorbed ~16 of #1311's 17 files — the README quick-start rewrite, the
detailed-setup → installation+ newprerequisitessplit, and the link cleanups are all already on main. #1311's remaining edits would now re-introduce regressions main has since fixed (# H1bodies,/latest/link prefixes), so a conflict resolution isn't the right tool. This applies only the one surviving idea — pip install as the default — using main's current conventions (no H1,/get-started/links).Blocker resolved
#1311 was blocked on the 0.3.0 PyPI release. That's done:
nemo-gym0.3.0 and 0.3.1 are published on PyPI.resources_servers/mcqa/configs/mcqa.yaml,.../data/example.jsonl), so the quickstart's repo-relative paths work from a pip install — not just a git clone.Ref #1191. Supersedes #1311 (recommend closing it).
🤖 Generated with Claude Code