Skip to content

docs: clarify resources server example-data contract and license validation #1560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ananthsub wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: clarify resources server example-data contract and license validation #1560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ac7daa
docs: clarify resources server example-data contract and license vali…
ananthsub Jun 10, 2026
83ff0f2
Merge branch 'main' into ananthsub/docs-resources-server-checks
lbliii Jun 16, 2026
aaafa31
Merge branch 'main' into ananthsub/docs-resources-server-checks
lbliii Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude/skills/add-benchmark/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Convert your source dataset to Gym JSONL format. Each line must have `responses_

**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.

@cmunley1 cmunley1 Jun 10, 2026

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.

is this the same as generated materialized_inputs files?


**`train`/`validation` datasets**: Upload to the GitLab dataset registry — these must NOT be committed to git.

Expand Down
3 changes: 1 addition & 2 deletions .claude/skills/add-benchmark/references/patterns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,8 +247,7 @@ my_benchmark_eval_agent:
### Key rules

- The `verified: false` flag is auto-added by pre-commit hook. Set to `true` after baselining.
- `license` is required for `train` and `validation` datasets.
- Valid license values: `Apache 2.0`, `MIT`, `CC-BY-4.0`, etc.
- `license` is required for `train` and `validation` datasets. It must be one of the values accepted by the dataset config schema (validated enum in `config_types.py`).
- `domain` should be one of: `coding`, `math`, `other`, or check `config_types.py` for current enum.
- Dataset `type` must be one of: `train`, `validation`, `example`.
- `gitlab_identifier` is required for `train`/`validation` datasets. `jsonl_fpath` is the local download path. Both fields coexist.
Expand Down
12 changes: 12 additions & 0 deletions fern/versions/latest/pages/data/prepare-validate.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,14 @@ ng_prepare_data "+config_paths=[resources_servers/example_multi_step/configs/exa
+mode=example_validation
```

<Info>
**Resources server example-data contract (PR submission).** A `resources_servers/<name>/` passes data validation when its `data/` directory contains `example.jsonl`, the `example_metrics.json` produced by `example_validation`, and `example_rollouts.jsonl`. Commit all three.
</Info>

<Warning>
`example.jsonl` must already be in materialized Responses format (each row containing `responses_create_params`). Example-type datasets are not templated via `prompt_config`, so raw rows won't validate.
</Warning>

### Training Preparation

```bash
Expand Down Expand Up @@ -378,6 +386,10 @@ datasets:
| `train` | Training data | RL training |
| `validation` | Evaluation during training | RL training |

### License values

`license` is required for `train` and `validation` datasets. It is validated against an allowed set defined in code — see the `license` enum in [`nemo_gym/config_types.py`](https://github.com/NVIDIA-NeMo/Gym/blob/main/nemo_gym/config_types.py).

---

## Next Steps
Expand Down
Loading