poprox_recommender.recommenders#

Functions

select_articles(candidate_articles, ...[, ...])

Select articles with default recommender configuration.
exception poprox_recommender.recommenders.PipelineLoadError#

Bases: Exception

Exception raised when a pipeline cannot be loaded or instantiated, to separate those errors from errors running the pipeline.

poprox_recommender.recommenders.get_pipeline_builder(name, device=None, num_slots=10)#

Get a pipeline builder by name.

Parameters:

  • name (str)

  • device (str | None)

  • num_slots (int)

Return type:

PipelineBuilder

poprox_recommender.recommenders.get_pipeline(name, device=None, num_slots=10)#

Get a built pipeline by name.

Parameters:

  • name (str)

  • device (str | None)

  • num_slots (int)

Return type:

Pipeline

poprox_recommender.recommenders.discover_pipelines()#

Discover the list of available pipeline configuration names.

Return type:

list[str]

poprox_recommender.recommenders.select_articles(candidate_articles, clicked_articles, interest_profile, pipeline_params=None)#

Select articles with default recommender configuration. It returns a pipeline state whose default is the final list of recommendations.

Parameters:
Return type:

PipelineState

Modules

configurations

Module definitions for the different recommender pipelines defined in the POPROX recommender service.

hooks

POPROX recommendation hooks.

load

Functions and logic for loading recommender pipeline configurations.