Index

A

Account (class in poprox_concepts.domain) (class in poprox_concepts.domain.account) AccountInterest (class in poprox_concepts.domain) (class in poprox_concepts.domain.account) AdditiveAttention (class in poprox_recommender.model.general.attention.additive) allow_data_test_failures() (in module poprox_recommender.config) Article (class in poprox_concepts.domain) (class in poprox_concepts.domain.article)

ArticleEmbeddingModel (class in poprox_recommender.components.embedders.article) ArticlePlacement (class in poprox_concepts.domain) (class in poprox_concepts.domain.article) ArticleScorer (class in poprox_recommender.components.scorers) (class in poprox_recommender.components.scorers.article) assert_tensor_size() (in module poprox_recommender.pytorch) (in module poprox_recommender.pytorch.datachecks) Assignment (class in poprox_storage.concepts.experiment) assignments (poprox_storage.concepts.manifest.ManifestPhase attribute)

B

BaseDataset (class in poprox_recommender.training.dataset)

C

Calibrator (class in poprox_recommender.components.diversifiers) (class in poprox_recommender.components.diversifiers.calibration) CalibratorConfig (class in poprox_recommender.components.diversifiers.calibration) CandidateSet (class in poprox_concepts.domain) (class in poprox_concepts.domain.recommendation)

Click (class in poprox_concepts.domain) (class in poprox_concepts.domain.click) compute_kl_divergence() (in module poprox_recommender.components.diversifiers.calibration) Concatenate (class in poprox_recommender.components.joiners) (class in poprox_recommender.components.joiners.concat) convert_duration() (in module poprox_storage.concepts.manifest)

D

default_device() (in module poprox_recommender.config) DEFAULT_PIPELINE (in module poprox_recommender.recommenders.configurations) default_pipeline() (in module poprox_recommender.recommenders.load) Demographics (class in poprox_concepts.domain) (class in poprox_concepts.domain.demographics) description (poprox_storage.concepts.manifest.ManifestExperiment attribute)

discover_pipelines() (in module poprox_recommender.recommenders) (in module poprox_recommender.recommenders.load) DockerTestService (class in poprox_recommender.testing) DotProductClickPredictor (class in poprox_recommender.model.general.click_predictor.dot_product) duration (poprox_storage.concepts.manifest.ManifestExperiment attribute) (poprox_storage.concepts.manifest.ManifestPhase attribute) dynamic_remote() (in module poprox_recommender.evaluation.generate.worker)

E

emb_file (poprox_recommender.evaluation.generate.outputs.RecOutputs property) EmbeddingCopier (class in poprox_recommender.components.embedders.article) EmbeddingWriter (class in poprox_recommender.evaluation.generate.outputs) Entity (class in poprox_concepts.domain) (class in poprox_concepts.domain.article) environment variable POPROX_DEFAULT_PIPELINE, [1]

EpsilonGreedy (class in poprox_recommender.components.samplers.epsilon_greedy) EpsilonGreedyConfig (class in poprox_recommender.components.samplers.epsilon_greedy) Experience (class in poprox_concepts.domain) (class in poprox_concepts.domain.experience) Experiment (class in poprox_storage.concepts.experiment) experiment (poprox_storage.concepts.manifest.ManifestFile attribute)

F

FillCandidates (class in poprox_recommender.components.joiners) (class in poprox_recommender.components.joiners.fill) FillConfig (class in poprox_recommender.components.joiners.fill) FillRecs (class in poprox_recommender.components.joiners) (class in poprox_recommender.components.joiners.fill) forward() (poprox_recommender.model.general.attention.additive.AdditiveAttention method) (poprox_recommender.model.general.attention.multihead_self.MultiHeadSelfAttention method) (poprox_recommender.model.general.attention.multihead_self.ScaledDotProductAttention method) (poprox_recommender.model.general.click_predictor.dot_product.DotProductClickPredictor method) (poprox_recommender.model.nrms.news_encoder.NewsEncoder method) (poprox_recommender.model.nrms.NRMS method) (poprox_recommender.model.nrms.user_encoder.UserEncoder method)

G

get_news_vector() (poprox_recommender.model.nrms.NRMS method) get_pipeline() (in module poprox_recommender.recommenders) (in module poprox_recommender.recommenders.load) get_pipeline_builder() (in module poprox_recommender.recommenders) (in module poprox_recommender.recommenders.load)

get_prediction() (poprox_recommender.model.nrms.NRMS method) get_user_vector() (poprox_recommender.model.nrms.NRMS method) Group (class in poprox_storage.concepts.experiment) groups (poprox_storage.concepts.experiment.Experiment property) (poprox_storage.concepts.manifest.ManifestGroupSpec attribute) GzipRequest (class in poprox_recommender.api.gzip)

I

id (poprox_storage.concepts.manifest.ManifestExperiment attribute) identical_to (poprox_storage.concepts.manifest.ManifestUserGroup attribute) Image (class in poprox_concepts.domain) (class in poprox_concepts.domain.image) Impression (class in poprox_concepts.domain) (class in poprox_concepts.domain.newsletter)

InProcessTestService (class in poprox_recommender.testing) InterestProfile (class in poprox_concepts.domain) (class in poprox_concepts.domain.profile) Interleave (class in poprox_recommender.components.joiners) (class in poprox_recommender.components.joiners.interleave)

J

JSONRecommendationWriter (class in poprox_recommender.evaluation.generate.outputs)

L

LocalityCalibrator (class in poprox_recommender.components.diversifiers) (class in poprox_recommender.components.diversifiers.locality_calibration)

LoginLinkData (class in poprox_concepts.api.tracking)

M

make_actor() (poprox_recommender.evaluation.generate.outputs.RecommendationWriter class method) manifest_to_experiment() (in module poprox_storage.concepts.manifest) ManifestExperiment (class in poprox_storage.concepts.manifest) ManifestFile (class in poprox_storage.concepts.manifest) ManifestGroupSpec (class in poprox_storage.concepts.manifest) ManifestPhase (class in poprox_storage.concepts.manifest) ManifestPhaseAssignment (class in poprox_storage.concepts.manifest) ManifestPhases (class in poprox_storage.concepts.manifest) ManifestRecommender (class in poprox_storage.concepts.manifest) ManifestTeam (class in poprox_storage.concepts.manifest) ManifestUserGroup (class in poprox_storage.concepts.manifest) measure_profile_recs() (in module poprox_recommender.evaluation.metrics) members (poprox_storage.concepts.manifest.ManifestTeam attribute) Mention (class in poprox_concepts.domain) (class in poprox_concepts.domain.article) MindData (class in poprox_recommender.data.mind) minimum_size (poprox_storage.concepts.manifest.ManifestUserGroup attribute) MMRConfig (class in poprox_recommender.components.diversifiers.mmr) MMRDiversifier (class in poprox_recommender.components.diversifiers) (class in poprox_recommender.components.diversifiers.mmr) model_file_path() (in module poprox_recommender.paths) model_post_init() (poprox_storage.concepts.qualtrics_survey.QualtricsCleanResponse method) ModelConfig (class in poprox_recommender.model) module poprox_concepts poprox_concepts.api poprox_concepts.api.recommendations poprox_concepts.api.recommendations.v1 poprox_concepts.api.recommendations.v2 poprox_concepts.api.recommendations.v3 poprox_concepts.api.recommendations.versions poprox_concepts.api.tracking poprox_concepts.domain poprox_concepts.domain.account poprox_concepts.domain.article poprox_concepts.domain.click poprox_concepts.domain.demographics poprox_concepts.domain.experience poprox_concepts.domain.image poprox_concepts.domain.login poprox_concepts.domain.newsletter poprox_concepts.domain.profile poprox_concepts.domain.recommendation poprox_concepts.domain.topics poprox_recommender poprox_recommender.api poprox_recommender.api.gzip poprox_recommender.api.main poprox_recommender.components poprox_recommender.components.diversifiers poprox_recommender.components.diversifiers.calibration poprox_recommender.components.diversifiers.locality_calibration poprox_recommender.components.diversifiers.mmr poprox_recommender.components.diversifiers.pfar poprox_recommender.components.diversifiers.topic_calibration poprox_recommender.components.embedders poprox_recommender.components.embedders.article poprox_recommender.components.embedders.user poprox_recommender.components.embedders.user_article_feedback poprox_recommender.components.embedders.user_topic_prefs poprox_recommender.components.filters poprox_recommender.components.filters.image_selector poprox_recommender.components.filters.topic poprox_recommender.components.joiners poprox_recommender.components.joiners.concat poprox_recommender.components.joiners.fill poprox_recommender.components.joiners.interleave poprox_recommender.components.joiners.rrf poprox_recommender.components.joiners.score poprox_recommender.components.rankers poprox_recommender.components.rankers.topk poprox_recommender.components.samplers poprox_recommender.components.samplers.epsilon_greedy poprox_recommender.components.samplers.softmax poprox_recommender.components.samplers.uniform poprox_recommender.components.scorers poprox_recommender.components.scorers.article poprox_recommender.components.scorers.topic_article poprox_recommender.config poprox_recommender.data poprox_recommender.data.eval poprox_recommender.data.mind poprox_recommender.data.poprox poprox_recommender.evaluation poprox_recommender.evaluation.collect poprox_recommender.evaluation.evaluate poprox_recommender.evaluation.generate poprox_recommender.evaluation.generate.outputs poprox_recommender.evaluation.generate.worker poprox_recommender.evaluation.metrics poprox_recommender.evaluation.metrics.ils poprox_recommender.evaluation.metrics.lip poprox_recommender.evaluation.metrics.rbe poprox_recommender.evaluation.metrics.rbo poprox_recommender.evaluation.writer poprox_recommender.model poprox_recommender.model.general poprox_recommender.model.general.attention poprox_recommender.model.general.attention.additive poprox_recommender.model.general.attention.multihead_self poprox_recommender.model.general.click_predictor poprox_recommender.model.general.click_predictor.dot_product poprox_recommender.model.nrms poprox_recommender.model.nrms.news_encoder poprox_recommender.model.nrms.user_encoder poprox_recommender.paths poprox_recommender.pytorch poprox_recommender.pytorch.datachecks poprox_recommender.pytorch.decorators poprox_recommender.recommenders poprox_recommender.recommenders.configurations poprox_recommender.recommenders.configurations.nrms poprox_recommender.recommenders.configurations.nrms_article_feedback poprox_recommender.recommenders.configurations.nrms_feedback_filter poprox_recommender.recommenders.configurations.nrms_feedback_filter_exp poprox_recommender.recommenders.configurations.nrms_rrf_static_user poprox_recommender.recommenders.configurations.nrms_topic_exploration poprox_recommender.recommenders.configurations.nrms_topic_scores poprox_recommender.recommenders.configurations.nrms_topics_static poprox_recommender.recommenders.configurations.softmax poprox_recommender.recommenders.hooks poprox_recommender.recommenders.load poprox_recommender.testing poprox_recommender.topics poprox_recommender.training poprox_recommender.training.dataset poprox_recommender.training.preprocess poprox_recommender.training.train poprox_storage.concepts poprox_storage.concepts.experiment poprox_storage.concepts.manifest poprox_storage.concepts.qualtrics_survey

MultiHeadSelfAttention (class in poprox_recommender.model.general.attention.multihead_self)

N

NewsEncoder (class in poprox_recommender.model.nrms.news_encoder) Newsletter (class in poprox_concepts.domain) (class in poprox_concepts.domain.newsletter) NRMS (class in poprox_recommender.model.nrms) NRMSArticleEmbedder (class in poprox_recommender.components.embedders) (class in poprox_recommender.components.embedders.article)

NRMSArticleEmbedderConfig (class in poprox_recommender.components.embedders) (class in poprox_recommender.components.embedders.article) NRMSUserEmbedder (class in poprox_recommender.components.embedders) (class in poprox_recommender.components.embedders.user) NRMSUserEmbedderConfig (class in poprox_recommender.components.embedders) (class in poprox_recommender.components.embedders.user)

O

OfflineRecommendations (class in poprox_recommender.evaluation.generate.outputs)

OfflineRecResults (class in poprox_recommender.evaluation.generate.outputs) owner (poprox_storage.concepts.manifest.ManifestFile attribute)

P

ParquetBatchedWriter (class in poprox_recommender.evaluation.writer) ParquetRecommendationWriter (class in poprox_recommender.evaluation.generate.outputs) ParquetWriterOptions (class in poprox_recommender.evaluation.writer) parse_behaviors() (in module poprox_recommender.training.preprocess) parse_manifest_toml() (in module poprox_storage.concepts.manifest) parse_news() (in module poprox_recommender.training.preprocess) PFARConfig (class in poprox_recommender.components.diversifiers.pfar) PFARDiversifier (class in poprox_recommender.components.diversifiers) (class in poprox_recommender.components.diversifiers.pfar) Phase (class in poprox_storage.concepts.experiment) phases (poprox_storage.concepts.manifest.ManifestFile attribute) (poprox_storage.concepts.manifest.ManifestPhases attribute) PipelineLoadError, [1] poprox_concepts module poprox_concepts.api module poprox_concepts.api.recommendations module poprox_concepts.api.recommendations.v1 module poprox_concepts.api.recommendations.v2 module poprox_concepts.api.recommendations.v3 module poprox_concepts.api.recommendations.versions module poprox_concepts.api.tracking module poprox_concepts.domain module poprox_concepts.domain.account module poprox_concepts.domain.article module poprox_concepts.domain.click module poprox_concepts.domain.demographics module poprox_concepts.domain.experience module poprox_concepts.domain.image module poprox_concepts.domain.login module poprox_concepts.domain.newsletter module poprox_concepts.domain.profile module poprox_concepts.domain.recommendation module poprox_concepts.domain.topics module POPROX_DEFAULT_PIPELINE, [1] poprox_recommender module poprox_recommender.api module poprox_recommender.api.gzip module poprox_recommender.api.main module poprox_recommender.components module poprox_recommender.components.diversifiers module poprox_recommender.components.diversifiers.calibration module poprox_recommender.components.diversifiers.locality_calibration module poprox_recommender.components.diversifiers.mmr module poprox_recommender.components.diversifiers.pfar module poprox_recommender.components.diversifiers.topic_calibration module poprox_recommender.components.embedders module poprox_recommender.components.embedders.article module poprox_recommender.components.embedders.user module poprox_recommender.components.embedders.user_article_feedback module poprox_recommender.components.embedders.user_topic_prefs module poprox_recommender.components.filters module poprox_recommender.components.filters.image_selector module poprox_recommender.components.filters.topic module poprox_recommender.components.joiners module poprox_recommender.components.joiners.concat module poprox_recommender.components.joiners.fill module poprox_recommender.components.joiners.interleave module poprox_recommender.components.joiners.rrf module poprox_recommender.components.joiners.score module poprox_recommender.components.rankers module poprox_recommender.components.rankers.topk module poprox_recommender.components.samplers module poprox_recommender.components.samplers.epsilon_greedy module poprox_recommender.components.samplers.softmax module poprox_recommender.components.samplers.uniform module poprox_recommender.components.scorers module poprox_recommender.components.scorers.article module

poprox_recommender.components.scorers.topic_article module poprox_recommender.config module poprox_recommender.data module poprox_recommender.data.eval module poprox_recommender.data.mind module poprox_recommender.data.poprox module poprox_recommender.evaluation module poprox_recommender.evaluation.collect module poprox_recommender.evaluation.evaluate module poprox_recommender.evaluation.generate module poprox_recommender.evaluation.generate.outputs module poprox_recommender.evaluation.generate.worker module poprox_recommender.evaluation.metrics module poprox_recommender.evaluation.metrics.ils module poprox_recommender.evaluation.metrics.lip module poprox_recommender.evaluation.metrics.rbe module poprox_recommender.evaluation.metrics.rbo module poprox_recommender.evaluation.writer module poprox_recommender.model module poprox_recommender.model.general module poprox_recommender.model.general.attention module poprox_recommender.model.general.attention.additive module poprox_recommender.model.general.attention.multihead_self module poprox_recommender.model.general.click_predictor module poprox_recommender.model.general.click_predictor.dot_product module poprox_recommender.model.nrms module poprox_recommender.model.nrms.news_encoder module poprox_recommender.model.nrms.user_encoder module poprox_recommender.paths module poprox_recommender.pytorch module poprox_recommender.pytorch.datachecks module poprox_recommender.pytorch.decorators module poprox_recommender.recommenders module poprox_recommender.recommenders.configurations module poprox_recommender.recommenders.configurations.nrms module poprox_recommender.recommenders.configurations.nrms_article_feedback module poprox_recommender.recommenders.configurations.nrms_feedback_filter module poprox_recommender.recommenders.configurations.nrms_feedback_filter_exp module poprox_recommender.recommenders.configurations.nrms_rrf_static_user module poprox_recommender.recommenders.configurations.nrms_topic_exploration module poprox_recommender.recommenders.configurations.nrms_topic_scores module poprox_recommender.recommenders.configurations.nrms_topics_static module poprox_recommender.recommenders.configurations.softmax module poprox_recommender.recommenders.hooks module poprox_recommender.recommenders.load module poprox_recommender.testing module poprox_recommender.topics module poprox_recommender.training module poprox_recommender.training.dataset module poprox_recommender.training.preprocess module poprox_recommender.training.train module poprox_storage.concepts module poprox_storage.concepts.experiment module poprox_storage.concepts.manifest module poprox_storage.concepts.qualtrics_survey module profile_id (poprox_recommender.evaluation.metrics.ProfileRecs attribute) profile_truth() (poprox_recommender.data.mind.MindData method) ProfileRecs (class in poprox_recommender.evaluation.metrics) project_root() (in module poprox_recommender.paths) ProtocolModelV1_1 (class in poprox_concepts.api.recommendations.v1) ProtocolModelV2_0 (class in poprox_concepts.api.recommendations.v2) ProtocolModelV3_0 (class in poprox_concepts.api.recommendations.v3) ProtocolVersions (class in poprox_concepts.api.recommendations.versions)

Q

QualtricsCleanResponse (class in poprox_storage.concepts.qualtrics_survey) QualtricsSurvey (class in poprox_storage.concepts.qualtrics_survey)

QualtricsSurveyInstance (class in poprox_storage.concepts.qualtrics_survey) QualtricsSurveyResponse (class in poprox_storage.concepts.qualtrics_survey)

R

rank_biased_overlap() (in module poprox_recommender.evaluation.metrics) (in module poprox_recommender.evaluation.metrics.rbo) rec_dir (poprox_recommender.evaluation.generate.outputs.RecOutputs property) rec_json_file (poprox_recommender.evaluation.generate.outputs.RecOutputs property) rec_parquet_file (poprox_recommender.evaluation.generate.outputs.RecOutputs property) rec_profiles() (in module poprox_recommender.evaluation.evaluate) ReciprocalRankFusion (class in poprox_recommender.components.joiners) (class in poprox_recommender.components.joiners.rrf) recommend_batch() (in module poprox_recommender.evaluation.generate.worker) recommend_for_profile() (in module poprox_recommender.evaluation.generate.worker) RecommendationList (class in poprox_concepts.domain) (class in poprox_concepts.domain.recommendation) RecommendationRequestV1 (class in poprox_concepts.api.recommendations.v1) RecommendationRequestV2 (class in poprox_concepts.api.recommendations.v2) RecommendationRequestV3 (class in poprox_concepts.api.recommendations.v3)

RecommendationResponseV1 (class in poprox_concepts.api.recommendations.v1) RecommendationResponseV2 (class in poprox_concepts.api.recommendations.v2) RecommendationResponseV3 (class in poprox_concepts.api.recommendations.v3) RecommendationWriter (class in poprox_recommender.evaluation.generate.outputs) Recommender (class in poprox_storage.concepts.experiment) recommender (poprox_storage.concepts.manifest.ManifestPhaseAssignment attribute) RecommenderComponents (class in poprox_recommender.model) RecommenderInfo (class in poprox_concepts.api.recommendations.versions) recommenders (poprox_storage.concepts.experiment.Experiment property) (poprox_storage.concepts.manifest.ManifestFile attribute) RecOutputs (class in poprox_recommender.evaluation.generate.outputs) recs (poprox_recommender.evaluation.metrics.ProfileRecs attribute) request() (poprox_recommender.testing.TestService method) RequestGenerator (class in poprox_recommender.testing) RRFConfig (class in poprox_recommender.components.joiners.rrf)

S

save_model() (in module poprox_recommender.training.train) ScaledDotProductAttention (class in poprox_recommender.model.general.attention.multihead_self) ScoreFusion (class in poprox_recommender.components.joiners.score) ScoreFusionConfig (class in poprox_recommender.components.joiners.score) select_articles() (in module poprox_recommender.recommenders) sequence (poprox_storage.concepts.manifest.ManifestPhases attribute)

shallow_copy_pydantic_model() (in module poprox_recommender.recommenders.hooks) SignUpLinkData (class in poprox_concepts.api.tracking) SoftmaxConfig (class in poprox_recommender.components.samplers.softmax) SoftmaxSampler (class in poprox_recommender.components.samplers) (class in poprox_recommender.components.samplers.softmax) start_date (poprox_storage.concepts.manifest.ManifestExperiment attribute)

T

Team (class in poprox_storage.concepts.experiment) team_id (poprox_storage.concepts.manifest.ManifestTeam attribute) team_name (poprox_storage.concepts.manifest.ManifestTeam attribute) template (poprox_storage.concepts.manifest.ManifestPhaseAssignment attribute) TestService (class in poprox_recommender.testing) Token (class in poprox_concepts.api.tracking) TopicalArticleScorer (class in poprox_recommender.components.scorers) (class in poprox_recommender.components.scorers.topic_article) TopicCalibrator (class in poprox_recommender.components.diversifiers) (class in poprox_recommender.components.diversifiers.topic_calibration) TopicFilter (class in poprox_recommender.components.filters) (class in poprox_recommender.components.filters.topic)

TopkConfig (class in poprox_recommender.components.rankers.topk) TopkRanker (class in poprox_recommender.components.rankers.topk) TopNewsHeadline (class in poprox_concepts.domain) (class in poprox_concepts.domain.article) torch_inference() (in module poprox_recommender.pytorch) (in module poprox_recommender.pytorch.decorators) TrackingLinkData (class in poprox_concepts.api) (class in poprox_concepts.api.tracking) Treatment (class in poprox_storage.concepts.experiment) truth (poprox_recommender.evaluation.metrics.ProfileRecs attribute)

U

UniformSampler (class in poprox_recommender.components.samplers) (class in poprox_recommender.components.samplers.uniform) UniformSamplerConfig (class in poprox_recommender.components.samplers.uniform) url (poprox_storage.concepts.manifest.ManifestRecommender attribute) user_topic_preference() (in module poprox_recommender.topics)

UserArticleFeedbackConfig (class in poprox_recommender.components.embedders.user_article_feedback) UserArticleFeedbackEmbedder (class in poprox_recommender.components.embedders.user_article_feedback) UserEncoder (class in poprox_recommender.model.nrms.user_encoder) UserOnboardingConfig (class in poprox_recommender.components.embedders.user_topic_prefs) UserOnboardingEmbedder (class in poprox_recommender.components.embedders.user_topic_prefs) users (poprox_storage.concepts.manifest.ManifestFile attribute)

V

ValDataset (class in poprox_recommender.training.dataset)

W

WebLogin (class in poprox_concepts.domain) (class in poprox_concepts.domain.login) write_recommendations() (poprox_recommender.evaluation.generate.outputs.EmbeddingWriter method) (poprox_recommender.evaluation.generate.outputs.JSONRecommendationWriter method) (poprox_recommender.evaluation.generate.outputs.ParquetRecommendationWriter method) (poprox_recommender.evaluation.generate.outputs.RecommendationWriter method)