From 5ce1d1ad49c81d20b1b787e46484901f64102b0e Mon Sep 17 00:00:00 2001 From: Michael Ekstrand Date: Tue, 21 Jan 2025 12:09:28 -0500 Subject: [PATCH] update component index --- docs/api/pipeline.rst | 19 +++++++++---------- docs/guide/scorers.rst | 2 +- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/api/pipeline.rst b/docs/api/pipeline.rst index 25a7202ca..2c206b8d2 100644 --- a/docs/api/pipeline.rst +++ b/docs/api/pipeline.rst @@ -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 ------------------- @@ -30,8 +30,7 @@ LensKit components. :toctree: . :nosignatures: - ~lenskit.pipeline.Component - ~lenskit.pipeline.Trainable + Component Standard Pipelines ------------------ @@ -40,8 +39,8 @@ Standard Pipelines :toctree: . :nosignatures: - ~lenskit.pipeline.RecPipelineBuilder - ~lenskit.pipeline.topn_pipeline + RecPipelineBuilder + topn_pipeline Serialized Configurations ------------------------- @@ -50,4 +49,4 @@ Serialized Configurations :toctree: . :nosignatures: - ~lenskit.pipeline.PipelineConfig + PipelineConfig diff --git a/docs/guide/scorers.rst b/docs/guide/scorers.rst index 86194d237..37cc2c29c 100644 --- a/docs/guide/scorers.rst +++ b/docs/guide/scorers.rst @@ -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`).