NewsRecLib
latest
GET STARTED
Introduction
Installation
Quick Start
DATASETS
Summary of the Datasets
RECOMMENDERS
Summary of the Recommendation Models
Click Behavior Fusion
Training Objectives
Recommenders
TRAINING
Callbacks
Hyperparameter Optimization
EVALUATION
Metrics
API REFERENCE
newsreclib package
newsreclib.data package
newsreclib.metrics package
newsreclib.models package
newsreclib.utils package
NewsRecLib
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
|
X
A
AdditiveAttention (class in newsreclib.models.components.layers.attention)
apply_reduce_dim (newsreclib.models.components.encoders.news.text.PLM attribute)
attributes2encode (newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
B
batch_cand (newsreclib.data.components.batch.RecommendationBatch attribute)
,
[1]
batch_hist (newsreclib.data.components.batch.RecommendationBatch attribute)
,
[1]
C
cand_aspects (newsreclib.metrics.base.CustomRetrievalMetric attribute)
cand_indexes (newsreclib.metrics.base.CustomRetrievalMetric attribute)
category_encoder (newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
check_integrity() (in module newsreclib.data.components.file_utils)
clicked_aspects (newsreclib.metrics.base.CustomRetrievalMetric attribute)
CNNAddAtt (class in newsreclib.models.components.encoders.news.text)
CNNMHSAAddAtt (class in newsreclib.models.components.encoders.news.text)
CNNPersAtt (class in newsreclib.models.components.encoders.news.text)
combine_type (newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
combine_vectors (newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
compute() (newsreclib.metrics.base.CustomRetrievalMetric method)
compute_loss() (newsreclib.models.components.losses.SupConLoss method)
concatenate_inputs (newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
CustomRetrievalMetric (class in newsreclib.metrics.base)
D
dataset_attributes (newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
dense_att_hidden_dim1 (newsreclib.models.components.encoders.user.caum.UserEncoder attribute)
dense_att_hidden_dim2 (newsreclib.models.components.encoders.user.caum.UserEncoder attribute)
DenseAttention (class in newsreclib.models.components.layers.attention)
Diversity (class in newsreclib.metrics.diversity)
diversity() (in module newsreclib.metrics.functional)
DNNPredictor (class in newsreclib.models.components.layers.click_predictor)
DotProduct (class in newsreclib.models.components.layers.click_predictor)
dropout_probability (newsreclib.models.components.encoders.news.category.LinearEncoder attribute)
(newsreclib.models.components.encoders.news.text.CNNAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNMHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNPersAtt attribute)
(newsreclib.models.components.encoders.news.text.MHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.PLM attribute)
(newsreclib.models.components.encoders.user.caum.UserEncoder attribute)
(newsreclib.models.components.encoders.user.cen_news_rec.UserEncoder attribute)
(newsreclib.models.components.encoders.user.npa.UserEncoder attribute)
E
embed_dim (newsreclib.models.components.encoders.news.category.LinearEncoder attribute)
(newsreclib.models.components.encoders.news.text.CNNAddAtt attribute)
(newsreclib.models.components.encoders.news.text.MHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.PLM attribute)
entity_embed_dim (newsreclib.models.components.encoders.news.news.KCNN attribute)
entity_encoder (newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
F
forward() (newsreclib.models.components.encoders.news.aspect.SentimentEncoder method)
(newsreclib.models.components.encoders.news.category.LinearEncoder method)
(newsreclib.models.components.encoders.news.news.KCNN method)
(newsreclib.models.components.encoders.news.news.NewsEncoder method)
(newsreclib.models.components.encoders.news.text.CNNAddAtt method)
(newsreclib.models.components.encoders.news.text.CNNMHSAAddAtt method)
(newsreclib.models.components.encoders.news.text.CNNPersAtt method)
(newsreclib.models.components.encoders.news.text.MHSAAddAtt method)
(newsreclib.models.components.encoders.news.text.PLM method)
(newsreclib.models.components.encoders.user.caum.UserEncoder method)
(newsreclib.models.components.encoders.user.cen_news_rec.UserEncoder method)
(newsreclib.models.components.encoders.user.dkn.UserEncoder method)
(newsreclib.models.components.encoders.user.lstur.UserEncoder method)
(newsreclib.models.components.encoders.user.mins.UserEncoder method)
(newsreclib.models.components.encoders.user.naml.UserEncoder method)
(newsreclib.models.components.encoders.user.npa.UserEncoder method)
(newsreclib.models.components.encoders.user.nrms.UserEncoder method)
(newsreclib.models.components.layers.attention.AdditiveAttention method)
(newsreclib.models.components.layers.attention.DenseAttention method)
(newsreclib.models.components.layers.attention.PersonalizedAttention method)
(newsreclib.models.components.layers.attention.PolyAttention method)
(newsreclib.models.components.layers.attention.TargetAwareAttention method)
(newsreclib.models.components.layers.click_predictor.DNNPredictor method)
(newsreclib.models.components.layers.click_predictor.DotProduct method)
(newsreclib.models.components.layers.projection.UserPreferenceQueryProjection method)
(newsreclib.models.components.layers.projection.UserProjection method)
freeze_pretrained_emb (newsreclib.models.components.encoders.news.category.LinearEncoder attribute)
from_pretrained (newsreclib.models.components.encoders.news.category.LinearEncoder attribute)
frozen_layers (newsreclib.models.components.encoders.news.text.PLM attribute)
full_state_update (newsreclib.metrics.base.CustomRetrievalMetric attribute)
(newsreclib.metrics.diversity.Diversity attribute)
(newsreclib.metrics.personalization.Personalization attribute)
G
generalized_jaccard() (in module newsreclib.metrics.functional)
get_metric() (in module newsreclib.metrics.utils)
gru_hidden_dim (newsreclib.models.components.encoders.user.cen_news_rec.UserEncoder attribute)
H
harmonic_mean() (in module newsreclib.metrics.functional)
hidden_dim (newsreclib.models.components.encoders.user.dkn.UserEncoder attribute)
higher_is_better (newsreclib.metrics.base.CustomRetrievalMetric attribute)
(newsreclib.metrics.diversity.Diversity attribute)
(newsreclib.metrics.personalization.Personalization attribute)
hist_indexes (newsreclib.metrics.base.CustomRetrievalMetric attribute)
I
input_dim (newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
(newsreclib.models.components.encoders.user.dkn.UserEncoder attribute)
(newsreclib.models.components.encoders.user.lstur.UserEncoder attribute)
is_differentiable (newsreclib.metrics.base.CustomRetrievalMetric attribute)
(newsreclib.metrics.diversity.Diversity attribute)
(newsreclib.metrics.personalization.Personalization attribute)
K
KCNN (class in newsreclib.models.components.encoders.news.news)
L
labels (newsreclib.data.components.batch.NewsBatch attribute)
,
[1]
(newsreclib.data.components.batch.RecommendationBatch attribute)
,
[1]
linear_transform (newsreclib.models.components.encoders.news.category.LinearEncoder attribute)
LinearEncoder (class in newsreclib.models.components.encoders.news.category)
load_idx_map_as_dict() (in module newsreclib.data.components.file_utils)
long_short_term_method (newsreclib.models.components.encoders.user.lstur.UserEncoder attribute)
M
MHSAAddAtt (class in newsreclib.models.components.encoders.news.text)
module
newsreclib
newsreclib.data
,
[1]
newsreclib.data.components
newsreclib.data.components.adressa_user_info
newsreclib.data.components.batch
newsreclib.data.components.file_utils
newsreclib.metrics
newsreclib.metrics.base
newsreclib.metrics.diversity
newsreclib.metrics.functional
newsreclib.metrics.personalization
newsreclib.metrics.utils
newsreclib.models
,
[1]
newsreclib.models.components
newsreclib.models.components.encoders.news
newsreclib.models.components.encoders.news.aspect
newsreclib.models.components.encoders.news.category
newsreclib.models.components.encoders.news.news
newsreclib.models.components.encoders.news.text
newsreclib.models.components.encoders.user
newsreclib.models.components.encoders.user.caum
newsreclib.models.components.encoders.user.cen_news_rec
newsreclib.models.components.encoders.user.dkn
newsreclib.models.components.encoders.user.lstur
newsreclib.models.components.encoders.user.mins
newsreclib.models.components.encoders.user.naml
newsreclib.models.components.encoders.user.npa
newsreclib.models.components.encoders.user.nrms
newsreclib.models.components.layers
newsreclib.models.components.layers.attention
newsreclib.models.components.layers.click_predictor
newsreclib.models.components.layers.projection
newsreclib.models.components.losses
newsreclib.models.components.utils
newsreclib.models.fair_rec.manner_a_module
newsreclib.models.fair_rec.manner_cr_module
newsreclib.models.fair_rec.manner_module
newsreclib.models.fair_rec.senti_debias_module
newsreclib.models.fair_rec.sentirec_module
newsreclib.models.general_rec.caum_module
newsreclib.models.general_rec.cen_news_rec_module
newsreclib.models.general_rec.dkn_module
newsreclib.models.general_rec.lstur_module
newsreclib.models.general_rec.miner_module
newsreclib.models.general_rec.mins_module
newsreclib.models.general_rec.naml_module
newsreclib.models.general_rec.npa_module
newsreclib.models.general_rec.nrms_module
newsreclib.models.general_rec.tanr_module
N
news (newsreclib.data.components.batch.NewsBatch attribute)
,
[1]
news_embed_dim (newsreclib.models.components.encoders.user.caum.UserEncoder attribute)
(newsreclib.models.components.encoders.user.mins.UserEncoder attribute)
(newsreclib.models.components.encoders.user.naml.UserEncoder attribute)
(newsreclib.models.components.encoders.user.nrms.UserEncoder attribute)
NewsBatch (class in newsreclib.data.components.batch)
NewsEncoder (class in newsreclib.models.components.encoders.news.news)
newsreclib
module
newsreclib.data
module
,
[1]
newsreclib.data.components
module
newsreclib.data.components.adressa_user_info
module
newsreclib.data.components.batch
module
newsreclib.data.components.file_utils
module
newsreclib.metrics
module
newsreclib.metrics.base
module
newsreclib.metrics.diversity
module
newsreclib.metrics.functional
module
newsreclib.metrics.personalization
module
newsreclib.metrics.utils
module
newsreclib.models
module
,
[1]
newsreclib.models.components
module
newsreclib.models.components.encoders.news
module
newsreclib.models.components.encoders.news.aspect
module
newsreclib.models.components.encoders.news.category
module
newsreclib.models.components.encoders.news.news
module
newsreclib.models.components.encoders.news.text
module
newsreclib.models.components.encoders.user
module
newsreclib.models.components.encoders.user.caum
module
newsreclib.models.components.encoders.user.cen_news_rec
module
newsreclib.models.components.encoders.user.dkn
module
newsreclib.models.components.encoders.user.lstur
module
newsreclib.models.components.encoders.user.mins
module
newsreclib.models.components.encoders.user.naml
module
newsreclib.models.components.encoders.user.npa
module
newsreclib.models.components.encoders.user.nrms
module
newsreclib.models.components.layers
module
newsreclib.models.components.layers.attention
module
newsreclib.models.components.layers.click_predictor
module
newsreclib.models.components.layers.projection
module
newsreclib.models.components.losses
module
newsreclib.models.components.utils
module
newsreclib.models.fair_rec.manner_a_module
module
newsreclib.models.fair_rec.manner_cr_module
module
newsreclib.models.fair_rec.manner_module
module
newsreclib.models.fair_rec.senti_debias_module
module
newsreclib.models.fair_rec.sentirec_module
module
newsreclib.models.general_rec.caum_module
module
newsreclib.models.general_rec.cen_news_rec_module
module
newsreclib.models.general_rec.dkn_module
module
newsreclib.models.general_rec.lstur_module
module
newsreclib.models.general_rec.miner_module
module
newsreclib.models.general_rec.mins_module
module
newsreclib.models.general_rec.naml_module
module
newsreclib.models.general_rec.npa_module
module
newsreclib.models.general_rec.nrms_module
module
newsreclib.models.general_rec.tanr_module
module
num_categories (newsreclib.models.components.encoders.news.category.LinearEncoder attribute)
num_filters (newsreclib.models.components.encoders.news.news.KCNN attribute)
(newsreclib.models.components.encoders.news.text.CNNAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNMHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNPersAtt attribute)
(newsreclib.models.components.encoders.user.caum.UserEncoder attribute)
(newsreclib.models.components.encoders.user.cen_news_rec.UserEncoder attribute)
(newsreclib.models.components.encoders.user.mins.UserEncoder attribute)
(newsreclib.models.components.encoders.user.npa.UserEncoder attribute)
num_gru_channels (newsreclib.models.components.encoders.user.mins.UserEncoder attribute)
num_heads (newsreclib.models.components.encoders.news.text.CNNMHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.MHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.PLM attribute)
(newsreclib.models.components.encoders.user.caum.UserEncoder attribute)
(newsreclib.models.components.encoders.user.cen_news_rec.UserEncoder attribute)
(newsreclib.models.components.encoders.user.nrms.UserEncoder attribute)
num_recent_news (newsreclib.models.components.encoders.user.cen_news_rec.UserEncoder attribute)
num_sent_classes (newsreclib.models.components.encoders.news.aspect.SentimentEncoder attribute)
num_users (newsreclib.models.components.encoders.user.lstur.UserEncoder attribute)
O
output_dim (newsreclib.models.components.encoders.news.category.LinearEncoder attribute)
(newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
P
pairwise_cosine_similarity() (in module newsreclib.models.components.utils)
Personalization (class in newsreclib.metrics.personalization)
personalization() (in module newsreclib.metrics.functional)
PersonalizedAttention (class in newsreclib.models.components.layers.attention)
PLM (class in newsreclib.models.components.encoders.news.text)
plm_model (newsreclib.models.components.encoders.news.text.PLM attribute)
PolyAttention (class in newsreclib.models.components.layers.attention)
preds (newsreclib.metrics.base.CustomRetrievalMetric attribute)
preference_query_dim (newsreclib.models.components.encoders.user.npa.UserEncoder attribute)
pretrained_context_embeddings (newsreclib.models.components.encoders.news.news.KCNN attribute)
pretrained_embeddings (newsreclib.models.components.encoders.news.category.LinearEncoder attribute)
(newsreclib.models.components.encoders.news.text.CNNAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNMHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNPersAtt attribute)
(newsreclib.models.components.encoders.news.text.MHSAAddAtt attribute)
pretrained_entity_embeddings (newsreclib.models.components.encoders.news.news.KCNN attribute)
pretrained_text_embeddings (newsreclib.models.components.encoders.news.news.KCNN attribute)
Q
query_dim (newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
(newsreclib.models.components.encoders.news.text.CNNAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNMHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNPersAtt attribute)
(newsreclib.models.components.encoders.news.text.MHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.PLM attribute)
(newsreclib.models.components.encoders.user.cen_news_rec.UserEncoder attribute)
(newsreclib.models.components.encoders.user.mins.UserEncoder attribute)
(newsreclib.models.components.encoders.user.naml.UserEncoder attribute)
(newsreclib.models.components.encoders.user.nrms.UserEncoder attribute)
R
RecommendationBatch (class in newsreclib.data.components.batch)
reduced_embed_dim (newsreclib.models.components.encoders.news.text.PLM attribute)
S
sent_embed_dim (newsreclib.models.components.encoders.news.aspect.SentimentEncoder attribute)
sent_output_dim (newsreclib.models.components.encoders.news.aspect.SentimentEncoder attribute)
SentimentEncoder (class in newsreclib.models.components.encoders.news.aspect)
sort_click() (newsreclib.data.components.adressa_user_info.UserInfo method)
SupConLoss (class in newsreclib.models.components.losses)
T
TargetAwareAttention (class in newsreclib.models.components.layers.attention)
test_date_split (newsreclib.data.components.adressa_user_info.UserInfo attribute)
text_embed_dim (newsreclib.models.components.encoders.news.news.KCNN attribute)
(newsreclib.models.components.encoders.news.text.CNNPersAtt attribute)
text_encoder (newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
to_tsv() (in module newsreclib.data.components.file_utils)
train_date_split (newsreclib.data.components.adressa_user_info.UserInfo attribute)
training (newsreclib.models.components.encoders.news.aspect.SentimentEncoder attribute)
(newsreclib.models.components.encoders.news.category.LinearEncoder attribute)
(newsreclib.models.components.encoders.news.news.KCNN attribute)
(newsreclib.models.components.encoders.news.news.NewsEncoder attribute)
(newsreclib.models.components.encoders.news.text.CNNAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNMHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNPersAtt attribute)
(newsreclib.models.components.encoders.news.text.MHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.PLM attribute)
(newsreclib.models.components.encoders.user.caum.UserEncoder attribute)
(newsreclib.models.components.encoders.user.cen_news_rec.UserEncoder attribute)
(newsreclib.models.components.encoders.user.dkn.UserEncoder attribute)
(newsreclib.models.components.encoders.user.lstur.UserEncoder attribute)
(newsreclib.models.components.encoders.user.mins.UserEncoder attribute)
(newsreclib.models.components.encoders.user.naml.UserEncoder attribute)
(newsreclib.models.components.encoders.user.npa.UserEncoder attribute)
(newsreclib.models.components.encoders.user.nrms.UserEncoder attribute)
(newsreclib.models.components.layers.attention.AdditiveAttention attribute)
(newsreclib.models.components.layers.attention.DenseAttention attribute)
(newsreclib.models.components.layers.attention.PersonalizedAttention attribute)
(newsreclib.models.components.layers.attention.PolyAttention attribute)
(newsreclib.models.components.layers.attention.TargetAwareAttention attribute)
(newsreclib.models.components.layers.click_predictor.DNNPredictor attribute)
(newsreclib.models.components.layers.click_predictor.DotProduct attribute)
(newsreclib.models.components.layers.projection.UserPreferenceQueryProjection attribute)
(newsreclib.models.components.layers.projection.UserProjection attribute)
(newsreclib.models.components.losses.SupConLoss attribute)
U
update() (newsreclib.data.components.adressa_user_info.UserInfo method)
(newsreclib.metrics.base.CustomRetrievalMetric method)
use_context (newsreclib.models.components.encoders.news.news.KCNN attribute)
use_dropout (newsreclib.models.components.encoders.news.category.LinearEncoder attribute)
use_mhsa (newsreclib.models.components.encoders.news.text.PLM attribute)
user_embed_dim (newsreclib.models.components.encoders.news.text.CNNPersAtt attribute)
(newsreclib.models.components.encoders.user.npa.UserEncoder attribute)
user_masking_probability (newsreclib.models.components.encoders.user.lstur.UserEncoder attribute)
user_vector_dim (newsreclib.models.components.encoders.user.caum.UserEncoder attribute)
UserEncoder (class in newsreclib.models.components.encoders.user.caum)
(class in newsreclib.models.components.encoders.user.cen_news_rec)
(class in newsreclib.models.components.encoders.user.dkn)
(class in newsreclib.models.components.encoders.user.lstur)
(class in newsreclib.models.components.encoders.user.mins)
(class in newsreclib.models.components.encoders.user.naml)
(class in newsreclib.models.components.encoders.user.npa)
(class in newsreclib.models.components.encoders.user.nrms)
UserInfo (class in newsreclib.data.components.adressa_user_info)
UserPreferenceQueryProjection (class in newsreclib.models.components.layers.projection)
UserProjection (class in newsreclib.models.components.layers.projection)
users (newsreclib.data.components.batch.RecommendationBatch attribute)
,
[1]
W
window_size (newsreclib.models.components.encoders.news.text.CNNAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNMHSAAddAtt attribute)
(newsreclib.models.components.encoders.news.text.CNNPersAtt attribute)
window_sizes (newsreclib.models.components.encoders.news.news.KCNN attribute)
X
x_cand (newsreclib.data.components.batch.RecommendationBatch attribute)
,
[1]
x_hist (newsreclib.data.components.batch.RecommendationBatch attribute)
,
[1]
Read the Docs
v: latest
Versions
latest
Downloads
html
On Read the Docs
Project Home
Builds