[danielkorzekwa]

What does this PR do?

https://nvidia.atlassian.net/browse/OMNIML-5940

Type of change: Documentation.

Give MMLU accuracy by subject its own section so it no longer appears to belong to Run evaluations. Move the configuration file descriptions into Run evaluations and remove the separate File structure section.

Usage

See examples/llm_qat/evaluation/README.md.

Testing

• Reviewed the complete diff; only README organization changes.
• git diff --check main...HEAD passed.

Summary by CodeRabbit

• Documentation
  • Updated evaluation instructions to identify the configuration entry point and shared settings.
  • Made the MMLU per-subject results table collapsible.
  • Removed the separate file structure section.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Repository: NVIDIA/Model-Optimizer/.coderabbit.yaml
• Review profile: CHILL
• Plan: Enterprise
• Run ID: 9e1711fd-ce31-48e4-a00f-8f491e29010c

📥 Commits

Reviewing files that changed from the base of the PR and between 40ca6c7 and bebadff.

📒 Files selected for processing: 1

• examples/llm_qat/evaluation/README.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

📝 Walkthrough

The evaluation README now describes nel_config.yaml and nel_configs/ under “Run evaluations.” It also changes the MMLU results disclosure label and removes the separate “File structure” section.

Changes: Evaluation README

Layer / File(s)	Summary
Evaluation configuration and results documentation examples/llm_qat/evaluation/README.md	The “Run evaluations” section identifies nel_config.yaml as the benchmark-recipe entry point and nel_configs/ as the location for shared Slurm and vLLM settings. The MMLU subject-results table remains collapsible under “Show per-subject results.” The separate “File structure” section is removed.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to bebad

This PR reorganizes the evaluation README without changing evaluation instructions or results. No material user or operational risk is identified.

Pre-merge checks: 6

Passed checks: 6 passed

Check name	Status	Explanation
Docstring Coverage		No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Security Anti-Patterns		The authoritative pull-request diff changes only examples/llm_qat/evaluation/README.md. It adds documentation headings and moves existing configuration descriptions. No Python, pyproject.toml, or …
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title accurately identifies the documentation change and the README structure being clarified.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.97%. Comparing base (39bf04e) to head (bebadff).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2799      +/-   ##
==========================================
- Coverage   71.97%   71.97%   -0.01%     
==========================================
  Files         648      648              
  Lines       71793    71793              
==========================================
- Hits        51676    51670       -6     
- Misses      20117    20123       +6     

Flag	Coverage Δ
unit	59.93% <ø> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions]

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-10-15 07:16 UTC