qxmt.experiment.schema module

qxmt.experiment.schema module#

class qxmt.experiment.schema.Evaluations(*, validation, test)

Bases: BaseModel

Parameters:

  • validation (dict[str, float] | None)

  • test (dict[str, float])

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

test: dict[str, float]
validation: dict[str, float] | None
class qxmt.experiment.schema.ExperimentDB(*, name, desc, working_dirc, experiment_dirc, runs)

Bases: BaseModel

Parameters:

  • name (str)

  • desc (str)

  • working_dirc (Path)

  • experiment_dirc (Path)

  • runs (list[RunRecord])

desc: str
experiment_dirc: Path
model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
runs: list[RunRecord]
working_dirc: Path
class qxmt.experiment.schema.RemoteMachine(*, provider, backend, job_ids)

Bases: BaseModel

Parameters:

  • provider (str)

  • backend (str)

  • job_ids (list[str])

backend: str
job_ids: list[str]
model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

provider: str
class qxmt.experiment.schema.RunArtifact(*, run_id, dataset, model)

Bases: BaseModel

Parameters:

  • run_id (int)

  • dataset (Dataset)

  • model (BaseMLModel)

dataset: Dataset
model: BaseMLModel
model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

run_id: int
class qxmt.experiment.schema.RunRecord(*, run_id, desc, remote_machine=None, commit_id, config_file_name, execution_time, runtime, evaluations)

Bases: BaseModel

Parameters:

  • run_id (int)

  • desc (str)

  • remote_machine (RemoteMachine | None)

  • commit_id (str)

  • config_file_name (Path)

  • execution_time (str)

  • runtime (RunTime)

  • evaluations (Evaluations)

commit_id: str
config_file_name: Path
desc: str
evaluations: Evaluations
execution_time: str
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

remote_machine: RemoteMachine | None
run_id: int
runtime: RunTime
class qxmt.experiment.schema.RunTime(*, train_seconds, validation_seconds, test_seconds)

Bases: BaseModel

Parameters:

  • train_seconds (float)

  • validation_seconds (float | None)

  • test_seconds (float)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

test_seconds: float
train_seconds: float
validation_seconds: float | None