Skip to content

document output folder structure - #498

Open
anandhu-eng wants to merge 2 commits into
mainfrom
docs/output-folder-structure
Open

document output folder structure#498
anandhu-eng wants to merge 2 commits into
mainfrom
docs/output-folder-structure

Conversation

@anandhu-eng

Copy link
Copy Markdown
Contributor

Nothing so far explained what a benchmark run leaves behind in its report directory, so this adds a short guide.

It covers:

  • how to choose where the output goes
  • the files and folders a combined performance + accuracy run produces
  • extra files that some scorers write alongside them
  • the audit folder
  • which scripts read which files

The guide is linked from the README documentation table and from the CLI quick reference.

While writing it I also found a wrong note in the CLI quick reference: it said benchmark from-config cannot set the report directory from the command line. It can, so that note is corrected.

Documentation only — no code changes.

🤖 Generated with Claude Code

Add docs/OUTPUT_STRUCTURE.md describing what a run writes to its report
directory: where the directory comes from, the layout of a combined
perf + accuracy run, the scorer-specific and compliance-audit files that
can appear alongside it, and which tools read which artifact.

Link it from the README documentation table and from the CLI quick
reference, and correct the CLI quick reference note that said
`benchmark from-config` has no `--report-dir` override — it does.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@anandhu-eng
anandhu-eng requested a review from a team September 9, 2026 15:16
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

@github-actions github-actions Bot added the size/normal PR Review Policy: <=500 non-test lines & <=20 files label Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/normal PR Review Policy: <=500 non-test lines & <=20 files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant