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)

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)

D

default_device() (in module poprox_recommender.config) Demographics (class in poprox_concepts.domain) (class in poprox_concepts.domain.demographics)

DotProductClickPredictor (class in poprox_recommender.model.general.click_predictor.dot_product)

E

EmbeddingCopier (class in poprox_recommender.components.embedders.article) Entity (class in poprox_concepts.domain) (class in poprox_concepts.domain.article)

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)

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_prediction() (poprox_recommender.model.nrms.NRMS method) get_user_vector() (poprox_recommender.model.nrms.NRMS method)

I

Image (class in poprox_concepts.domain) (class in poprox_concepts.domain.image) Impression (class in poprox_concepts.domain) (class in poprox_concepts.domain.newsletter)

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)

L

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

LoginLinkData (class in poprox_concepts.api.tracking)

M

measure_profile_recs() (in module poprox_recommender.evaluation.metrics) Mention (class in poprox_concepts.domain) (class in poprox_concepts.domain.article) MindData (class in poprox_recommender.data.mind) MMRConfig (class in poprox_recommender.components.diversifiers.mmr) MMRDiversifier (class in poprox_recommender.components.diversifiers) (class in poprox_recommender.components.diversifiers.mmr) model_config (poprox_concepts.api.recommendations.v1.ProtocolModelV1_1 attribute) (poprox_concepts.api.recommendations.v1.RecommendationRequestV1 attribute) (poprox_concepts.api.recommendations.v1.RecommendationResponseV1 attribute) (poprox_concepts.api.recommendations.v2.ProtocolModelV2_0 attribute) (poprox_concepts.api.recommendations.v2.RecommendationRequestV2 attribute) (poprox_concepts.api.recommendations.v2.RecommendationResponseV2 attribute) (poprox_concepts.api.recommendations.v3.ProtocolModelV3_0 attribute) (poprox_concepts.api.recommendations.v3.RecommendationList_v3 attribute) (poprox_concepts.api.recommendations.v3.RecommendationRequestV3 attribute) (poprox_concepts.api.recommendations.v3.RecommendationResponseSection attribute) (poprox_concepts.api.recommendations.v3.RecommendationResponseV3 attribute) (poprox_concepts.api.recommendations.versions.RecommenderInfo attribute) (poprox_concepts.api.tracking.LoginLinkData attribute) (poprox_concepts.api.tracking.SignUpLinkData attribute) (poprox_concepts.api.tracking.Token attribute) (poprox_concepts.api.tracking.TrackingLinkData attribute) (poprox_concepts.api.TrackingLinkData attribute) (poprox_concepts.domain.Account attribute) (poprox_concepts.domain.account.Account attribute) (poprox_concepts.domain.account.AccountInterest attribute) (poprox_concepts.domain.AccountInterest attribute) (poprox_concepts.domain.Article attribute) (poprox_concepts.domain.article.Article attribute) (poprox_concepts.domain.article.ArticlePlacement attribute) (poprox_concepts.domain.article.Entity attribute) (poprox_concepts.domain.article.Mention attribute) (poprox_concepts.domain.article.TopNewsHeadline attribute) (poprox_concepts.domain.ArticlePlacement attribute) (poprox_concepts.domain.CandidateSet attribute) (poprox_concepts.domain.Click attribute) (poprox_concepts.domain.click.Click attribute) (poprox_concepts.domain.Demographics attribute) (poprox_concepts.domain.demographics.Demographics attribute) (poprox_concepts.domain.Entity attribute) (poprox_concepts.domain.Experience attribute) (poprox_concepts.domain.experience.Experience attribute) (poprox_concepts.domain.Image attribute) (poprox_concepts.domain.image.Image attribute) (poprox_concepts.domain.Impression attribute) (poprox_concepts.domain.InterestProfile attribute) (poprox_concepts.domain.login.WebLogin attribute) (poprox_concepts.domain.Mention attribute) (poprox_concepts.domain.Newsletter attribute) (poprox_concepts.domain.newsletter.Impression attribute) (poprox_concepts.domain.newsletter.Newsletter attribute) (poprox_concepts.domain.profile.InterestProfile attribute) (poprox_concepts.domain.recommendation.CandidateSet attribute) (poprox_concepts.domain.recommendation.RecommendationList attribute) (poprox_concepts.domain.RecommendationList attribute) (poprox_concepts.domain.TopNewsHeadline attribute) (poprox_concepts.domain.WebLogin attribute) (poprox_recommender.components.diversifiers.calibration.CalibratorConfig attribute) (poprox_recommender.components.diversifiers.mmr.MMRConfig attribute) (poprox_recommender.components.diversifiers.pfar.PFARConfig attribute) (poprox_recommender.components.joiners.fill.FillConfig attribute) (poprox_recommender.components.joiners.rrf.RRFConfig attribute) (poprox_recommender.components.joiners.score.ScoreFusionConfig attribute) (poprox_recommender.components.rankers.topk.TopkConfig attribute) (poprox_recommender.components.samplers.epsilon_greedy.EpsilonGreedyConfig attribute) (poprox_recommender.components.samplers.softmax.SoftmaxConfig attribute) (poprox_recommender.components.samplers.uniform.UniformSamplerConfig attribute) model_file_path() (in module poprox_recommender.paths) 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.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.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.topics

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)

P

ParquetBatchedWriter (class in poprox_recommender.evaluation.writer) ParquetWriterOptions (class in poprox_recommender.evaluation.writer) PFARConfig (class in poprox_recommender.components.diversifiers.pfar) PFARDiversifier (class in poprox_recommender.components.diversifiers) (class in poprox_recommender.components.diversifiers.pfar) 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_recommender 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.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.topics 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)

R

rank_biased_overlap() (in module poprox_recommender.evaluation.metrics) (in module poprox_recommender.evaluation.metrics.rbo) rec_profiles() (in module poprox_recommender.evaluation.evaluate) ReciprocalRankFusion (class in poprox_recommender.components.joiners) (class in poprox_recommender.components.joiners.rrf) RecommendationList (class in poprox_concepts.domain) (class in poprox_concepts.domain.recommendation) RecommendationList_v3 (class in poprox_concepts.api.recommendations.v3) RecommendationRequestV1 (class in poprox_concepts.api.recommendations.v1)

RecommendationRequestV2 (class in poprox_concepts.api.recommendations.v2) RecommendationRequestV3 (class in poprox_concepts.api.recommendations.v3) RecommendationResponseSection (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) RecommenderComponents (class in poprox_recommender.model) RecommenderInfo (class in poprox_concepts.api.recommendations.versions) recs (poprox_recommender.evaluation.metrics.ProfileRecs attribute) RRFConfig (class in poprox_recommender.components.joiners.rrf)

S

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)

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)

T

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) 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) 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)

W

WebLogin (class in poprox_concepts.domain) (class in poprox_concepts.domain.login)