Module: trial

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from dataclasses import dataclass
from cl.runtime.experiments.experiment_key import ExperimentKey
from cl.runtime.experiments.trial_key import TrialKey
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.records.record_mixin import RecordMixin


@dataclass(slots=True, kw_only=True)
class Trial(TrialKey, RecordMixin[TrialKey]):
    """Run and store the result of a single trial for the specified experiment."""

    experiment: ExperimentKey = missing()
    """Experiment for which the trial is performed."""

    trial_label: str = missing()
    """Identifier of the trial is unique within the experiment."""

    def get_key(self) -> TrialKey:
        return TrialKey(trial_id=self.trial_id)

    def init(self) -> None:
        """Generate trial_id in 'ExperimentId: TrialLabel' format."""
        self.trial_id = self.get_trial_id(self.experiment, self.trial_label)

Classes

class Trial (*, trial_id: str = None, experiment: ExperimentKey = None, trial_label: str = None)

Run and store the result of a single trial for the specified experiment.

Expand source code

@dataclass(slots=True, kw_only=True)
class Trial(TrialKey, RecordMixin[TrialKey]):
    """Run and store the result of a single trial for the specified experiment."""

    experiment: ExperimentKey = missing()
    """Experiment for which the trial is performed."""

    trial_label: str = missing()
    """Identifier of the trial is unique within the experiment."""

    def get_key(self) -> TrialKey:
        return TrialKey(trial_id=self.trial_id)

    def init(self) -> None:
        """Generate trial_id in 'ExperimentId: TrialLabel' format."""
        self.trial_id = self.get_trial_id(self.experiment, self.trial_label)

Ancestors

TrialKey
KeyMixin
abc.ABC
RecordMixin
typing.Generic

Subclasses

Static methods

def check_trial_id(trial_id: str) -> None: Inherited from: TrialKey.check_trial_id

Check that trial_id has the expected ‘ExperimentId: TrialLabel’ format.
def get_key_type() -> Type: Inherited from: TrialKey.get_key_type

Return key type even when called from a record.
def get_trial_id(experiment: ExperimentKey, trial_label: str) -> str: Inherited from: TrialKey.get_trial_id

Generate trial_id in ‘ExperimentId: TrialLabel’ format.

Fields

var experiment -> ExperimentKey: Experiment for which the trial is performed.
var trial_id -> str: Inherited from: TrialKey.trial_id

Unique identifier of the trial using ‘ExperimentId: TrialLabel’ format.
var trial_label -> str: Identifier of the trial is unique within the experiment.

Methods

def get_key(self) -> TrialKey: Inherited from: RecordMixin.get_key

Return a new key object whose fields populated from self, do not return self.
def init(self) -> None: Generate trial_id in ‘ExperimentId: TrialLabel’ format.
def init_all(self) -> None: Inherited from: RecordMixin.init_all

Invoke ‘init’ for each class in the order from base to derived, then validate against schema.