Skip to content

Commit 64c0acb

Browse files
authored
docs: Add recommended decisions documentation for experiment configuration (#594)
* docs: Add recommended decisions documentation for experiment configuration * docs: Update Metric Properties documentation with configuration details * Restore propertysql page * docs: Update internal links for Metric Properties and Explores documentation
1 parent 1f97d88 commit 64c0acb

File tree

12 files changed

+81
-4
lines changed

12 files changed

+81
-4
lines changed
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Metric Property Cardinality Limit
2+
3+
You can minimize warehouse costs by limiting the number of computed values for all metric properties. Applying a limit here will cap the number of values computed for Explores and Property Analysis on experiments.
4+
5+
The cardinality limit will limit computation to the top most frequently occurring values per property.
6+
7+
You can configure the cardinality limit by clicking on the Metric Property Cardinality Limit tile in Admin.
8+
9+
![Settings to add metric properties to a Protocol](/img/administration/property-cardinality-tile.png)
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Recommended Decision Defaults
2+
3+
The decision criteria aligns the team around a ship decision based on the measurement of the primary and [guardrail](/data-management/organizing-metrics/guardrails) metrics set in experiments. This recommendation will appear on the experiment when the experiment end date is reached or if the primary or guardrail metrics have achieved an outcome that is statistically significant.
4+
5+
The default decisions for Standard and Non-Inferiority tests can be set it the Admin menu by clicking on the `Recommended Decisions` tile in Admin.
6+
7+
![The Recommended Decision tile in Admin](/img/administration/recommended-decision-tile.png)
8+
9+
:::note
10+
The recommended decision defaults can be overwritten based on the Experiment Protocol selected or edited with individual experiments.
11+
:::
12+
13+
## Recommended Decision options
14+
15+
Recommended decisions include:
16+
* Roll out winning variant - Ship the variant that performed the best compared to the control
17+
* Extend run time - Continue running the experiment to reach more precision
18+
* Discuss with stakeholders - Discuss the results with stakeholders to determine the best course of action
19+
* Do not roll out - Roll back to the control and turn off the treatment variant(s)
20+
21+
## Standard Experiment Default Recommended Decisions
22+
23+
In this first step, you can define the recommended decisions for all possible experiment outcomes when using a Sequential confidence interval method.
24+
25+
If the confidence interval method for an experiment is set to Fixed Sample or Sequential Hybrid, any default recommendation set to ‘Extend Run Time’ will automatically change to ‘Discuss with Stakeholders.’ This is because these methods require a fixed run time to be determined before the experiment begins.
26+
27+
![The Standard Experiment Recommended Decision page](/img/administration/standard-default-decision.png)
28+
29+
## Non-Inferiority Experiment Default Recommended Decisions
30+
31+
A non-inferiority test is used to determine whether a new treatment is not significantly worse than an existing one, within a predefined acceptable cutoff. In this context, the primary and guardrail metrics should remain within the acceptable risk threshold defined by this cutoff.
32+
33+
For Non-Inferiority tests, define the recommended decisions for all possible experiment outcomes when using a Sequential confidence interval method defined in the Statistical Analysis Plan.
34+
35+
If the confidence interval method for an experiment is set to Fixed Sample or Sequential Hybrid, any default recommendation set to ‘Extend Run Time’ will automatically change to ‘Discuss with Stakeholders.’ This is because these methods require a fixed run time to be determined before the experiment begins.
36+
37+
![The Non-Inferiority Experiment Recommended Decision page](/img/administration/non-inferiority-default-decision.png)
38+
39+
40+
41+
42+

docs/data-management/definitions/properties.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,13 @@ Metric Properties can be used to refine Metrics or split experiment metrics when
7070

7171
![Configuring a Fact SQL](/img/properties/metric-property-fact-sql.png)
7272

73-
Add a Metric property to any of your existing Facts or by creating a new one.
73+
Add a Metric Property to any of your existing FactSQLs or by creating a new one. A Metric Property only needs to be configured once and is able to be re-used many times for any Metrics created.
7474

75-
This only needs to be configured once and re-use many times for any Metrics created.
75+
By default, Metric Properties will not be included in experiment computation to reduce experiment run time. This means that they are not available for analysis in [Explores](/experiment-analysis/deep-dive/explores) and [Property Analysis](/experiment-analysis/deep-dive/property_analysis) for a given experiment.
76+
77+
This can be changed by toggling the Metric Property to enabled, which will make it available in all experiments. However, it is recommended instead that you set Metric Properties to be available for experiment analysis by choosing to include them in Protocols settings and in individual experiment settings.
78+
79+
![Metric property with toggle to include in experiment computation](/img/properties/metric-property-toggle.png)
7680

7781
### Configure a Metric with a property filter
7882

docs/data-management/definitions/property-sql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ To create an Entity Property SQL follow the steps below:
3030

3131
![Write SQL Properties](/img/building-experiments/dimension-sql-query.png)
3232

33-
Once you're finished adding mapping columns into Eppo, click **Save & Close**.
33+
Once you're finished adding mapping columns into Eppo, click **Save & Close**.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Experiment Advanced Settings
2+
3+
Advanced Settings lets you choose which Metric Properties to include in your experiment analysis. To access these settings, click the edit icon in the top right corner of your experiment.
4+
5+
Any Metric Properties you choose to include will make them available for analysis in [Explores](/deep-dive/explores) and [Property Analysis](/deep-dive/property_analysis).
6+
7+
:::note
8+
Metric Properties will be available after the next experiment refresh
9+
:::
10+
11+
To select which Metric Properties to make available, toggle `Use the company defaults` to off and select which Properties you want to include from the drop-down.
12+
13+
![Settings to add metric properties to a Protocol](/img/experiments/protocols/protocol-advanced-settings.png)
14+

docs/experiment-analysis/configuration/protocols.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Specifying a Primary Metric is required. This is the metric that your experiment
3636

3737
You are also able to specify optional [guardrail metrics](/data-management/organizing-metrics/guardrails). Guardrail metrics provide a level of governance and are primarily useful to track metrics that an experiment is not supposed to positively impact, but you want to ensure that there is no negative effect either. Guardrail metrics can use any cutoff bounds previously set or can have custom cutoffs set for the Protocol.
3838

39-
After the metrics are set, you can then specify the recommended decision based on metric outcomes. This recommendation will appear on the experiment when the experiment end date is reached or if the primary or guardrail metrics have achieved an outcome that is statisically significant.
39+
After the metrics are set, you can then specify the recommended decision based on metric outcomes. This recommendation will appear on the experiment when the experiment end date is reached or if the primary or guardrail metrics have achieved an outcome that is statistically significant.
4040

4141
![Protocol decision criteria screen](/img/experiments/protocols/protocol-decision-criteria.png)
4242

@@ -80,3 +80,11 @@ A recommendation will display when:
8080
* The Guardrail metrics are statistically significant positive or negative, or the guardrail cutoff threshold is breached
8181

8282
The decision made can be recorded by clicking the `Make Decision` button. Note that the recommended decision does not have to followed, but we suggest adding notes as to why the team decided to deviate from the Protocol.
83+
84+
## Advanced settings
85+
86+
If your Primary or Guardrail metrics have metric properties, you can choose which Metric Properties to include in the experiment. This means that they will be available for analysis in [Explores](/experiment-analysis/deep-dive/explores) and [Property Analysis](/experiment-analysis/deep-dive/property_analysis) in all Experiments that use this Protocol.
87+
88+
To select which Metric Properties to make available, toggle `Use the company defaults` to off and select which Properties you want to include from the drop-down.
89+
90+
![Settings to add metric properties to a Protocol](/img/experiments/protocols/protocol-advanced-settings.png)
312 KB
Loading
72.3 KB
Loading
62.3 KB
Loading
457 KB
Loading

0 commit comments

Comments
 (0)