Welcome to NewsRecLib’s documentation!

NewsRecLib is a library based on PyTorch Lightning and Hydra for the development and evaluation of neural news recommenders (NNR). The framework is highly configurable and modularized, decoupling core model components from one another. It enables running experiments from a single configuration file that navigates the pipeline from dataset selection and loading to model evaluation. NewsRecLib provides implementations of several neural news recommenders, training methods, standard evaluation benchmarks, hypeparameter optimization algorithms, extensive logging functionalities, and evaluation metrics (ranging from accuracy-based to beyond accuracy performance evaluation).

The foremost goals of NewsRecLib are to promote reproducible research and rigorous experimental evaluation.

NewsrecLib’s schema

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
  • Subpackages
    • newsreclib.data package
      • Subpackages
        • newsreclib.data.components package
          • Submodules
          • newsreclib.data.components.adressa_dataframe module
          • newsreclib.data.components.adressa_user_info module
          • newsreclib.data.components.batch module
          • newsreclib.data.components.data_utils module
          • newsreclib.data.components.download_utils module
          • newsreclib.data.components.file_utils module
          • newsreclib.data.components.mind_dataframe module
          • newsreclib.data.components.news_dataset module
          • newsreclib.data.components.rec_dataset module
          • newsreclib.data.components.sentiment_annotator module
      • Submodules
      • newsreclib.data.adressa_news_datamodule module
      • newsreclib.data.adressa_rec_datamodule module
      • newsreclib.data.mind_news_datamodule module
      • newsreclib.data.mind_rec_datamodule module
      • Module contents
    • newsreclib.metrics package
      • Submodules
      • newsreclib.metrics.base module
      • newsreclib.metrics.diversity module
      • newsreclib.metrics.functional module
      • newsreclib.metrics.personalization module
      • newsreclib.metrics.utils module
      • Module contents
    • newsreclib.models package
      • Subpackages
        • newsreclib.models.components package
          • Subpackages
          • Submodules
          • newsreclib.models.components.losses module
          • newsreclib.models.components.utils module
          • Module contents
        • newsreclib.models.fair_rec package
          • Submodules
          • 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
        • newsreclib.models.general_rec package
          • Submodules
          • 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
      • Submodules
      • newsreclib.models.abstract_recommender module
      • Module contents
    • newsreclib.utils package
      • Submodules
      • newsreclib.utils.instantiators module
      • newsreclib.utils.logging_utils module
      • newsreclib.utils.pylogger module
      • newsreclib.utils.rich_utils module
      • newsreclib.utils.utils module
      • Module contents
  • Submodules
  • newsreclib.train module
  • newsreclib.eval module
  • Module contents
• newsreclib.data package
  • Subpackages
    • newsreclib.data.components package
      • Submodules
      • newsreclib.data.components.adressa_dataframe module
      • newsreclib.data.components.adressa_user_info module
      • newsreclib.data.components.batch module
      • newsreclib.data.components.data_utils module
      • newsreclib.data.components.download_utils module
      • newsreclib.data.components.file_utils module
      • newsreclib.data.components.mind_dataframe module
      • newsreclib.data.components.news_dataset module
      • newsreclib.data.components.rec_dataset module
      • newsreclib.data.components.sentiment_annotator module
  • Submodules
  • newsreclib.data.adressa_news_datamodule module
  • newsreclib.data.adressa_rec_datamodule module
  • newsreclib.data.mind_news_datamodule module
  • newsreclib.data.mind_rec_datamodule module
  • Module contents
• newsreclib.metrics package
  • Submodules
  • newsreclib.metrics.base module
  • newsreclib.metrics.diversity module
  • newsreclib.metrics.functional module
  • newsreclib.metrics.personalization module
  • newsreclib.metrics.utils module
  • Module contents
• newsreclib.models package
  • Subpackages
    • newsreclib.models.components package
      • Subpackages
        • newsreclib.models.components.encoders package
          • Subpackages
        • newsreclib.models.components.layers package
          • Submodules
          • newsreclib.models.components.layers.attention module
          • newsreclib.models.components.layers.click_predictor module
          • newsreclib.models.components.layers.projection module
          • Module contents
      • Submodules
      • newsreclib.models.components.losses module
      • newsreclib.models.components.utils module
      • Module contents
    • newsreclib.models.fair_rec package
      • Submodules
      • 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
    • newsreclib.models.general_rec package
      • Submodules
      • 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
  • Submodules
  • newsreclib.models.abstract_recommender module
  • Module contents
• newsreclib.utils package
  • Submodules
  • newsreclib.utils.instantiators module
  • newsreclib.utils.logging_utils module
  • newsreclib.utils.pylogger module
  • newsreclib.utils.rich_utils module
  • newsreclib.utils.utils module
  • Module contents

Indices and tables

• Index

• Module Index

• Search Page