Skip to content

Commit 2c12403

Browse files
Add guardrail cutoff to metric-sync API (#483)
1 parent 2a6dd46 commit 2c12403

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

docs/data-management/certified-metrics/eppo-schema.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Each certified metric yaml file can also define one or more metrics (either [sim
4343
| `metric_display_style` <br></br> (optional) | How to display the metric, either `decimal` or `percent` (default is `decimal`) | `decimal`|
4444
| `minimum_detectable_effect` <br></br> (optional)| The default [MDE](/statistics/sample-size-calculator/mde#what-is-a-minimum-detectable-effect-mde) for the metric | `0.02` |
4545
| `reference_url` <br></br> (optional)| An optional URL to link to in the Eppo UI | `github.com/.../<my_metric>` |
46+
| `guardrail_cutoff` <br></br> (optional)| A Guardrail cutoff value for a metric, as a decimal representing a percentage. If a metric is expected to increase, this value should be negative, to warn when the metric is decreasing by more than this value. If a metric is expected to decrease, this value should be positive, to warn when the metric is increasing by more than this value. | `-0.05` |
4647

4748
### Aggregations
4849

0 commit comments

Comments
 (0)