docs: clarify resources server example-data contract and license validation - #1560
Open
ananthsub wants to merge 3 commits into
Open
docs: clarify resources server example-data contract and license validation#1560ananthsub wants to merge 3 commits into
ananthsub wants to merge 3 commits into
Conversation
…dation Document that a resources server's example data must include example.jsonl, example_metrics.json (from example_validation), and example_rollouts.jsonl, and that example.jsonl must be in materialized Responses format (example datasets are not templated via prompt_config). Generalize license guidance to point at the validated enum in config_types.py instead of an inline (and partly inaccurate) list. Signed-off-by: Ananth Subramaniam <ansubramania@nvidia.com>
cmunley1
reviewed
Jun 10, 2026
| **Data conversion**: Write conversion scripts in the **source repo** (e.g. your dataset repository), not in NeMo-Gym. Prompt files also belong in the source repo. Exception: when there is no external source repo. See `references/patterns.md` § "Data Conversion Script Pattern". | ||
|
|
||
| **`example.jsonl`**: Generate 5 entries for smoke testing. This file is committed directly to git in `data/example.jsonl`. | ||
| **`example.jsonl`**: Generate 5 entries for smoke testing, committed directly to git in `data/example.jsonl`. Each row must be in materialized Responses format (contain `responses_create_params`) — example datasets are not templated via `prompt_config`, so raw rows won't validate. |
Contributor
There was a problem hiding this comment.
is this the same as generated materialized_inputs files?
Contributor
|
🌿 Preview your docs: https://nvidia-preview-ananthsub-docs-resources-server-checks.docs.buildwithfern.com/nemo/gym Here are the markdown pages you've updated: |
github-actions
Bot
added
the
sla:review-overdue
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.
Follow up for #1559
Document that a resources server's example data must include example.jsonl, example_metrics.json (from example_validation), and example_rollouts.jsonl, and that example.jsonl must be in materialized Responses format.
Also generalize license guidance to point at the validated enum in config_types.py so docs are in sync with the code