Skip to content

docs: offer pip install nemo-gym as default install path#1623

Closed
lbliii wants to merge 3 commits into
mainfrom
lbliii/fix-pr-1311-conflicts
Closed

docs: offer pip install nemo-gym as default install path#1623
lbliii wants to merge 3 commits into
mainfrom
lbliii/fix-pr-1311-conflicts

Conversation

@lbliii

@lbliii lbliii commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Re-applies the surviving intent of #1311 on top of the docs migration that landed since it was opened.

  • README quick start now leads with uv pip install nemo-gym, with git clone … uv sync kept directly below for contributors / unreleased features.
  • Installation page gains a Pip tab as the first/default tab.

Why this supersedes #1311

The docs migration independently absorbed ~16 of #1311's 17 files — the README quick-start rewrite, the detailed-setup → installation + new prerequisites split, and the link cleanups are all already on main. #1311's remaining edits would now re-introduce regressions main has since fixed (# H1 bodies, /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-gym 0.3.0 and 0.3.1 are published on PyPI.
  • The published wheel ships the quickstart configs and example data (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

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>
@copy-pr-bot

copy-pr-bot Bot commented Jun 16, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions

Copy link
Copy Markdown

🌿 Preview your docs: https://nvidia-preview-lbliii-fix-pr-1311-conflicts.docs.buildwithfern.com/nemo/gym

Here are the markdown pages you've updated:

@lbliii lbliii requested a review from cwing-nvidia June 16, 2026 17:25
@kajalj22

kajalj22 commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Could you use this python version file instead of the hard coded version? https://github.com/NVIDIA-NeMo/Gym/blob/main/.python-version
Helps keep the flow dynamic for future version bumps

@kajalj22 kajalj22 self-requested a review June 16, 2026 17:43

@kajalj22 kajalj22 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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>
@lbliii

lbliii commented Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @kajalj22 — good call. Updated the git clone path to use a bare uv venv, which reads the repo's .python-version automatically, so it stays dynamic across future version bumps.

I kept the explicit --python 3.12 on the pip install path only: that flow runs outside a checkout (no .python-version on disk to read), so dropping it would risk landing users on an older default interpreter. Open to other ideas there if you'd prefer a different approach.

@cmunley1

Copy link
Copy Markdown
Contributor

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

@sephmard sephmard added the documentation Improvements to documentation label Jun 26, 2026
@sephmard

Copy link
Copy Markdown
Contributor

Closing in favor of #1675, which covers the same PyPI install changes to as part of a broader CLI reference update.

@sephmard sephmard closed this Jun 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants