Experiments

Update

PATCH
Update your experiment, including registering and de-registering model configs.

Path parameters

experiment_idstringRequired

String ID of experiment. Starts with exp_.

Request

This endpoint expects an object.
name
stringOptional
Name of experiment.
positive_labels
list of objectsOptional
Feedback labels to treat as positive user feedback. Used to monitor the performance of model configs in the experiment.
config_ids_to_register
list of stringsOptional
Model configs to add to this experiment.
config_ids_to_deregister
list of stringsOptional
Model configs in this experiment to be deactivated.

Response

This endpoint returns an object
id
string

String ID of experiment. Starts with exp_.

project_id
string

String ID of project the experiment belongs to. Starts with pr_.

name
string
Name of experiment.
status
enum
Status of experiment.
Allowed values: InitializedIn progress
metric
object
Metric used as the experiment's objective.
positive_labels
list of objects
Feedback labels to treat as positive user feedback. Used to monitor the performance of model configs in the experiment.
created_at
datetime
updated_at
datetime
configs
list of objectsOptional
List of configs associated to the experiment.

Errors