Skip to main content

​
class MetricChangeFilter

*,
name: str,
agg_op: wandb.automations._filters.run_metrics.Agg | None = None,
current_window_size: typing.Annotated[int, Gt(gt=0)] = 1,
cmp: NoneType = None,
change_amount: Union[Annotated[int, Gt(gt=0)], Annotated[float, Gt(gt=0)]],
prior_window_size: typing.Annotated[int, Gt(gt=0)] = <factory>,
change_type: wandb.automations._filters.run_metrics.ChangeType,
change_dir: wandb.automations._filters.run_metrics.ChangeDir

​
Description

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.

​
Args

  • name:
  • agg_op:
  • current_window_size:
  • cmp: Ignored.
  • change_amount:
  • prior_window_size: Size of the “prior” metric aggregation window (ignored if agg is None).
If omitted, defaults to the size of the current window.
  • change_type:
  • change_dir: