docs: source: union, clean config errors, and new discovery/validate CLI commands#1754
Open
wprazuch wants to merge 7 commits into
Open
docs: source: union, clean config errors, and new discovery/validate CLI commands#1754wprazuch wants to merge 7 commits into
wprazuch wants to merge 7 commits into
Conversation
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>
|
🌿 Preview your docs: https://nvidia-preview-wprazuch-docs-cli-config.docs.buildwithfern.com/nemo/gym Here are the markdown pages you've updated: |
… 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>
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
2 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.
Closes #1737.
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:Notes
gym env compose(feat(cli): config_composer for agent/dataset composition (RFC M3) #1673) is intentionally not documented here — that PR is still open.--jsonoutput keys were verified against the merged source rather than paraphrased.