yamlexpmember

yamlexpmember

Module for yaml exp members

Classes

ExpInfoMember

ExpInfoMember()

Bases: YamlMember

Specific member of the experiment containing the experiment info

Constructor of ExpInfoMember

Source code in niceml/experiments/schemas/yamlexpmember.py

def __init__(self):
    """Constructor of ExpInfoMember"""
    short_id_len = 4
    run_id_len = 24
    exp_schema = schema.Schema(
        {
            envc.EXP_NAME_KEY: str,
            envc.ENVIRONMENT_KEY: dict,
            envc.DESCRIPTION_KEY: str,
            envc.EXP_PREFIX_KEY: str,
            envc.SHORT_ID_KEY: lambda val: isinstance(val, str)
            and len(val) == short_id_len,
            envc.RUN_ID_KEY: lambda val: isinstance(val, str)
            and len(val) == run_id_len,
            envc.EXP_TYPE_KEY: str,
            envc.EXP_DIR_KEY: str,
            schema.Optional(envc.LAST_MODIFIED_KEY): str,
        }
    )
    super().__init__(
        path=ExperimentFilenames.EXP_INFO,
        required=True,
        description="This file contains experiment info like id, environment and runtime",
        yaml_schema=exp_schema,
    )

Functions

YamlMember

YamlMember(path, required, description, yaml_schema=None)

Bases: ExpMember

yaml-file which is member of the experiment

Constructor of YamlMember

Source code in niceml/experiments/schemas/yamlexpmember.py

def __init__(
    self,
    path: str,
    required: bool,
    description: str,
    yaml_schema: Optional[schema.Schema] = None,
):
    """Constructor of YamlMember"""
    super().__init__(
        path=path,
        required=required,
        description=description,
        member_type="yaml-file",
    )
    self.yaml_schema: Optional[schema.Schema] = yaml_schema

Functions

validate

validate(exp_data)

Validates the yaml file

Source code in niceml/experiments/schemas/yamlexpmember.py

def validate(self, exp_data: ExperimentData) -> bool:
    """Validates the yaml file"""
    result = super().validate(exp_data)
    val_data = exp_data.get_loaded_yaml(self.path)
    val_result = self._validate_schema(val_data)
    return result and val_result