Skip to content

docs: update content added in PR 1675 to match the new CLI syntax - #1741

Closed
marta-sd wants to merge 1 commit into
mainfrom
martas/1675-updated
Closed

marta-sd wants to merge 1 commit into
mainfrom
martas/1675-updated

Conversation

@marta-sd

Copy link
Copy Markdown
Contributor

No description provided.

Signed-off-by: Marta Stepniewska-Dziubinska <martas@nvidia.com>
@marta-sd
marta-sd requested a review from lbliii June 25, 2026 19:57
@marta-sd marta-sd self-assigned this Jun 25, 2026
@copy-pr-bot

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

@marta-sd

Copy link
Copy Markdown
Contributor Author

/ok to test 853f865

@github-actions

Copy link
Copy Markdown
Contributor

🌿 Preview your docs: https://nvidia-preview-martas-1675-updated.docs.buildwithfern.com/nemo/gym

Here are the markdown pages you've updated:

@sephmard sephmard linked an issue Jun 25, 2026 that may be closed by this pull request
@sephmard sephmard added the documentation Improvements to documentation label Jun 25, 2026
@sephmard
sephmard self-requested a review June 26, 2026 17:00

The most common sampling parameters have dedicated flags on `gym eval run`: `--temperature`, `--top-p`, and `--max-output-tokens`. These map onto `responses_create_params.temperature`, `.top_p`, and `.max_output_tokens` respectively.

Any other `responses_create_params` field that has no dedicated flag can be set with a raw Hydra override using the `++responses_create_params.<field>` syntax (see [Hydra overrides](#hydra-overrides-escape-hatch)). Overrides are merged into each input row's existing `responses_create_params` with a **shallow** merge (top-level keys only):

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.

This is important behavior but it's buried after the code block. A reader who copy-pastes the example first and reads the explanation second could silently lose nested fields. Worth promoting the warning above or adjacent to the example, not after it. A block here similar to the one in the Resume section would be consistent.

- **`gym dataset collate`** — the full preparation pipeline for training: it can download missing datasets, validate data, and compute dataset metrics, writing train/validation splits and metrics artifacts. Use it to prepare and validate datasets for training or PR submission.
</Note>


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.

Double blank line before --- at the end of the gym dataset render section (after the Note) — cosmetic, not a blocker.

@marta-sd

Copy link
Copy Markdown
Contributor Author

These changes have been incorporated into PR #1675

@marta-sd marta-sd closed this Jun 30, 2026
@marta-sd
marta-sd deleted the martas/1675-updated branch June 30, 2026 11:28

This branch was previously deployed

1 inactive deployment
public — 853f8650 Deployed Jun 25, 2026 by copy-pr-bot[bot] via release / finalize / notify #455
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.

[docs] Add and update docs for new CLI experience

2 participants