ParametersDict

ParametersDict#

class ParametersDict(params=None, **kwargs)#

Bases: ParametersAbstract[CallbackDict[str, Any]]

Parameters stored in a dictionnary.

Parameters:
  • params (Mapping[str, Any] | None)

  • kwargs (Any)

get(key, default=None)#

Return a parameter value.

Parameters:
  • key (str) – Name of the parameter to retrieve.

  • default (Any) – Return this value if the parameters is not found.

Return type:

Any

reset()#

Reset parameters to their initial state (empty dict).

Return type:

None

set(key, value)#

Set a parameter to value.

Parameters:
Return type:

None

update(params=None, **kwargs)#

Update one or more parameters values.

Parameters:
  • params (Any | None) – Mapping of parameters to set.

  • kwargs (Any) – Other parameters to set (takes precedence over params).

Return type:

None