├── .gitignore ├── LICENSE ├── README.md ├── data ├── aliccp │ └── dataset description.md ├── avazu │ └── dataset description.md ├── criteo │ └── dataset description.md ├── movielens-1m │ └── dataset desciption.md └── preprocess.py ├── fs_run.py ├── models ├── basemodel.py ├── config.yaml ├── fs │ ├── adafs.py │ ├── autofield.py │ ├── gbdt.py │ ├── lasso.py │ ├── lpfs.py │ ├── mvfs.py │ ├── no_selection.py │ ├── optfs.py │ ├── optfs_old.py │ ├── permutation.py │ ├── rf.py │ ├── sfs.py │ ├── shark.py │ └── xgb.py ├── layers.py └── rec │ ├── dcn.py │ ├── deepfm.py │ ├── fibinet.py │ ├── fm.py │ ├── mlp.py │ └── widedeep.py ├── nni └── search_spaces │ ├── config.json │ └── fs │ ├── adafs.json │ ├── autofield.json │ ├── gbdt.json │ ├── lasso.json │ └── optfs.json ├── nni_tune.py ├── requirements.txt └── utils ├── datasets.py ├── fs_trainer.py └── utils.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | ERASE: Benchmarking Feature Selection Methods for Deep Recommender Systems 3 |

4 | 5 | 6 | 7 | In this repo, our scripts can be divided to two parts: `dataset preprocess` and `run fs`. 8 | 9 | You can also download the preprocessed dataset from Huggingface [ERASE_Dataset](https://huggingface.co/datasets/Jia-py/ERASE_Dataset) 10 | 11 | Please note that you need to run the following script from the root directory of the project. 12 | 13 | # package requirment 14 | 15 | * torch 16 | * pandas 17 | * numpy 18 | * nni 19 | 20 | ## File Structure 21 | 22 | ``` 23 | - checkpoints 24 | - checkpoints_for_retrain 25 | - data 26 | - avazu 27 | - preprocessed_avazu.csv # your data should put here 28 | - criteo 29 | - preprocessed_criteo.csv # your data should put here 30 | - movielens-1m 31 | - aliccp 32 | - preprocess.py # preprocess script 33 | - nni 34 | - search spaces 35 | - fs 36 | - specific-method.json # the hyperparameter search space for each methods in fs 37 | config.json # some hyperparameters related to general training, e.g., number of selected fields, learning rate 38 | - notebooks # some test notebooks 39 | - utils 40 | - datasets.py # read datasets 41 | - fs_trainer.py # trainer for feature selection 42 | - utils # some functions 43 | - fs_run.py # main script to run feature selection 44 | - nni_tune.py # run the nni tune 45 | - requirements.text # python libraries needed for this repository 46 | ``` 47 | 48 | ## Dataset Preprocess 49 | 50 | ```bash 51 | python data/preprocess.py --dataset=[avazu/criteo] --data_path=[default is data/] 52 | ``` 53 | 54 | ## Run FS & ES 55 | 56 | ### Parameters in run.py 57 | 58 | * dataset: (avazu/criteo) 59 | * model: backbone model (mlp) 60 | * fs: feature selection method (no_selecion/autofield/adafs/optfs/gbdt/lasso/gbr/pca) 61 | * seed: random seed (specific number or 0(random)) 62 | * device: cuda or cpu 63 | * data_path: your data path (default is `data/`) 64 | * batch_size 65 | * dataset_shuffle: (True or False) 66 | * embedding_dim: embedding size (default is 8) 67 | * train_or_search: need train_or_search (True/False) 68 | * retrain: need retrain (True/False) 69 | * k: number of selected fields (specific number) 70 | * learning_rate 71 | * epoch: training epoch (default 100) 72 | * patience: patience of earlystopper (default 3) 73 | * num_workers: num_workers in dataloader (default 32) 74 | * nni: whether use nni to tune hyperparameters (default False) 75 | * rank_path: if only want retrain, please specify the path of feature rank file 76 | * read_feature_rank: whether to use pre-saved feature rank 77 | 78 | ### Feature Selection 79 | 80 | ```bash 81 | python fs_run.py --model=[model_name] --fs=[feature_selection_method] --train_or_search=True --retrain=True 82 | ``` 83 | 84 | 85 | 86 | # More experimental results 87 | 88 | 1. Overall experimental results of feature selection for deep recommender systems. 89 | 90 | image-20240618142823898 91 | 92 | 2. Experimental results on more backbone models with different number of selected features on Avazu. 93 | 94 | ![image-20240618142657795](https://raw.githubusercontent.com/Jia-py/blog_picture/master/img/image-20240618142657795.png) 95 | 96 | 3. Experimental results on more backbone models with different number of selected features on Criteo. 97 | 98 | ![image-20240618142731324](https://raw.githubusercontent.com/Jia-py/blog_picture/master/img/image-20240618142731324.png) 99 | 100 | 101 | # Citation 102 | 103 | If you find our work useful, please consider citing our paper below. Thank you! 104 | ``` 105 | @inproceedings{jia2024erase, 106 | title={ERASE: Benchmarking Feature Selection Methods for Deep Recommender Systems}, 107 | author={Jia, Pengyue and Wang, Yejing and Du, Zhaocheng and Zhao, Xiangyu and Wang, Yichao and Chen, Bo and Wang, Wanyu and Guo, Huifeng and Tang, Ruiming}, 108 | booktitle={Proceedings of the 30th ACM SIGKDD Conference on Knowledge Discovery and Data Mining}, 109 | pages={5194--5205}, 110 | year={2024} 111 | } 112 | ``` 113 | -------------------------------------------------------------------------------- /data/aliccp/dataset description.md: -------------------------------------------------------------------------------- 1 | The dataset is preprocessed by Datawhale, refer to (torch-rechub)[https://github.com/datawhalechina/torch-rechub/tree/main/examples/ranking] -------------------------------------------------------------------------------- /data/avazu/dataset description.md: -------------------------------------------------------------------------------- 1 | ## Dataset Description 2 | 3 | [Click-Through Rate Prediction | Kaggle](https://www.kaggle.com/competitions/avazu-ctr-prediction/data) 4 | 5 | ## File descriptions 6 | 7 | - **train** - Training set. 10 days of click-through data, ordered chronologically. Non-clicks and clicks are subsampled according to different strategies. 8 | - **test** - Test set. 1 day of ads to for testing your model predictions. 9 | - **sampleSubmission.csv** - Sample submission file in the correct format, corresponds to the All-0.5 Benchmark. 10 | 11 | ## Data fields 12 | 13 | - id: ad identifier 14 | - click: 0/1 for non-click/click 15 | - hour: format is YYMMDDHH, so 14091123 means 23:00 on Sept. 11, 2014 UTC. 16 | - C1 -- anonymized categorical variable 17 | - banner_pos 18 | - site_id 19 | - site_domain 20 | - site_category 21 | - app_id 22 | - app_domain 23 | - app_category 24 | - device_id 25 | - device_ip 26 | - device_model 27 | - device_type 28 | - device_conn_type 29 | - C14-C21 -- anonymized categorical variables 30 | 31 | ## Notes 32 | 33 | For the test file does not contain the labels, so we just use the training file. 34 | 35 | ## read dtypes 36 | 37 | ```bash 38 | Memory usage of dataframe is 7402.76 MB 39 | Memory usage after optimization is: 1773.58 MB 40 | Decreased by 76.0% 41 | dtypes: click int8 42 | hour int16 43 | C1 int8 44 | banner_pos int8 45 | site_id int16 46 | site_domain int16 47 | site_category int8 48 | app_id int16 49 | app_domain int16 50 | app_category int8 51 | device_id int32 52 | device_ip int32 53 | device_model int16 54 | device_type int8 55 | device_conn_type int8 56 | C14 int16 57 | C15 int8 58 | C16 int8 59 | C17 int16 60 | C18 int8 61 | C19 int8 62 | C20 int16 63 | C21 int8 64 | dtype: object 65 | preprocess avazu done! 66 | ``` -------------------------------------------------------------------------------- /data/criteo/dataset description.md: -------------------------------------------------------------------------------- 1 | ------ Display Advertising Challenge ------ 2 | 3 | Dataset: dac-v1 4 | 5 | This dataset contains feature values and click feedback for millions of display 6 | ads. Its purpose is to benchmark algorithms for clickthrough rate (CTR) prediction. 7 | It has been used for the Display Advertising Challenge hosted by Kaggle: 8 | https://www.kaggle.com/c/criteo-display-ad-challenge/ 9 | 10 | =================================================== 11 | 12 | Full description: 13 | 14 | This dataset contains 2 files: 15 | train.txt 16 | test.txt 17 | corresponding to the training and test parts of the data. 18 | 19 | ==================================================== 20 | 21 | Dataset construction: 22 | 23 | The training dataset consists of a portion of Criteo's traffic over a period 24 | of 7 days. Each row corresponds to a display ad served by Criteo and the first 25 | column is indicates whether this ad has been clicked or not. 26 | The positive (clicked) and negatives (non-clicked) examples have both been 27 | subsampled (but at different rates) in order to reduce the dataset size. 28 | 29 | There are 13 features taking integer values (mostly count features) and 26 30 | categorical features. The values of the categorical features have been hashed 31 | onto 32 bits for anonymization purposes. 32 | The semantic of these features is undisclosed. Some features may have missing values. 33 | 34 | The rows are chronologically ordered. 35 | 36 | The test set is computed in the same way as the training set but it 37 | corresponds to events on the day following the training period. 38 | The first column (label) has been removed. 39 | 40 | ==================================================== 41 | 42 | Format: 43 | 44 | The columns are tab separeted with the following schema: 45 |