wei.types.datapoint_types

Types related to datapoint types

pydantic model wei.types.datapoint_types.DataPoint

An object to contain and locate data identified by modules

Show JSON schema

{
   "title": "DataPoint",
   "description": "An object to contain and locate data identified by modules",
   "type": "object",
   "properties": {
      "label": {
         "title": "Label",
         "type": "string"
      },
      "step_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Step Id"
      },
      "workflow_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Workflow Id"
      },
      "experiment_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Experiment Id"
      },
      "campaign_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Campaign Id"
      },
      "type": {
         "title": "Type",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      }
   },
   "additionalProperties": true,
   "required": [
      "label",
      "type"
   ]
}

Config:

use_enum_values: bool = True
extra: str = allow

Fields:

campaign_id (str | None)
experiment_id (str | None)
id (str)
label (str)
step_id (str | None)
type (str)
workflow_id (str | None)

Validators:

field campaign_id: str | None = None

campaign of the data point

Validated by:

validate_ulids

field experiment_id: str | None = None

experiment that generated the data point

Validated by:

validate_ulids

field id: str [Optional]

specific id for this data point

Validated by:

validate_ulids

field label: str [Required]

label of this data point

Validated by:

validate_ulids

field step_id: str | None = None

step that generated the data point

Validated by:

validate_ulids

field type: str [Required]

type of the datapoint, inherited from class

Validated by:

validate_ulids

field workflow_id: str | None = None

workflow that generated the data point

Validated by:

validate_ulids

pydantic model wei.types.datapoint_types.LocalFileDataPoint

a datapoint containing a file

Show JSON schema

{
   "title": "LocalFileDataPoint",
   "description": "a datapoint containing a file",
   "type": "object",
   "properties": {
      "label": {
         "title": "Label",
         "type": "string"
      },
      "step_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Step Id"
      },
      "workflow_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Workflow Id"
      },
      "experiment_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Experiment Id"
      },
      "campaign_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Campaign Id"
      },
      "type": {
         "const": "local_file",
         "default": "local_file",
         "enum": [
            "local_file"
         ],
         "title": "Type",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "path": {
         "title": "Path",
         "type": "string"
      }
   },
   "additionalProperties": true,
   "required": [
      "label",
      "path"
   ]
}

Config:

use_enum_values: bool = True
extra: str = allow

Fields:

path (str)
type (Literal['local_file'])

Validators:

field path: str [Required]

path to the file

Validated by:

validate_ulids

field type: Literal['local_file'] = 'local_file'

local file

Validated by:

validate_ulids

pydantic model wei.types.datapoint_types.ValueDataPoint

a datapoint contained in the Json value

Show JSON schema

{
   "title": "ValueDataPoint",
   "description": "a datapoint contained in the Json value",
   "type": "object",
   "properties": {
      "label": {
         "title": "Label",
         "type": "string"
      },
      "step_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Step Id"
      },
      "workflow_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Workflow Id"
      },
      "experiment_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Experiment Id"
      },
      "campaign_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Campaign Id"
      },
      "type": {
         "const": "data_value",
         "default": "data_value",
         "enum": [
            "data_value"
         ],
         "title": "Type",
         "type": "string"
      },
      "id": {
         "title": "Id",
         "type": "string"
      },
      "value": {
         "title": "Value"
      }
   },
   "additionalProperties": true,
   "required": [
      "label",
      "value"
   ]
}

Config:

use_enum_values: bool = True
extra: str = allow

Fields:

type (Literal['data_value'])
value (Any)

Validators:

field type: Literal['data_value'] = 'data_value'

data_value

Validated by:

validate_ulids

field value: Any [Required]

value of the data point

Validated by:

validate_ulids