postprocessor.core.processes.gpsignal.gpsignalParameters¶
- class postprocessor.core.processes.gpsignal.gpsignalParameters(**kwargs)¶
Bases:
ParametersABC- Parameters
- dtfloat
The time step between time points, in minutes
- norunsint
The number of times the optimisation is tried
- boundsdict
Hyperparameter bounds for the Matern Kernel
- verbosebool
Determines whether to print hyperparameter results
Methods
from_yaml(source)Returns instance from a yaml filename or stdin
to_dict([iterable])Recursive function to return a nested dictionary of the attributes of the class instance.
to_yaml([path])Returns a yaml stream of the attributes of the class instance.
update(name, new_value)Update values recursively if name is a dictionary, inject data where found.
default
from_dict
- __init__(**kwargs)¶
Defines parameters as attributes
Methods
__init__(**kwargs)Defines parameters as attributes
default(**kwargs)from_dict(d)from_yaml(source)Returns instance from a yaml filename or stdin
to_dict([iterable])Recursive function to return a nested dictionary of the attributes of the class instance.
to_yaml([path])Returns a yaml stream of the attributes of the class instance.
update(name, new_value)Update values recursively if name is a dictionary, inject data where found.
- classmethod from_yaml(source: Union[PosixPath, str])¶
Returns instance from a yaml filename or stdin
- to_dict(iterable='null')¶
Recursive function to return a nested dictionary of the attributes of the class instance.
- to_yaml(path: Optional[Union[PosixPath, str]] = None)¶
Returns a yaml stream of the attributes of the class instance. If path is provided, the yaml stream is saved there.
- Parameters
- pathUnion[PosixPath, str]
Output path.
- update(name: str, new_value)¶
Update values recursively if name is a dictionary, inject data where found. It forbids type changes.