Evaluation
Score generated artifacts with benchmarks, metrics, and reproducible scorecards.
Evaluation turns model outputs into reviewable evidence: prepare inputs, generate or import results, score them, and write a scorecard. Model launch details stay in runners; benchmarks consume normalized GenerationResult rows. Scoring and leaderboard claims are separate — a successful framework import is not the same as an official leaderboard run.
For a first end-to-end path, use Usage. For flags and discovery commands, see CLI. For per-benchmark layouts, see Benchmark Hub. For metric recipes, see Metrics.
What to run
| Goal | Command |
|---|---|
| Score existing JSON/JSONL results | worldfoundry-eval evaluate --mode existing-results ... |
| Build a request ledger from a task | worldfoundry-eval task materialize ... |
| Run one benchmark × model | worldfoundry-eval run --benchmark <id> --model <id> ... |
| Import official-shaped results | worldfoundry-eval zoo benchmark-run --mode official-validation ... |
| List metric ids | worldfoundry-eval metric list |
Default user shape is worldfoundry-eval run. Use evaluate when you already have materialized requests or results. Use zoo benchmark-run for integrated external benchmarks where you supply the data root, generated artifacts, or official result files.
Pipeline
- Resolve mode, output directory, model/benchmark metadata, metrics, and optional runtime profile.
- Normalize inputs into
GenerationRequestrows (task YAML, dataset manifest, JSON/JSONL, or benchmark samples). - Produce
GenerationResultrows via aWorldModelRunneror by importing existing results. - Score metrics against those rows.
- Write the audit trail: run manifest, ledgers, metric summaries,
report.md, andscorecard.json.
Common commands
# Materialize a small request ledger
worldfoundry-eval task materialize <task-name> \
--benchmark <benchmark-id> \
--dataset-manifest /path/to/dataset_manifest.json \
--num-samples 8 \
--output-jsonl tmp/requests.jsonl \
--json
# Score existing results
worldfoundry-eval evaluate \
--mode existing-results \
--results-path tmp/results.jsonl \
--output-dir tmp/evaluate_existing \
--benchmark-id <benchmark-id> \
--model-id <model-id> \
--metric artifact_count \
--json
# Run one benchmark cell
worldfoundry-eval run \
--benchmark <benchmark-id> \
--model <model-id> \
--output-dir tmp/benchmark_run \
--mode official-run \
--json
# Import official-shaped results (framework evidence, not a leaderboard claim)
worldfoundry-eval zoo benchmark-run \
--benchmark-id <benchmark-id> \
--mode official-validation \
--official-results-path <official_results.json> \
--generated-artifact-dir <generated_artifacts> \
--output-dir tmp/benchmark_zoo/official_validation/<benchmark-id> \
--jsonBenchmark-specific layouts and flags belong on each Benchmark Hub page.
Outputs
| Artifact | Read it for |
|---|---|
report.md | Human-readable first look |
scorecard.json | Normalized scores and leaderboard eligibility |
metrics/summary.json | Aggregate metrics for automation |
results.jsonl | Per-sample status, artifacts, errors |
run_manifest.json | Run identity, paths, fingerprint |
Modes
| Mode | Behavior |
|---|---|
existing-results | Score materialized results; no model inference |
model / generate | Run a model runner, then score |
official-validation | Import official-shaped results through the benchmark runner |
official-run | Run the benchmark runtime declared by the manifest |
Use official-validation for framework import evidence. Use official-run only after datasets, checkpoints, environment, and official evaluator requirements are satisfied.
Contracts (short)
| Object | Role |
|---|---|
GenerationRequest | Normalized sample input |
WorldModelRunner | Executes generation → GenerationResult |
GenerationResult | Per-sample output + artifacts |
Metric | Turns results into score rows |
scorecard | Final eligibility / comparison record |
Subsystem ownership and data flow: Evaluation core. Flag reference: CLI.
Next
- Benchmark Hub — per-benchmark setup and run notes
- Metrics — in-tree scorers and compute APIs
- Supported models — catalog status
- Embodied official runtime — Docker / simulator path