Configuration

class probnum._config.Configuration

Bases: object

Configuration over which some mechanics of ProbNum can be controlled dynamically.

ProbNum provides some configurations together with default values. These are listed in the tables below. Additionally, users can register their own configuration entries via register(). Configuration entries can only be registered once and can only be used (accessed or overwritten) once they have been registered.

Config entry	Default value	Description
covariance_inversion_damping	1e-12	A (typically small) value that is per default added to the diagonal of covariance matrices in order to make inversion numerically stable.
...	...	…

Examples

>>> import probnum
>>> probnum.config.covariance_inversion_damping
1e-12
>>> with probnum.config(
...     covariance_inversion_damping=1e-2,
... ):
...     probnum.config.covariance_inversion_damping
0.01

Methods Summary

__call__(**kwargs)	Call self as a function.
register(key, default_value)	Register new configuration option.

Methods Documentation

__call__(**kwargs)

Call self as a function.

Return type

None

register(key, default_value)

Register new configuration option.

Parameters

• key (str) – The name of the configuration option. This will be the key when calling with config(key=<some_value>): ....

• default_value (Any) – The default value of the configuration option.

Return type

None