Pipeline API#

This page documents the LensKit pipeline API, exposed in the lenskit.pipeline module.

Pipeline Classes#

`Pipeline`	LensKit recommendation pipeline.
`PipelineBuilder`	Builder for LensKit recommendation pipelines.
`PipelineState`	Full results of running a pipeline.
`Node`	Representation of a single node in a `Pipeline`.
`Lazy`	Type for accepting lazy inputs from the pipeline runner.
`PipelineCache`	A cache to share components between pipelines.

These are the interfaces and classes you need to reference when building new LensKit components.

Base class for pipeline component objects.

`RecPipelineBuilder`	Builder to help assemble common pipeline patterns.
`topn_pipeline`	Create a pipeline that produces top-N recommendations using a scoring model.
`predict_pipeline`	Create a pipeline that predicts ratings, but does not include any ranking capabilities.

Most code will not need to directly use the configuration classes, but they define the schema of pipeline configuration files.

Pydantic models for pipeline configuration and serialization support.

Inspect or process data as it passes to a component's input.

The pipeline directly exposes its nodes, but most code will not need to use them.