Skip to main content
Each research branch declares a primary metric. In normal agent-first usage, the Onyx agent chooses the first version from your /onyx prompt and records it in onyx/onyx.md.

Metric Fields

FieldMeaning
NameThe metric key emitted by onyx/eval.sh.
UnitOptional display unit, such as ms, points, or percent.
Directionmaximize or minimize.
Example:
/onyx Reduce controller latency, minimize latency_ms in milliseconds
If the inferred metric is wrong, edit onyx/onyx.md and tell the agent to continue with the updated guidance.

Metric Output

METRIC latency_ms=14.2
METRIC memory_mb=128
The primary metric must match the branch metric. Other metrics are useful context but do not define best-so-far.

Status and Best Results

Common statuses:
  • succeeded: eval passed and the metric was parsed.
  • failed: eval failed or did not emit the primary metric.
  • checks_failed: eval passed, but optional checks failed.
  • accepted or rejected: manually classified outcomes.
Best-so-far should only build from valid results that satisfy the branch goal and correctness constraints.