MetricChangeFilter - Weights & Biases Documentation

`class` `MetricChangeFilter`

Filter that compares a change in a metric value to a user-defined threshold. The change is calculated over “tumbling” windows, i.e. the difference between the current window and the non-overlapping prior window.

`method` `MetricChangeFilter.init`

__init__(
    name: 'str',
    agg: 'wandb.automations._filters.run_metrics.Agg | None' = None,
    window: 'int' = 1,
    cmp: 'None' = None,
    threshold: 'Annotated | Annotated',
    prior_window: 'int' = None,
    change_type: 'ChangeType',
    change_dir: 'ChangeDir'
) → None

Args:

name (str):
agg (wandb.automations._filters.run_metrics.Agg | None):
window (int):
cmp (None): Ignored.
threshold (Union[Annotated, Annotated]):
prior_window (int): Size of the “prior” metric aggregation window (ignored if agg is None). If omitted, defaults to the size of the current window.
change_type (ChangeType):
change_dir (ChangeDir):

Returns: An MetricChangeFilter object.

IncompleteRunHistoryError

MetricZScoreFilter

⌘I

​class MetricChangeFilter

​method MetricChangeFilter.__init__

`class` `MetricChangeFilter`

`method` `MetricChangeFilter.init`