src.models.experiment module#

Data models for experiment related endpoints.

class src.models.experiment.ClonePackageModel(*, id: str, clone_name: Optional[str] = None)[source]#

Bases: BaseModel

Model for cloning a experiment. Currently unused.

_abc_impl = <_abc._abc_data object>#
clone_name: Optional[str]#
id: str#
class src.models.experiment.Connector(value)[source]#

Bases: str, Enum

Allowed connectors for experiments.

CLEARML = 'clearml'#
DEFAULT = ''#
_generate_next_value_(start, count, last_values)#

Generate the next value when not given.

name: the name of the member start: the initial start value or None count: the number of existing members last_value: the last value assigned or None

_member_map_ = {'CLEARML': Connector.CLEARML, 'DEFAULT': Connector.DEFAULT}#
_member_names_ = ['DEFAULT', 'CLEARML']#
_member_type_#

alias of str

_value2member_map_ = {'': Connector.DEFAULT, 'clearml': Connector.CLEARML}#
class src.models.experiment.ExperimentResponse(*, id: str, owner: str, name: str, project_name: str, output_url: Optional[str] = None, tags: List[str], frameworks: List[str], config: dict, scalars: Optional[List[dict]] = None, plots: Optional[List[dict]] = None, artifacts: Optional[Dict[str, Artifact]] = None)[source]#

Bases: BaseModel

Response model for getting an experiment.

_abc_impl = <_abc._abc_data object>#
artifacts: Optional[Dict[str, Artifact]]#
config: dict#
frameworks: List[str]#
id: str#
name: str#
output_url: Optional[str]#
owner: str#
plots: Optional[List[dict]]#
project_name: str#
scalars: Optional[List[dict]]#
tags: List[str]#
class src.models.experiment.LinkedExperiment(*, connector: Connector, experimentId: str, outputUrl: Optional[str] = '')[source]#

Bases: BaseModel

Linked experiment model from model creation/update process.

class Config[source]#

Bases: object

Pydantic config to allow creation of data model from a JSON object with camelCase keys.

allow_population_by_field_name = True#
_abc_impl = <_abc._abc_data object>#
connector: Connector#
experiment_id: str#
output_url: Optional[str]#