expmember

expmember

Module for a base ExpMember

Classes

ExpMember dataclass

ExpMember class to describe and validate experiments

Functions

__lt__

__lt__(other)

ExpMembers without folders come first otherwise sort after name

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

def __lt__(self, other):
    """ExpMembers without folders come first
    otherwise sort after name"""
    own_paths = self.path.rsplit("/", maxsplit=1)
    other_paths = other.path.rsplit("/", maxsplit=1)
    if len(own_paths) < len(other_paths):
        return True
    if len(own_paths) > len(other_paths):
        return False
    return self.path < other.path

get_docstring

get_docstring()

Returns a docstring for an ExpMember

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

def get_docstring(self) -> str:
    """Returns a docstring for an ExpMember"""
    doc_str = f"**File:** ``{self.path}``\n\n"
    doc_str += f":type: {self.member_type}\n"
    doc_str += f":required: {self.required}\n"
    doc_str += f":description: {self.description}\n"
    return doc_str

validate

validate(exp_data)

validates the experiment given the ExperimentData

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

def validate(self, exp_data: ExperimentData) -> bool:
    """validates the experiment given the ExperimentData"""
    return self.path in exp_data.all_exp_files

FolderMember

FolderMember(
    path,
    required,
    description,
    min_required_files=0,
    extensions=None,
)

Bases: ExpMember

This member is a folder containing arbitrary files with specific extensions

Initialize a member that is a folder containing arbitrary files with specific extensions

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

def __init__(  # ruff: noqa: PLR0913
    self,
    path: str,
    required: bool,
    description: str,
    min_required_files: int = 0,
    extensions: Optional[List[str]] = None,
):
    """Initialize a member that is a folder containing arbitrary files
    with specific extensions"""

    super().__init__(
        path=path, required=required, description=description, member_type="folder"
    )
    self.min_required_files = min_required_files
    self.extensions = extensions

Functions

get_docstring

get_docstring()

The get_docstring function is used to generate the docstring for an instance of FolderMember. The function takes no arguments and returns a string containing the ReST formatted docstring.

Returns:

• str –

  A docstring for an instance of FolderMember

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

def get_docstring(self) -> str:
    """
    The get_docstring function is used to generate the docstring for an instance of
    `FolderMember`. The function takes no arguments and returns a string
    containing the ReST formatted docstring.

    Returns:
        A docstring for an instance of `FolderMember`
    """
    doc_str = super().get_docstring()
    doc_str += f":min_required_files: {self.min_required_files}\n"
    if self.extensions is not None:
        ext_str = ",".join(self.extensions)
        doc_str += f":extensions: {ext_str}"
    return doc_str

LogCsvMember

LogCsvMember()

Bases: ExpMember

Specific member of the experiment containing the train logs

Initialize a specific member of the experiment containing the train logs

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

def __init__(self):
    """Initialize a specific member of the experiment containing the train logs"""

    super().__init__(
        path=ExperimentFilenames.TRAIN_LOGS,
        required=True,
        description="This file contains all logs generated during the training",
        member_type="csv-file",
    )

Functions