docs: source: union, clean config errors, and new discovery/validate CLI commands - #1754
Merged
Conversation
Contributor
|
🌿 Preview your docs: https://nvidia-preview-wprazuch-docs-cli-config.docs.buildwithfern.com/nemo/gym Here are the markdown pages you've updated: |
sephmard
self-requested a review
June 26, 2026 16:59
Document the config/CLI features merged for epic #1205: - gym list environments / gym list agents / gym env validate - config_paths startup errors + validate pre-flight tip - the unified dataset `source:` block (replaces gitlab_identifier/huggingface_identifier) Refs #1737 Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com>
… example Review fixes for the doc PR: - Remove the `python -m nemo_gym.dataset_source_migration` reference (that module ships in a still-open PR, not on main) - Migrate the second faq.mdx dataset example to `source:` (it still used the legacy identifiers, contradicting the surrounding prose) - Add a `source` row to the canonical dataset field table in reference/configuration.mdx - Complete the `gym env validate` flag table (resources-server, model-type, model/url/api-key) - Fix ServerRefNotFound prose to match the "Available <type>" message - "HuggingFace" -> "Hugging Face"; <Tip> trailing blank line Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com>
Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com>
Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com>
Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com>
…ot 'Available' The hint is either/or: get_close_matches (difflib, cutoff 0.6) returns a suggestion for a typo like typo_weather->weather, so the example fires the 'Did you mean:' branch. The 'Available <type>:' form only shows when no close match exists. Restore the correct example and describe both branches. Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com>
… reference The Domain enum (config_types.py:516) has 12 values; the docs listed only 10, omitting 'translation' and 'rlhf' (the latter is in active use, e.g. the abstention env). Update the Almost-Servers sample pydantic error and the canonical Domain values list in the configuration reference. Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com>
wprazuch
force-pushed
the
wprazuch/docs-cli-config
branch
from
June 29, 2026 07:31
c73f244 to
376be73
Compare
marta-sd
reviewed
Jun 29, 2026
| gym env validate # validate a config (no Ray, no servers) — fast pre-flight check | ||
| gym env packages # list packages in a server's virtual environment | ||
| gym env test # test resources server(s); all of them if none is given | ||
| gym env start # start the servers |
Contributor
There was a problem hiding this comment.
This is actually on me, but could you please fix the space between comment?
| nemo_gym.config_types.ConfigPathNotFoundError: config_paths entry 'resources_servers/weather/config.yaml' was not found. Looked in: | ||
| - /path/to/cwd/resources_servers/weather/config.yaml | ||
| - /path/to/gym/resources_servers/weather/config.yaml | ||
| Check the path is spelled correctly and is relative to your working directory or the Gym install root. |
Contributor
There was a problem hiding this comment.
Absolute path should work too (at least that was my intention)
…paths work - Fix comment alignment on the 'gym env start' quick-reference line (marta-sd) - Clarify in the Config Path Not Found fix that an absolute config_paths entry works too, not only repo-root-relative ones (verified: global_config.py only prefixes cwd/install root when the path is not absolute) (marta-sd) Signed-off-by: Wojciech Prazuch <wprazuch@nvidia.com>
marta-sd
approved these changes
Jun 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the config/CLI features merged for epic #1205 that were not yet reflected in the docs. Requested follow-up: a single doc PR covering the recently merged config/CLI work.
What's documented
reference/cli-commands.mdxgym list environments,gym list agents, andgym env validatesections (+ Quick-Reference entries)troubleshooting/configuration.mdxconfig_pathsstartup errors (Config Path Not Found, Malformedconfig_paths, No Server Instances) + agym env validatepre-flight tip; corrected the staleServerRefNotFoundmessagedata/index.mdxsource:block + dedicated "Datasetsource" subsection + legacy-deprecation notedata/download-huggingface.mdxsource: { type: huggingface }reference/faq.mdxsource:environment-tutorials/single-step-environment.mdxsource: