Skip to content

Commit

Permalink
update component index
Browse files Browse the repository at this point in the history
  • Loading branch information
mdekstrand committed Jan 21, 2025
1 parent f47d6a7 commit 5ce1d1a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 11 deletions.
19 changes: 9 additions & 10 deletions docs/api/pipeline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ Pipeline Classes
:nosignatures:
:caption: Data Sets

~lenskit.pipeline.Pipeline
~lenskit.pipeline.PipelineBuilder
~lenskit.pipeline.PipelineState
~lenskit.pipeline.Node
~lenskit.pipeline.Lazy
Pipeline
PipelineBuilder
PipelineState
Node
Lazy

Component Interface
-------------------
Expand All @@ -30,8 +30,7 @@ LensKit components.
:toctree: .
:nosignatures:

~lenskit.pipeline.Component
~lenskit.pipeline.Trainable
Component

Standard Pipelines
------------------
Expand All @@ -40,8 +39,8 @@ Standard Pipelines
:toctree: .
:nosignatures:

~lenskit.pipeline.RecPipelineBuilder
~lenskit.pipeline.topn_pipeline
RecPipelineBuilder
topn_pipeline

Serialized Configurations
-------------------------
Expand All @@ -50,4 +49,4 @@ Serialized Configurations
:toctree: .
:nosignatures:

~lenskit.pipeline.PipelineConfig
PipelineConfig
2 changes: 1 addition & 1 deletion docs/guide/scorers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Most recommendation pipelines are built around a *scoring model* that scores
items for a recommendation query (e.g., user). Standard top-*N* recommendation
uses these scores to rank items, and they can be used as inputs into other
techniques such as samplers and rerankers. Scorers are almost always
:class:`~lenskit.pipeline.Trainable`, and by convention are named ``XYZScorer``.
:class:`~lenskit.training.Trainable`, and by convention are named ``XYZScorer``.
They typically take two inputs, the query (`query`) and the list of items to
score (`items`).

Expand Down

0 comments on commit 5ce1d1a

Please sign in to comment.