Module: classifier_experiment
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 import Experiment
@dataclass(slots=True, kw_only=True)
class ClassifierExperiment(Experiment):
"""Run and analyze the results of multiple classification (category assignment) trials."""
Classes
class ClassifierExperiment (*, experiment_id: str = None)
-
Run and analyze the results of multiple classification (category assignment) trials.
Expand source code
@dataclass(slots=True, kw_only=True) class ClassifierExperiment(Experiment): """Run and analyze the results of multiple classification (category assignment) trials."""
Ancestors
- Experiment
- ExperimentKey
- KeyMixin
- RecordMixin
- abc.ABC
- typing.Generic
Static methods
def check_experiment_id(experiment_id: str) -> None
-
Inherited from:
Experiment
.check_experiment_id
Check that experiment_id does not have semicolon-and-space delimiter.
def get_key_type() -> Type
-
Inherited from:
Experiment
.get_key_type
Return key type even when called from a record.
Fields
var experiment_id -> str
-
Inherited from:
Experiment
.experiment_id
Unique experiment identifier.
Methods
def get_key(self) -> ExperimentKey
-
Inherited from:
Experiment
.get_key
Return a new key object whose fields populated from self, do not return self.
def init_all(self) -> None
-
Inherited from:
Experiment
.init_all
Invoke ‘init’ for each class in the order from base to derived, then validate against schema.