neuraxle.metaopt.repositories.json

Module-level documentation for neuraxle.metaopt.repositories.json. Here is an inheritance diagram, including dependencies to other base modules of Neuraxle:

Neuraxle’s JSON Hyperparameter Repository Classes

Data objects and related repositories used by AutoML, SQL version.

Classes are splitted like this for the AutoML: - Projects - Clients - Rounds (runs) - Trials - TrialSplits - MetricResults

Classes

HyperparamsOnDiskRepository(cache_folder)

Hyperparams repository that saves json files for every AutoML trial.

Examples using neuraxle.metaopt.repositories.json.HyperparamsOnDiskRepository

Usage of AutoML loop, and hyperparams with sklearn models.

class neuraxle.metaopt.repositories.json._OnDiskRepositoryLoggerHandlerMixin(cache_folder: str)

Bases: object

Mixin to add a disk logging handler to a repository. It has a cache_folder.

__init__(cache_folder: str)

Initialize self. See help(type(self)) for accurate signature.

add_logging_handler(logger: neuraxle.logging.logging.NeuraxleLogger, scope: neuraxle.metaopt.data.vanilla.ScopedLocation) → neuraxle.metaopt.repositories.repo.HyperparamsRepository

Adds an on-disk logging handler to the repository. The file at this scope can be retrieved with the method get_scoped_logger_path().

get_log_from_logging_handler(logger: neuraxle.logging.logging.NeuraxleLogger, scope: neuraxle.metaopt.data.vanilla.ScopedLocation) → str

get_folder_at_scope(scope: neuraxle.metaopt.data.vanilla.ScopedLocation) → str

get_scoped_logger_path(scope: neuraxle.metaopt.data.vanilla.ScopedLocation) → str

class neuraxle.metaopt.repositories.json.HyperparamsOnDiskRepository(cache_folder: str = None)

Bases: neuraxle.metaopt.repositories.json._OnDiskRepositoryLoggerHandlerMixin, neuraxle.metaopt.repositories.repo.HyperparamsRepository

Hyperparams repository that saves json files for every AutoML trial.

See also

AutoML, Trainer,

__init__(cache_folder: str = None)

Initialize self. See help(type(self)) for accurate signature.

load(scope: neuraxle.metaopt.data.vanilla.ScopedLocation, deep=False) → SubDataclassT

Get metadata from scope.

The fetched metadata will be the one that is the last item that is not a None in the provided scope.

Parameters

scope (ScopedLocation) – scope to get metadata from.

Returns

metadata from scope.

save(_dataclass: SubDataclassT, scope: neuraxle.metaopt.data.vanilla.ScopedLocation, deep=False) → neuraxle.metaopt.repositories.repo.HyperparamsRepository

Save metadata to scope.

Parameters

• metadata – metadata to save.

• scope (ScopedLocation) – scope to save metadata to.

• deep (bool) – if True, save metadata’s sublocations recursively so as to update.

_load_dc(scope: neuraxle.metaopt.data.vanilla.ScopedLocation, deep=False) → SubDataclassT

_load_json_file(load_file: str)

_load_dc_sublocation_keys(_dataclass: SubDataclassT, scope: neuraxle.metaopt.data.vanilla.ScopedLocation) → SubDataclassT

_save_dc(_dataclass: SubDataclassT, scope: neuraxle.metaopt.data.vanilla.ScopedLocation, deep=False)

_get_dataclass_filename_path(scope: neuraxle.metaopt.data.vanilla.ScopedLocation, _dataclass: Optional[SubDataclassT] = None)

_patch_scope_for_dataclass(scope: neuraxle.metaopt.data.vanilla.ScopedLocation, _dataclass: Optional[neuraxle.metaopt.data.vanilla.BaseDataclass] = None)

_abc_impl = <_abc_data object>