Pin RL and Gym versions to avoid breaking changes
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 349
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 318
Description
Describe the bug
The documentation / tutorial does not pin a specific commit of RL and Gym. Main branches for both are fast moving and introduce breaking changes often.
Simple things like naming changes can be breaking.
It may get auto-resolved with NeMo Gym support in the NeMo RL container, however
- We do not have Gym in the RL container right now.
- There are some users who may choose to not use containers.
Steps/Code to reproduce bug
Expected behavior
NeMo RL and Gym interoperate cleanly, always. We guide users to use only compatible and tested versions.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked RL training tutorial and reproduce its setup using the current NeMo RL and Gym references. Identify where dependency versions are specified or omitted, then document compatible, tested pins so the tutorial guides users toward a stable combination. Verify the tutorial with those pinned versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, machine-learning
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100