ts_ids_core.schema.run module

Model Run

Bases: IdsElement

A Run refers to a discrete period of time in which a performed process generates one or more data points for either a single or several related samples or generates a physical product. A Run typically refers to a particular execution of an instrument.

Show JSON schema

{
   "description": "A Run refers to a discrete period of time in which a performed process generates one or more data points for either a single or several related samples or generates a physical product. A Run typically refers to a particular execution of an instrument.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Unique identifier assigned to a specific run (execution) of an experiment.",
         "type": [
            "string",
            "null"
         ]
      },
      "name": {
         "description": "Name assigned to a specific run (execution) of an experiment.",
         "type": [
            "string",
            "null"
         ]
      },
      "logs": {
         "description": "Log messages recorded during a specific run (execution) of an experiment.",
         "items": {
            "type": "string"
         },
         "type": "array"
      }
   },
   "additionalProperties": false
}

Validators:

• all_abstract_fields_implemented » all fields

field id_: Nullable[str] (alias 'id')

Unique identifier assigned to a specific run (execution) of an experiment.

field logs: List[str]

Log messages recorded during a specific run (execution) of an experiment.

field name: Nullable[str]

Name assigned to a specific run (execution) of an experiment.

Model RunStatus

Bases: IdsElement

Status for a run.

Show JSON schema

{
   "description": "Status for a run.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Name of the status.",
         "type": "string"
      },
      "value": {
         "description": "Text-based status like 'completed', 'failed', 'aborted', 'error'.",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Validators:

• all_abstract_fields_implemented » all fields

field name: str

Name of the status.

field value: str

Text-based status like ‘completed’, ‘failed’, ‘aborted’, ‘error’.