Configuration

class probnum._config.Configuration

Bases: object

Configuration by 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 Option	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.
matrix_free	False	If True, wherever possible, LinearOperators are used instead of arrays. LinearOperators define a matrix-vector product implicitly without instantiating the full matrix in memory. This makes them memory- and runtime-efficient for linear algebra operations.
lazy_matrix_matrix_matmul	True	If this is set to False, the matrix multiplication operator @ applied to two LinearOperators of type Matrix multiplies the two matrices immediately and returns the product as a Matrix. Otherwise, i.e. if this option is set to True, a ProductLinearOperator, representing the matrix product, is returned. Multiplying a vector with the ProductLinearOperator is often more efficient than computing the full matrix-matrix product first. This is why this option is set to True by default.

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)	Context manager used to set values of registered config options.
register(key, default_value, description)	Register a new configuration option.

Methods Documentation

__call__(**kwargs)

Context manager used to set values of registered config options.

Return type:

None

register(key, default_value, description)

Register a 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.

• description (str) – A short description of the configuration option and what it controls.

Raises:

KeyError – If the configuration option already exists.

Return type:

None