Skip to content

Update ending.md #705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/workflow/ending/ending.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,26 @@ sidebar_label: Ending
slug: /ending
---

# Ending Your Experiment
# Ending Enrollment and Ending Experiment

## To end enrollment

Once the experiment has reached the end of the enrollment period, the experiment owner can elect to end enrollment which will prevent new clients from enrolling. To do this, first press the `End Enrollment` button located on the experiment's management page in [the Experimenter console](https://experimenter.services.mozilla.com). This will record the request. A reviewer with [L3 access](/access) *will then need to approve the request*. If your product team does not have a dedicated reviewer, you can request the ending by posting in [#ask-experimenter](https://mozilla.slack.com/archives/CF94YGE03).

<p align="center">
<img src="/img/workflow/end_enrollment.png"></img>
</p>

Some notes:
* Enrollments can be ended at any time after launch, not just after the proposed period
* If enrollment is ended before sufficient client volume has been achieved, there may not be enough users in the experiment to determine statistical significance.
* If enrollment is ended before sufficient client volume has been achieved, there may not be enough users in the experiment to determine statistical significance. Check the Live Monitoring link to see that you have enrolled the expected amount of people.
* By default, clients will continue to enrolled until enrollment is manually ended. If the experiment needs a different enrollment window than when it was ended, a [custom Jestream config](/deep-dives/jetstream/configuration) will need to be created. For assistance creating this, please file a Data Org JIRA ticket or attend the relevant [office hours](https://mozilla-hub.atlassian.net/wiki/spaces/DATA/pages/6849684/Office+Hours) for your experiment. An example of the relevant TOML is below. This will set the enrollment period to be the first 14 days of the experiment. Note that this will impact the observation window (data collection window between enrollment and the end of the experiment, from which the experiment results are calculated).

```toml
[experiment]
enrollment_period = 14
```

Once the experiment has reached the end of the enrollment period, the experiment owner can elect to end enrollment which will prevent new clients from enrolling. To do this, first press the `End Enrollment` button located on the experiment's management page in [the Experimenter console](https://experimenter.services.mozilla.com). This will record the request. A reviewer with [L3 access](/access) *will then need to approve the request*. If your product team does not have a dedicated reviewer, you can request the ending by posting in [#ask-experimenter](https://mozilla.slack.com/archives/CF94YGE03).

<p align="center">
<img src="/img/workflow/end_enrollment.png"></img>
</p>




## To end the experiment
Expand Down