simulation.utils.machine_learning.basics package

Submodules

simulation.utils.machine_learning.basics.init_options module

Classes:

InitOptions()

class InitOptions

Bases: object

Methods:

from_dict(**kwargs)	Create instance from relevant keywords in dictionary.
_from_yaml(file_path, loader)	Helper method to allow passing a custom cls instead of being forced to use the classmethod syntax.
from_yaml(file_path, loader)	Load instance from a yaml file.

classmethod from_dict(**kwargs: dict[str, Any])

Create instance from relevant keywords in dictionary.

Instead of passing exactly the arguments defined by the class’ __init__, this allows to pass a dictionary of many more values and the function will then only pass the correct arguments to the class’ __init__.

Example

>>> from simulation.utils.machine_learning.basics.init_options import InitOptions
>>> class SomeClass(InitOptions):
...
...     def __init__(self, arg1, arg2):
...         self.arg1 = arg1
...         self.arg2 = arg2
...
...
>>> many_args = {"arg1": 1, "arg2": 2, "arg3": 3}
... # This will raise an exception because __init__ does not expect arg3!
>>> try:
...     SomeClass(**many_args)
... except TypeError:
...     pass
... # However this will work:
>>> something = SomeClass.from_dict(**many_args)

Parameters:

**kwargs – Keyword arguments matching the constructor’s variables.

_from_yaml(file_path: str, loader: Loader = <class 'yaml.loader.SafeLoader'>)

Helper method to allow passing a custom cls instead of being forced to use the classmethod syntax.

classmethod from_yaml(file_path: str, loader: Loader = <class 'yaml.loader.SafeLoader'>)

Load instance from a yaml file.

Only fields that are defined within the __init__ are loaded.

Parameters:

file_path – Location of the yaml file.

simulation.utils.machine_learning.basics.save_options module

Classes:

SaveOptions()

class SaveOptions

Bases: object

Methods:

save_as_yaml(file_path, custom_dict, ...[, ...])

Save to file as yaml.

save_as_yaml(file_path: str, custom_dict: dict[str, ~typing.Any]=None, dumper=<class 'yaml.dumper.SafeDumper'>)

Save to file as yaml.

This dumps the complete class dict to a yaml file.

Parameters:

file_path – Path to file.

Module contents