lenskit.state.ParameterContainer#

class lenskit.state.ParameterContainer(*args, **kwargs)#

Bases: Protocol

Protocol for components with learned parameters to enable saving, reloading, checkpointing, etc.

Components that learn parameters from training data should implement this protocol, and also work when pickled or pickled. Pickling is sometimes used for convenience, but parameter / state dictionaries allow serializing wtih tools like safetensors or zarr.

Initializing a component with the same configuration as a trained component, and loading its parameters with load_parameters(), should result in a component that is functionally equivalent to the original trained component.

Stability:

Experimental

__init__(*args, **kwargs)#

Methods

__init__(*args, **kwargs)

get_parameters()

Get the component's parameters.

load_parameters(state)

Reload model state from parameters saved via get_parameters().
get_parameters()#

Get the component’s parameters.

Returns:

The model’s parameters, as a dictionary from names to parameter data (usually arrays, tensors, etc.).

Return type:

Mapping[str, object]

load_parameters(state)#

Reload model state from parameters saved via get_parameters().

Parameters:

  • params – The model parameters, as a dictionary from names to parameter data (arrays, tensors, etc.), as returned from get_parameters().

  • state (Mapping[str, Any])

Return type:

None