Skip to content

docs: fill CLI reference gaps for data prep and rollout collection#1675

Merged
lbliii merged 6 commits into
mainfrom
lbliii/docs-cli-dco-fix
Jun 29, 2026
Merged

docs: fill CLI reference gaps for data prep and rollout collection#1675
lbliii merged 6 commits into
mainfrom
lbliii/docs-cli-dco-fix

Conversation

@lbliii

@lbliii lbliii commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Fills documented gaps in the CLI reference and installation pages. All CLI additions were verified against nemo_gym/prompt.py and nemo_gym/rollout_collection.py.

Review feedback addressed

  • Copilot review: clarified that responses_create_params overrides use a shallow merge (dict | overrides in _preprocess_rows_from_config), so nested Hydra overrides replace the entire nested dict rather than deep-merging fields.

Verification

  • npm run check (fern check) passes with 0 errors.

Note: Replaces #1498. That PR's branch (docs/cli-reference-cleanup) could not be rewritten due to branch protection (no force-push/delete); an unsigned commit (91526fce) left DCO failing. This PR uses a single signed commit on lbliii/docs-cli-dco-fix.

- ng_materialize_prompts: full parameter table, example, and note vs
  ng_prepare_data (closes #1347).
- resume_from_cache: params-table entries plus Resume Interrupted Runs
  section (closes #1239).
- Generation parameters: ++responses_create_params.<field> Hydra overrides
  with shallow-merge behavior documented (closes #637).
- PyPI-first installation tab in installation.mdx (closes #1191).
- Mirror CLI reference and installation changes into v0.3.0 stable docs.

Signed-off-by: Lawrence Lane <llane@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Jun 23, 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.

@lbliii lbliii changed the title DCO test docs: fill CLI reference gaps for data prep and rollout collection Jun 23, 2026
@lbliii lbliii marked this pull request as ready for review June 23, 2026 15:20
@github-actions

Copy link
Copy Markdown

@ananthsub ananthsub requested a review from marta-sd June 25, 2026 11:32
@marta-sd

Copy link
Copy Markdown
Contributor

@lbliii In the meantime I refactored CLI in PR #1630 and updated the docs, thus the conflicts. Here's the updated version of the content you prepared: #1741 Note that it should be used for latest / 0.4.0, but not for 0.3.0 (this is new CLI syntax, not available in 0.3.0)

Resolve cli-commands.mdx conflict by adopting main's gym CLI rewrite
and porting doc-gap content (resume interrupted runs, shallow-merge
Hydra note, dataset render vs collate guidance) into the new structure.

Signed-off-by: Lawrence Lane <llane@nvidia.com>
@sephmard sephmard self-requested a review June 29, 2026 13:38

@sephmard sephmard 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.

Good additions overall — the Resume Interrupted Runs section and the render vs. collate Note are both genuinely useful. Two things to resolve before merge: the latest/ Generation Parameters example still uses old ng_collect_rollouts syntax (tracked in #1741 — suggest absorbing those fixes here before merging), and the about shallow merge reads better adjacent to the gym eval run section rather than at the top of the page before the commands are introduced.

Comment on lines +17 to +18
pip install nemo-gym
```

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.

The PyPI tab shows pip install nemo-gym with no Python version constraint, then uv pip install nemo-gym with --python 3.12. The plain pip path could silently use the wrong Python version. Worth either adding a note ("requires Python 3.12") or showing pip with a version check first.

+wandb_project=gym-dev
```

<Tip>

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.

Nit: Generation Parameters Tip placement.

The about shallow merge is placed at the very top of the page in the quick-reference section (line 95 context), before any commands are defined. A reader scanning top-to-bottom hits this tip before they know what gym eval run or responses_create_params are. It reads better adjacent to the gym eval run section where it's acted on.

lbliii added 3 commits June 29, 2026 10:41
Signed-off-by: Lawrence Lane <llane@nvidia.com>
Signed-off-by: Lawrence Lane <llane@nvidia.com>
@lbliii lbliii requested a review from sephmard June 29, 2026 14:55
@lbliii

lbliii commented Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

Updated this PR to cover the remaining review feedback and absorb the relevant latest-doc content from #1741.

Summary:

  • Replaced bare PyPI pip install examples with Python 3.12-explicit commands in both main/latest and v0.3.0 installation docs.
  • Moved the shallow-merge guidance out of the early Hydra overview and into the gym eval run generation parameters section, next to the flags where readers use it.
  • Added the latest/main generation-parameters example using current gym eval run syntax: --temperature, --top-p, --max-output-tokens, plus raw ++responses_create_params... overrides.
  • Absorbed the remaining latest-only docs: update content added in PR 1675 to match the new CLI syntax #1741 data-prep update by moving gym dataset collate before gym dataset render and expanding the render contract around responses_create_params.input.
  • Left v0.3.0 on the release-appropriate CLI syntax, per the note that the new syntax is latest/0.4.0-only.

Validation:

  • npm run check passes locally with 0 errors.
  • PR checks are passing on head 1c66b32f; the remaining blocker is review approval.

@lbliii lbliii enabled auto-merge (squash) June 29, 2026 17:53
@lbliii lbliii merged commit 9df13ce into main Jun 29, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

3 participants