> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-sdk-add-methods-properties.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# MetricZScoreFilter

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "View source" : <>
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    GitHub source
      </>}
  </a>;

<GitHubLink compact url="https://github.com/wandb/wandb/blob/main/wandb/automations/_filters/run_metrics.py#L202" />

## <Badge color="yellow" size="lg" shape="rounded">Class</Badge> wandb.automations.MetricZScoreFilter

Filter that compares a metric's z-score against a user-defined threshold.

```python theme={null}
*,
name: str,
window_size: Annotated[int, Gt(gt=0)] = 30,
threshold: Union[Annotated[int, Gt(gt=0)], Annotated[float, Gt(gt=0)]] = 3.0,
change_dir: wandb.automations._filters.run_metrics.ChangeDir = ANY
```

## Args

<ResponseField name="name" type="str">
  Name of the observed metric.
</ResponseField>

<ResponseField name="window_size" type="Annotated[int, Gt(gt=0)]">
  Size of the window to calculate the metric mean and standard deviation over.
</ResponseField>

<ResponseField name="threshold" type="Union[Annotated[int, Gt(gt=0)], Annotated[float, Gt(gt=0)]]">
  Threshold for the z-score.
</ResponseField>

<ResponseField name="change_dir" type="wandb.automations._filters.run_metrics.ChangeDir">
  Direction of the z-score change to watch for.
</ResponseField>