lenskit.pipeline.config

Pydantic models for pipeline configuration and serialization support.

Attributes

VALID_NAME

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

Module Contents

lenskit.pipeline.config.VALID_NAME

lenskit.pipeline.config.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.pipeline.config.hash_config(config)

Compute the hash of a configuration model.

Stability:

Internal (see Stability Levels).

Parameters:

config (pydantic.BaseModel)

Return type:

str

Exported Aliases

exception lenskit.pipeline.config.PipelineError

Re-exported alias for lenskit.diagnostics.PipelineError.

exception lenskit.pipeline.config.PipelineWarning

Re-exported alias for lenskit.diagnostics.PipelineWarning.

class lenskit.pipeline.config.HookEntry

Re-exported alias for lenskit.pipeline._hooks.HookEntry.

lenskit.pipeline.config.is_union_type()

Re-exported alias for lenskit.pipeline._types.is_union_type().

lenskit.pipeline.config.make_importable_path()

Re-exported alias for lenskit.pipeline._types.make_importable_path().

class lenskit.pipeline.config.Component

Re-exported alias for lenskit.pipeline.components.Component.

class lenskit.pipeline.config.ComponentConstructorNode

Re-exported alias for lenskit.pipeline.nodes.ComponentConstructorNode.

class lenskit.pipeline.config.ComponentInstanceNode

Re-exported alias for lenskit.pipeline.nodes.ComponentInstanceNode.

class lenskit.pipeline.config.ComponentNode

Re-exported alias for lenskit.pipeline.nodes.ComponentNode.

class lenskit.pipeline.config.InputNode

Re-exported alias for lenskit.pipeline.nodes.InputNode.