wei.types.experiment_types

Types related to experiments

pydantic model wei.types.experiment_types.Campaign

A campaign is a collection of related experiments

Show JSON schema

{
   "title": "Campaign",
   "description": "A campaign is a collection of related experiments",
   "type": "object",
   "properties": {
      "campaign_name": {
         "title": "Campaign Name",
         "type": "string"
      },
      "campaign_description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Campaign Description"
      },
      "campaign_id": {
         "title": "Campaign Id",
         "type": "string"
      },
      "experiment_ids": {
         "default": [],
         "items": {
            "type": "string"
         },
         "title": "Experiment Ids",
         "type": "array"
      }
   },
   "required": [
      "campaign_name"
   ]
}

Config:

use_enum_values: bool = True

Fields:

campaign_description (Optional[str])
campaign_id (str)
campaign_name (str)
experiment_ids (List[str])

Validators:

field campaign_description: str | None = None

Description of the campaign

Validated by:

validate_ulids

field campaign_id: str [Optional]

ID of the campaign

Validated by:

validate_ulids

field campaign_name: str [Required]

Name of the campaign

Validated by:

validate_ulids

field experiment_ids: List[str] = []

Experiments associated with the campaign

Validated by:

validate_ulids

pydantic model wei.types.experiment_types.CampaignDesign

Design of a campaign

Show JSON schema

{
   "title": "CampaignDesign",
   "description": "Design of a campaign",
   "type": "object",
   "properties": {
      "campaign_name": {
         "title": "Campaign Name",
         "type": "string"
      },
      "campaign_description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Campaign Description"
      }
   },
   "required": [
      "campaign_name"
   ]
}

Config:

use_enum_values: bool = True

Fields:

campaign_description (str | None)
campaign_name (str)

Validators:

field campaign_description: str | None = None

Description of the campaign

Validated by:

validate_ulids

field campaign_name: str [Required]

Name of the campaign

Validated by:

validate_ulids

pydantic model wei.types.experiment_types.Experiment

A single instance of an experiment

Show JSON schema

{
   "title": "Experiment",
   "description": "A single instance of an experiment",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "campaign_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Campaign Id"
      },
      "experiment_description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Experiment Description"
      },
      "email_addresses": {
         "default": [],
         "items": {
            "type": "string"
         },
         "title": "Email Addresses",
         "type": "array"
      },
      "experiment_id": {
         "title": "Experiment Id",
         "type": "string"
      },
      "experiment_directory": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Experiment Directory"
      },
      "check_in_timestamp": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Check In Timestamp"
      }
   },
   "required": [
      "name"
   ]
}

Config:

use_enum_values: bool = True

Fields:

campaign_id (Optional[str])
check_in_timestamp (datetime.datetime | None)
email_addresses (List[str])
experiment_description (Optional[str])
experiment_directory (str | pathlib.Path | None)
experiment_id (str)
experiment_name (str)

Validators:

field campaign_id: str | None = None

ID of the campaign this experiment should be associated with (note: this campaign must already exist)

Validated by:

validate_ulids

field check_in_timestamp: datetime | None = None

The last time the experiment client checked in

Validated by:

validate_ulids

field email_addresses: List[str] = []

List of email addresses to send notifications to

Validated by:

validate_ulids

field experiment_description: str | None = None

Description of the experiment

Validated by:

validate_ulids

field experiment_directory: str | Path | None = None

The directory where the experiment is stored on disk

Validated by:

validate_ulids

field experiment_id: str [Optional]

ID of the experiment

Validated by:

validate_ulids

field experiment_name: str [Required] (alias 'AliasChoices(choices=['name', 'experiment_name'])')

Name of the experiment

Validated by:

validate_ulids

pydantic model wei.types.experiment_types.ExperimentDesign

Design of an experiment

Show JSON schema

{
   "title": "ExperimentDesign",
   "description": "Design of an experiment",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "campaign_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Campaign Id"
      },
      "experiment_description": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Experiment Description"
      },
      "email_addresses": {
         "default": [],
         "items": {
            "type": "string"
         },
         "title": "Email Addresses",
         "type": "array"
      }
   },
   "required": [
      "name"
   ]
}