Experiments#

Experiment Definition#

An Experiment in Dioptra is a logical container that defines the scope of workflows that can be executed. The Experiment declares which Entrypoints can be used to execute workflows within this scope. Users create and submit Jobs within an Experiment using one of its declared Entrypoints, and the Experiment serves as the container for those Jobs.

Experiment Attributes#

This section describes the attributes that define an Experiment.

Required Attributes#

  • Name: (string) The display name for the Experiment. Must be unique within the owning Group.

  • Group: (integer ID) The Group that owns this Experiment and controls access permissions.

Optional Attributes#

  • Description: (string, optional) A text description of the Experiment’s purpose or scope. Defaults to empty.

  • Entrypoints: (list of integer IDs, optional) A list of Entrypoint resources to associate with this Experiment. Jobs can only be created using Entrypoints that are associated with the Experiment.

System-Managed State#

The following attributes are automatically assigned by the system and cannot be set directly by the user.

  • ID: Unique identifier assigned upon creation.

  • Created On: Timestamp indicating when the Experiment was created.

  • Last Modified On: Timestamp indicating when the Experiment was last modified.

  • Jobs: List of Jobs that have been executed within this Experiment.

Registration Interfaces#

Experiments can be created programmatically via the Python Client or the REST API. They can also be created through the web interface.

Using Python Client#

Create an Experiment

ExperimentsCollectionClient.create(group_id: int, name: str, description: str | None = None, entrypoints: list[int] | None = None) → dioptra.client.experiments.T[source]#

Creates an experiment.

Parameters

  • group_id – The id of the group that will own the experiment.

  • name – The name of the new experiment.

  • description – The description of the new experiment. Optional, defaults to None.

  • entrypoints – A list of entrypoint ids to associate with the new experiment. Optional, defaults to None.

Returns

The response from the Dioptra API.

Using REST API#

Experiments can be created directly via the HTTP API.

Create Experiments

See the POST /api/v1/experiments endpoint documentation for payload requirements.

See Also#