dacapo.experiments.datasplits.datasets.dataset_config

Module Contents

Classes

DatasetConfig

A class used to define configuration for datasets. This provides the

class dacapo.experiments.datasplits.datasets.dataset_config.DatasetConfig

A class used to define configuration for datasets. This provides the framework to create a Dataset instance.

name

str (eg: “sample_dataset”). A unique identifier to name the dataset. It aids in easy identification and reusability of this dataset. Advised to keep it short and refrain from using special characters.

weight

int (default=1). A numeric value that indicates how frequently this dataset should be sampled in comparison to others. Higher the weight, more frequently it gets sampled.

verify()

Checks and validates the dataset configuration. The specific rules for validation need to be defined by the user.

name: str
weight: int
verify() Tuple[bool, str]

Method to verify the dataset configuration.

Since there is no specific validation logic defined for this DataSet, this method will always return True as default reaction and a message stating the lack of validation.

Returns:

A tuple of boolean value indicating the check (True or False) and message specifying result of validation.

Return type:

tuple