lenskit.schemas.pipeline

Pydantic models for pipeline configuration and serialization support.

Attributes

UNSET_CODE

Classes

PipelineHook	A single entry in a pipeline's hook configuration.
PipelineHooks	Hook specifications for a pipeline.
PipelineOptions	Options used for pipeline assembly, particularly for extending pipelines.
PipelineConfigFragment	Configuration fragments that override base configurations.
PipelineConfig	Root type for serialized pipeline configuration. A pipeline config contains
PipelineMeta	Pipeline metadata.
PipelineInput	Spcification of a pipeline input.
PipelineComponent	Specification of a pipeline component.
PipelineLiteral	Literal nodes represented in the pipeline.

Functions

check_name(name, *[, what, allow_reserved])	Check that a name is valid.
hash_config(config)	Compute the hash of a configuration model.
merge_configs(base, update, *[, path, _skip_comp])

Module Contents

lenskit.schemas.pipeline.UNSET_CODE = '!UNSET'

lenskit.schemas.pipeline.check_name(name, *, what='node', allow_reserved=False)

Check that a name is valid.

Raises:

ValueError – If the specified name is not valid.

Parameters:

• name (str)

• what (str)

• allow_reserved (bool)

lenskit.schemas.pipeline.hash_config(config)

Compute the hash of a configuration model.

Stability:

Internal (see Stability Levels).

Parameters:

config (pydantic.BaseModel)

Return type:

str

lenskit.schemas.pipeline.merge_configs(base, update, *, path=(), _skip_comp=False)

Parameters:

• base (dict[str, Any])

• update (Mapping[str, Any])

• path (tuple[str, Ellipsis])

• _skip_comp (bool)

Exported Aliases

exception lenskit.schemas.pipeline.PipelineError

Re-exported alias for lenskit.diagnostics.PipelineError.