NVIDIA-NeMo / NVIDIA-NeMo/Gym

bug: Lacks Guidance and Uses Unclear Taxonomy on Domain Values(e.g., agent)

Open
#600 1 comment 0 reactions 0 assignees View on GitHub

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

In the “Configure the Domain” step of the my_weather_tool resource server tutorial, users are instructed to set domain: agent and are given a list of possible domain values. However, the domain categories are unevenly scoped (e.g., agent is very broad while others are specific task types like math or coding), and there’s little explanation of how domains differ or how to choose the right one. This makes the configuration feel arbitrary and non-intuitive.
Steps/Code to reproduce bug

Please list minimal steps or code snippet for us to be able to reproduce the bug.

A helpful guide on on how to craft a minimal bug report http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports.

Expected behavior

The tutorial should clearly explain:
What domain is for (and what changes when it’s set)
How each domain differs at a practical level
Decision guidance (a short rubric / decision tree)

Examples for each domain (1–2 lines each)
Configs
NeMo Gym (e.g. via ng_dump_config) or RL training framework config files.

Environment details

Otherwise, please provide:

  • OS version
  • Python version
  • uv pip list output

Additional context

Add any other context about the problem here.
Example: GPU model

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked “Configure the Domain” section in the my_weather_tool resource server tutorial and inspect the domain configuration referenced by ng_dump_config. Document what domain controls, distinguish the available categories, add a short selection rubric or decision tree, and provide one or two examples for each domain.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.