Add description field to `MetricConfig` #5459

anndvision · 2025-12-30T04:35:54Z

Adds an optional description field to MetricConfig, allowing users to document their metrics in the TOML config:

  [metrics.task_success]
  type = "boolean"
  optimize = "max"
  level = "inference"
  description = "Whether the task was completed successfully"

The field is optional and backward-compatible with existing configs.

Important

Adds an optional description field to MetricConfig for documenting metrics, ensuring backward compatibility.

Behavior:
- Adds optional description field to MetricConfig in MetricConfig.ts and mod.rs.
- Field is optional and backward-compatible with existing configurations.
Tests:
- Updates test cases in feedback.rs, feedback_queries.rs, and inference_count_queries.rs to include description field with None value.
Misc:
- No changes to existing functionality or logic.

^{This description was created by}^{for 4fa184f. You can customize this summary. It will automatically update as commits are pushed.}

add description field to MetricConfig

4fa184f

anndvision requested review from Aaron1011 and virajmehta December 30, 2025 04:35

Provide feedback