Skip to main content

A configurable, tunable, and reproducible library for CTR prediction

Project description

Logo
Tutorials Python version Pytorch version Pypi version Downloads License Wechat QR code

Click-through rate (CTR) prediction is a critical task for many industrial applications such as online advertising, recommender systems, and sponsored search. FuxiCTR provides an open-source library for CTR prediction, with key features in configurability, tunability, and reproducibility. We hope this project could benefit both researchers and practitioners with the goal of open benchmarking for CTR prediction.

This repo is the community dev version of the original release at huawei-noah/benchmark/FuxiCTR.

:bell: If you find our code or benchmarks helpful in your research, please kindly cite the following papers.

Jieming Zhu, Jinyang Liu, Shuai Yang, Qi Zhang, Xiuqiang He. Open Benchmarking for Click-Through Rate Prediction. The 30th ACM International Conference on Information and Knowledge Management (CIKM), 2021. [Bibtex]

Key Features

  • Configurable: Both data preprocessing and models are modularized and configurable.

  • Tunable: Models can be automatically tuned with easy configuration.

  • Reproducible: All the benchmarks can be easily reproduced.

Model List

No Publication Model Paper Benchmark
1 WWW'07 LR Predicting Clicks: Estimating the Click-Through Rate for New Ads :triangular_flag_on_post:Microsoft :arrow_upper_right:
2 ICDM'10 FM Factorization Machines :arrow_upper_right:
3 CIKM'13 DSSM Learning Deep Structured Semantic Models for Web Search using Clickthrough Data :triangular_flag_on_post:Microsoft :arrow_upper_right:
4 CIKM'15 CCPM A Convolutional Click Prediction Model :arrow_upper_right:
5 RecSys'16 FFM Field-aware Factorization Machines for CTR Prediction :triangular_flag_on_post:Criteo :arrow_upper_right:
6 RecSys'16 YoutubeDNN Deep Neural Networks for YouTube Recommendations :triangular_flag_on_post:Google :arrow_upper_right:
7 DLRS'16 Wide&Deep Wide & Deep Learning for Recommender Systems :triangular_flag_on_post:Google :arrow_upper_right:
8 ICDM'16 IPNN Product-based Neural Networks for User Response Prediction :arrow_upper_right:
9 KDD'16 DeepCross Deep Crossing: Web-Scale Modeling without Manually Crafted Combinatorial Features :triangular_flag_on_post:Microsoft :arrow_upper_right:
10 NIPS'16 HOFM Higher-Order Factorization Machines :arrow_upper_right:
11 IJCAI'17 DeepFM DeepFM: A Factorization-Machine based Neural Network for CTR Prediction :triangular_flag_on_post:Huawei :arrow_upper_right:
12 SIGIR'17 NFM Neural Factorization Machines for Sparse Predictive Analytics :arrow_upper_right:
13 IJCAI'17 AFM Attentional Factorization Machines: Learning the Weight of Feature Interactions via Attention Networks :arrow_upper_right:
14 ADKDD'17 DCN Deep & Cross Network for Ad Click Predictions :triangular_flag_on_post:Google :arrow_upper_right:
15 WWW'18 FwFM Field-weighted Factorization Machines for Click-Through Rate Prediction in Display Advertising :triangular_flag_on_post:Oath, TouchPal, LinkedIn, Alibaba :arrow_upper_right:
16 KDD'18 xDeepFM xDeepFM: Combining Explicit and Implicit Feature Interactions for Recommender Systems :triangular_flag_on_post:Microsoft :arrow_upper_right:
17 KDD'18 DIN Deep Interest Network for Click-Through Rate Prediction :triangular_flag_on_post:Alibaba
18 CIKM'19 FiGNN FiGNN: Modeling Feature Interactions via Graph Neural Networks for CTR Prediction :arrow_upper_right:
19 CIKM'19 AutoInt/AutoInt+ AutoInt: Automatic Feature Interaction Learning via Self-Attentive Neural Networks :arrow_upper_right:
20 RecSys'19 FiBiNET FiBiNET: Combining Feature Importance and Bilinear feature Interaction for Click-Through Rate Prediction :triangular_flag_on_post:Sina Weibo :arrow_upper_right:
21 WWW'19 FGCNN Feature Generation by Convolutional Neural Network for Click-Through Rate Prediction :triangular_flag_on_post:Huawei :arrow_upper_right:
22 AAAI'19 HFM/HFM+ Holographic Factorization Machines for Recommendation :arrow_upper_right:
23 Arxiv'19 DLRM Deep Learning Recommendation Model for Personalization and Recommendation Systems :triangular_flag_on_post:Facebook :arrow_upper_right:
24 NeuralNetworks'20 ONN Operation-aware Neural Networks for User Response Prediction :arrow_upper_right:
25 AAAI'20 AFN/AFN+ Adaptive Factorization Network: Learning Adaptive-Order Feature Interactions :arrow_upper_right:
26 AAAI'20 LorentzFM Learning Feature Interactions with Lorentzian Factorization :triangular_flag_on_post:eBay :arrow_upper_right:
27 WSDM'20 InterHAt Interpretable Click-through Rate Prediction through Hierarchical Attention :triangular_flag_on_post:NEC Labs, Google :arrow_upper_right:
28 DLP-KDD'20 FLEN FLEN: Leveraging Field for Scalable CTR Prediction :triangular_flag_on_post:Tencent :arrow_upper_right:
29 CIKM'20 DeepIM Deep Interaction Machine: A Simple but Effective Model for High-order Feature Interactions :triangular_flag_on_post:Alibaba, RealAI :arrow_upper_right:
30 WWW'21 FmFM FM^2: Field-matrixed Factorization Machines for Recommender Systems :triangular_flag_on_post:Yahoo :arrow_upper_right:
31 WWW'21 DCN-V2 DCN V2: Improved Deep & Cross Network and Practical Lessons for Web-scale Learning to Rank Systems :triangular_flag_on_post:Google :arrow_upper_right:
32 CIKM'21 DESTINE Disentangled Self-Attentive Neural Networks for Click-Through Rate Prediction :triangular_flag_on_post:Alibaba :arrow_upper_right:
33 CIKM'21 EDCN Enhancing Explicit and Implicit Feature Interactions via Information Sharing for Parallel Deep CTR Models :triangular_flag_on_post:Huawei :arrow_upper_right:
34 DLP-KDD'21 MaskNet MaskNet: Introducing Feature-Wise Multiplication to CTR Ranking Models by Instance-Guided Mask :triangular_flag_on_post:Sina Weibo :arrow_upper_right:
35 SIGIR'21 SAM Looking at CTR Prediction Again: Is Attention All You Need? :triangular_flag_on_post:BOSS Zhipin :arrow_upper_right:
36 KDD'21 AOANet Architecture and Operation Adaptive Network for Online Recommendations :triangular_flag_on_post:Didi Chuxing :arrow_upper_right:

Installation

Please follow the guide for installation. In particular, FuxiCTR has the following dependent requirements.

  • python 3.6
  • pytorch v1.0/v1.1
  • pyyaml >=5.1
  • scikit-learn
  • pandas
  • numpy
  • h5py
  • tqdm

Tutorials | 中文教程

  1. Run the demo to understand the overall workflow

  2. How to use dataset and model config files

  3. How to preprocess raw csv data to h5 data

  4. How to use h5 data as input

  5. How to make configurations?

  6. How to tune the model hyper-parameters via grid search

  7. How to use sequence features

  8. How to load pretrained embeddings as features

API Documentation

Check an overview of code structure for details on API design.

Discussion

Welcome to join our WeChat group for any question and discussion.

Scan QR code

Join Us

We have open positions for internships and full-time jobs. If you are interested in research and practice in recommender systems, please send your CV to jamie.zhu@huawei.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fuxictr-1.2.1.tar.gz (49.9 kB view hashes)

Uploaded Source

Built Distribution

fuxictr-1.2.1-py3-none-any.whl (109.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page