Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lbliii wants to merge 3 commits into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cc5617f
docs: offer pip install nemo-gym as default install path
lbliii Jun 16, 2026
3db402c
Merge branch 'main' into lbliii/fix-pr-1311-conflicts
lbliii Jun 16, 2026
e010fd4
docs: rely on .python-version for the git clone install path
lbliii Jun 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,17 @@ Requires Python 3.12+ on x86_64 or ARM64 (Linux, macOS, Windows via WSL2). No GP

Requires [uv](https://docs.astral.sh/uv/getting-started/installation/) and Python 3.12+.

```bash
uv venv --python 3.12 && source .venv/bin/activate
uv pip install nemo-gym
```

To get the newest features and environments or to contribute, clone from git instead:

```bash
git clone git@github.com:NVIDIA-NeMo/Gym.git
cd Gym
uv venv --python 3.12 && source .venv/bin/activate
uv venv && source .venv/bin/activate
uv sync
```

Expand Down
12 changes: 10 additions & 2 deletions fern/versions/latest/pages/get-started/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,23 @@ position: 2
Python 3.12 is required. Refer to [Prerequisites](/get-started/prerequisites) for full system requirements.
</Info>

Clone from git to get the latest features and environments. If you intend to use NeMo Gym with NeMo RL, use the latest NGC container.
Pip install for the latest stable release, or clone from git for the newest features and environments. If you intend to use NeMo Gym with NeMo RL, use the latest NGC container.

<Tabs>
<Tab title="Pip">

```bash
uv venv --python 3.12 && source .venv/bin/activate
uv pip install nemo-gym
```

</Tab>
<Tab title="Git">

```bash
git clone git@github.com:NVIDIA-NeMo/Gym.git
cd Gym
uv venv --python 3.12 && source .venv/bin/activate
uv venv && source .venv/bin/activate
uv sync
```

Expand Down
Loading