update_metric_group
Replace a metric group's name and evaluator set, optionally setting relative metric weights for future Composite scores.
Instructions
Replaces a Metric Group's name and Evaluator set, and optionally its Metric weights.
This is a full replace of name and Evaluators: send every Evaluator the group keeps, in order
(read them with list_metric_groups). Past runs are unaffected; each recorded the versions it
used, and a run's Composite keeps the weights it started with, so edits change only later runs.
Leave weights out to keep the stored weights of the Evaluators that stay (those of removed
Evaluators are dropped); send an empty list to clear them all, which removes the Composite.
weights say how much each Metric counts toward the group's Composite, as
{evaluator_id, metric_key, weight} entries. weight is a number above 0 and relative: weights
are divided by their sum, so 2, 1, 1 count as 50%, 25%, 25%. Each Evaluator must be in the group,
each metric_key must be one its newest version declares with a Normalized mean (a Score
with both range and better, or a Label with a scale), and no pair may repeat; otherwise
hub-api rejects the request. Without weights a group has no Composite. A stored weight with
usable false and an unusable_reason means a newer Evaluator version dropped the Metric or
its normalization: it is kept but no longer counts in new runs.
:param metric_group_id: The Metric Group's id.
:param name: The name to keep or change to.
:param evaluator_ids: Every Evaluator the group keeps, in order (at least one).
:param weights: Replaces the stored weights; None keeps them, [] clears them.
:returns: The Metric Group, or an error message.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| weights | No | ||
| evaluator_ids | Yes | ||
| metric_group_id | Yes |