Skip to content

Add metrics conflict error FAQ to Readme #93

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

Merged
bxyu-nvidia merged 4 commits into from
Oct 8, 2025
Merged

Add metrics conflict error FAQ to Readme #93

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
36518ec
Add metrics conflict faq to readme
fsiino-nvidia Sep 24, 2025
b260662
Update error message
fsiino-nvidia Sep 25, 2025
3af9d15
Remove writeup from readme
fsiino-nvidia Sep 25, 2025
c7ffa94
Merge remote-tracking branch 'github/main' into fsiino/readme-faq-met…
fsiino-nvidia Sep 25, 2025
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
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
- [FAQ: NeMo Gym, training frameworks, and token IDs](#faq-nemo-gym-training-frameworks-and-token-ids)
- [FAQ: NeMo Gym what CI/CD do I need to pass?](#faq-nemo-gym-what-cicd-do-i-need-to-pass)
- [FAQ: Why aiohttp backend and not httpx/httpcore for async http?](#faq-why-aiohttp-backend-and-not-httpxhttpcore-for-async-http)
- [FAQ: ValueError: Found conflicting aggregate metrics that need to be corrected](#faq-valueerror-found-conflicting-aggregate-metrics-that-need-to-be-corrected)


# NeMo-Gym
Expand Down Expand Up @@ -975,3 +976,22 @@ Here are some Github issues related to this problem. They didn't help too much,
- https://github.com/encode/httpx/issues/3215#issuecomment-2220795088

If you are using AsyncOpenAI client with a parallelism > 32, you may also want to check if this kind of inefficiency also affects your setup.


# FAQ: ValueError: Found conflicting aggregate metrics that need to be corrected
Each environment requires a `example_metrics.json` to be provided, which includes the expected output when running `ng_prepare_data` with `+mode=example_validation`.

Should the schema for these metrics ever change, data preparation will be rerun and the updated `example_metrics.json` would be pushed to `main`. However, the metrics files for actual training (`+mode=train_preparation`) are **NOT** updated. If `ng_prepare_data` was already run previously, the outdated metrics files may still exist and you will get an aggregate metrics conflict error:
```bash
Traceback (most recent call last):
raise ValueError(f"Found conflicting aggregate metrics that need to be corrected:{conflicting_fpaths_str}")
ValueError: Found conflicting aggregate metrics that need to be corrected:
- path/to/metrics/train_metrics_conflict.json
- path/to/metrics/validation_metrics_conflict.json
```

If you run into the error above for any of the files listed, you will need to delete the necessary files (e.g. below) and rerun:
- `data/{resource_server_name}/train_metrics.json`
- `data/{resource_server_name}/validation_metrics.json`
- `resources_servers/{resource_server_name}/data/train_metrics.json`
- `resources_servers/{resource_server_name}/data/validation_metrics.json`