update_experiment
Renames an experiment or changes its candidate or baseline; preview required session reuse and replays before applying changes that cost money.
Instructions
Renames an Experiment or changes its candidate or baseline. Changing a side costs money.
Send only what changes. A changed side is planned again as on a new Experiment: Sessions that
already exist on it are reused, the rest are replayed, and it is judged again once they have
finished; its previous scoring run is stopped and the other side is left alone. Only renaming
costs nothing. Call it first with preview=True: that changes nothing and returns, for each
changed side, reused_sessions and replays_needed (a side left alone is null). Show that
to the user and get a yes before changing for real. Follow progress with get_experiment.
:param experiment_id: The Experiment's id.
:param name: A new name.
:param candidate_pipeline_name: Pipeline of the new candidate; give it with its version id.
:param candidate_pipeline_version_id: The new candidate version.
:param baseline_pipeline_name: Pipeline of the new baseline; give it with its version id.
:param baseline_pipeline_version_id: The new baseline version.
:param recorded_baseline: True makes the baseline the Dataset's recorded Sessions, with nothing replayed.
:param preview: True returns the plan and changes nothing.
:returns: The updated Experiment, or with preview the plan, or an error message.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| preview | No | ||
| experiment_id | Yes | ||
| recorded_baseline | No | ||
| baseline_pipeline_name | No | ||
| candidate_pipeline_name | No | ||
| baseline_pipeline_version_id | No | ||
| candidate_pipeline_version_id | No |