RecTools 0.10.0__tar.gz

rectools-0.10.0/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2022 MTS (Mobile Telesystems).  All rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 MTS (Mobile Telesystems).
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rectools-0.10.0/PKG-INFO

@@ -0,0 +1,254 @@
+Metadata-Version: 2.1
+Name: RecTools
+Version: 0.10.0
+Summary: An easy-to-use Python library for building recommendation systems
+Home-page: https://github.com/MobileTeleSystems/RecTools
+License: Apache-2.0
+Keywords: recsys,recommendation systems,machine learning,AI,personalization
+Author: Emiliy Feldman
+Author-email: feldlime@yandex.ru
+Maintainer: Emiliy Feldman
+Maintainer-email: feldlime@yandex.ru
+Requires-Python: >=3.9,<3.13
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Provides-Extra: all
+Provides-Extra: lightfm
+Provides-Extra: nmslib
+Provides-Extra: torch
+Provides-Extra: visuals
+Requires-Dist: attrs (>=19.1.0,<24.0.0)
+Requires-Dist: implicit (>=0.7.1,<0.8.0)
+Requires-Dist: ipywidgets (>=7.7,<8.2) ; extra == "visuals" or extra == "all"
+Requires-Dist: nbformat (>=4.2.0) ; extra == "visuals" or extra == "all"
+Requires-Dist: nmslib (>=2.0.4,<3.0.0) ; (python_version < "3.11") and (extra == "nmslib" or extra == "all")
+Requires-Dist: nmslib-metabrainz (>=2.1.3,<3.0.0) ; (python_version >= "3.11" and python_version < "3.13") and (extra == "nmslib" or extra == "all")
+Requires-Dist: numpy (>=1.22,<2.0.0) ; python_version < "3.12"
+Requires-Dist: numpy (>=1.26,<2.0.0) ; python_version == "3.12"
+Requires-Dist: pandas (>=1.5.0,<3.0.0)
+Requires-Dist: plotly (>=5.22.0,<6.0.0) ; extra == "visuals" or extra == "all"
+Requires-Dist: pydantic (>=2.8.2,<3.0.0)
+Requires-Dist: pydantic-core (>=2.20.1,<3.0.0)
+Requires-Dist: pytorch-lightning (>=1.6.0,<3.0.0) ; extra == "torch" or extra == "all"
+Requires-Dist: rectools-lightfm (>=1.17.3,<2.0.0) ; extra == "lightfm" or extra == "all"
+Requires-Dist: scipy (>=1.10.1,<1.13)
+Requires-Dist: torch (>=1.6.0,<2.3.0) ; (sys_platform == "darwin" and platform_machine == "x86_64") and (extra == "torch" or extra == "all")
+Requires-Dist: torch (>=1.6.0,<3.0.0) ; extra == "torch" or extra == "all"
+Requires-Dist: tqdm (>=4.27.0,<5.0.0)
+Requires-Dist: typeguard (>=4.1.0,<5.0.0)
+Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
+Project-URL: Documentation, https://rectools.readthedocs.io
+Project-URL: Repository, https://github.com/MobileTeleSystems/RecTools
+Description-Content-Type: text/markdown
+
+# RecTools
+
+[![Python versions](https://img.shields.io/pypi/pyversions/rectools.svg)](https://pypi.org/project/rectools)
+[![PyPI](https://img.shields.io/pypi/v/rectools.svg)](https://pypi.org/project/rectools)
+[![Docs](https://img.shields.io/github/actions/workflow/status/MobileTeleSystems/RecTools/publish.yml?label=docs)](https://rectools.readthedocs.io)
+
+[![License](https://img.shields.io/github/license/MobileTeleSystems/RecTools.svg)](https://github.com/MobileTeleSystems/RecTools/blob/main/LICENSE)
+[![Coverage](https://img.shields.io/codecov/c/github/MobileTeleSystems/RecTools.svg)](https://app.codecov.io/gh/MobileTeleSystems/RecTools)
+[![Tests](https://img.shields.io/github/actions/workflow/status/MobileTeleSystems/RecTools/test.yml?branch=main&label=tests)](https://github.com/MobileTeleSystems/RecTools/actions/workflows/test.yml?query=branch%3Amain++)
+
+[![Contributors](https://img.shields.io/github/contributors/MobileTeleSystems/RecTools.svg)](https://github.com/MobileTeleSystems/RecTools/graphs/contributors)
+[![Downloads](https://static.pepy.tech/badge/rectools)](https://pepy.tech/project/rectools)
+[![Telegram](https://img.shields.io/badge/channel-telegram-blue)](https://t.me/RecTools_Support)
+
+<p align="center">
+  <a href="https://rectools.readthedocs.io/en/stable/">Documentation</a> |
+  <a href="https://github.com/MobileTeleSystems/RecTools/tree/main/examples">Examples</a> |
+    <a href="https://github.com/MobileTeleSystems/RecTools/tree/main/examples/tutorials">Tutorials</a> |
+  <a href="https://github.com/MobileTeleSystems/RecTools/blob/main/CONTRIBUTING.rst">Contributing</a> |
+  <a href="https://github.com/MobileTeleSystems/RecTools/releases">Releases</a> |
+  <a href="https://github.com/orgs/MobileTeleSystems/projects/1">Developers Board</a>
+</p>
+
+RecTools is an easy-to-use Python library which makes the process of building recommendation systems easier, 
+faster and more structured than ever before.
+It includes built-in toolkits for data processing and metrics calculation, 
+a variety of recommender models, some wrappers for already existing implementations of popular algorithms 
+and model selection framework.
+The aim is to collect ready-to-use solutions and best practices in one place to make processes 
+of creating your first MVP and deploying model to production as fast and easy as possible.
+
+
+
+## Get started
+
+Prepare data with
+
+```shell
+wget https://files.grouplens.org/datasets/movielens/ml-1m.zip
+unzip ml-1m.zip
+```
+
+```python
+import pandas as pd
+from implicit.nearest_neighbours import TFIDFRecommender
+    
+from rectools import Columns
+from rectools.dataset import Dataset
+from rectools.models import ImplicitItemKNNWrapperModel
+
+# Read the data
+ratings = pd.read_csv(
+    "ml-1m/ratings.dat", 
+    sep="::",
+    engine="python",  # Because of 2-chars separators
+    header=None,
+    names=[Columns.User, Columns.Item, Columns.Weight, Columns.Datetime],
+)
+    
+# Create dataset
+dataset = Dataset.construct(ratings)
+    
+# Fit model
+model = ImplicitItemKNNWrapperModel(TFIDFRecommender(K=10))
+model.fit(dataset)
+
+# Make recommendations
+recos = model.recommend(
+    users=ratings[Columns.User].unique(),
+    dataset=dataset,
+    k=10,
+    filter_viewed=True,
+)
+```
+
+## Installation
+
+RecTools is on PyPI, so you can use `pip` to install it.
+```
+pip install rectools
+```
+The default version doesn't contain all the dependencies, because some of them are needed only for specific functionality. Available user extensions are the following:
+
+- `lightfm`: adds wrapper for LightFM model,
+- `torch`: adds models based on neural nets,
+- `visuals`: adds visualization tools,
+- `nmslib`: adds fast ANN recommenders.
+
+Install extension:
+```
+pip install rectools[extension-name]
+```
+
+Install all extensions:
+```
+pip install rectools[all]
+```
+
+
+## Recommender Models
+The table below lists recommender models that are available in RecTools.  
+See [recommender baselines extended tutorial](https://github.com/MobileTeleSystems/RecTools/blob/main/examples/tutorials/baselines_extended_tutorial.ipynb) for deep dive into theory & practice of our supported models.
+
+| Model | Type | Description (🎏 for user/item features, 🔆 for warm inference, ❄️ for cold inference support) | Tutorials & Benchmarks |
+|----|----|---------|--------|
+| [implicit](https://github.com/benfred/implicit) ALS Wrapper | Matrix Factorization | `rectools.models.ImplicitALSWrapperModel` - Alternating Least Squares Matrix Factorizattion algorithm for implicit feedback. <br>🎏| 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#Implicit-ALS)<br> 🚀 [50% boost to metrics with user & item features](examples/5_benchmark_iALS_with_features.ipynb) |
+| [implicit](https://github.com/benfred/implicit) BPR-MF Wrapper | Matrix Factorization | `rectools.models.ImplicitBPRWrapperModel` - Bayesian Personalized Ranking Matrix Factorization algorithm. | 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#Bayesian-Personalized-Ranking-Matrix-Factorization-(BPR-MF)) |
+| [implicit](https://github.com/benfred/implicit) ItemKNN Wrapper | Nearest Neighbours | `rectools.models.ImplicitItemKNNWrapperModel` - Algorithm that calculates item-item similarity matrix using distances between item vectors in user-item interactions matrix | 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#ItemKNN) |
+| [LightFM](https://github.com/lyst/lightfm) Wrapper | Matrix Factorization | `rectools.models.LightFMWrapperModel` - Hybrid matrix factorization algorithm which utilises user and item features and supports a variety of losses.<br>🎏 🔆 ❄️| 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#LightFM)<br>🚀 [10-25 times faster inference with RecTools](examples/6_benchmark_lightfm_inference.ipynb)|
+| EASE | Linear Autoencoder | `rectools.models.EASEModel` - Embarassingly Shallow Autoencoders implementation that explicitly calculates dense item-item similarity matrix | 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#EASE) |
+| PureSVD | Matrix Factorization | `rectools.models.PureSVDModel` - Truncated Singular Value Decomposition of user-item interactions matrix | 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#PureSVD) |
+| DSSM | Neural Network | `rectools.models.DSSMModel` - Two-tower Neural model that learns user and item embeddings utilising their explicit features and learning on triplet loss.<br>🎏 🔆 | - |
+| Popular | Heuristic | `rectools.models.PopularModel` - Classic baseline which computes popularity of items and also accepts params like time window and type of popularity computation.<br>❄️| - |
+| Popular in Category | Heuristic |  `rectools.models.PopularInCategoryModel` - Model that computes poularity within category and applies mixing strategy to increase Diversity.<br>❄️| - |
+| Random |  Heuristic | `rectools.models.RandomModel` - Simple random algorithm useful to benchmark Novelty, Coverage, etc.<br>❄️| - |
+
+- All of the models follow the same interface. **No exceptions**
+- No need for manual creation of sparse matrixes or mapping ids. Preparing data for models is as simple as `dataset = Dataset.construct(interactions_df)`
+- Fitting any model is as simple as `model.fit(dataset)`
+- For getting recommendations `filter_viewed` and `items_to_recommend` options are available
+- For item-to-item recommendations use `recommend_to_items` method
+- For feeding user/item features to model just specify dataframes when constructing `Dataset`. [Check our tutorial](examples/4_dataset_with_features.ipynb)
+- For warm / cold inference just provide all required ids in `users` or `target_items` parameters of `recommend` or `recommend_to_items` methods and make sure you have features in the dataset for warm users/items. **Nothing else is needed, everything works out of the box.**
+
+
+## Extended validation tools
+
+### `DebiasConfig` for debiased metrics calculation
+
+[User guide](https://github.com/MobileTeleSystems/RecTools/blob/main/examples/8_debiased_metrics.ipynb) | [Documentation](https://rectools.readthedocs.io/en/stable/api/rectools.metrics.debias.DebiasConfig.html)
+
+### `VisualApp` for model recommendations comparison
+
+<img src="https://recsysart.ru/images/visual_app.gif" width=500>
+
+
+[Example](https://github.com/MobileTeleSystems/RecTools/blob/main/examples/7_visualization.ipynb) | [Demo](https://recsysart.ru/voila/) | [Documentation](https://rectools.readthedocs.io/en/stable/api/rectools.visuals.visual_app.VisualApp.html)
+
+
+
+### `MetricsApp` for metrics trade-off analysis
+
+
+<img src="https://recsysart.ru/images/metrics_app.gif" width=600>
+
+[Example](https://github.com/MobileTeleSystems/RecTools/blob/main/examples/2_cross_validation.ipynb) |
+[Documentation](https://rectools.readthedocs.io/en/stable/api/rectools.visuals.metrics_app.MetricsApp.html)
+
+
+## Contribution
+[Contributing guide](CONTRIBUTING.rst)
+
+To install all requirements
+- you must have `python3` and `poetry` installed
+- make sure you have no active virtual environments (deactivate conda `base` if applicable)
+- run
+```
+make install
+```
+
+
+For autoformatting run 
+```
+make format
+```
+
+For linters check run 
+```
+make lint
+```
+
+For tests run 
+```
+make test
+```
+
+For coverage run 
+```
+make coverage
+```
+
+To remove virtual environment run
+```
+make clean
+```
+
+## RecTools Team
+
+- [Emiliy Feldman](https://github.com/feldlime) [Maintainer]
+- [Daria Tikhonovich](https://github.com/blondered) [Maintainer]
+- [Andrey Semenov](https://github.com/In48semenov)
+- [Mike Sokolov](https://github.com/mikesokolovv)
+- [Maya Spirina](https://github.com/spirinamayya)
+- [Grigoriy Gusarov](https://github.com/Gooogr)
+- [Aki Ariga](https://github.com/chezou)
+
+Previous contributors: [Ildar Safilo](https://github.com/irsafilo) [ex-Maintainer], [Daniil Potapov](https://github.com/sharthZ23) [ex-Maintainer], [Alexander Butenko](https://github.com/iomallach), [Igor Belkov](https://github.com/OzmundSedler), [Artem Senin](https://github.com/artemseninhse), [Mikhail Khasykov](https://github.com/mkhasykov), [Julia Karamnova](https://github.com/JuliaKup), [Maxim Lukin](https://github.com/groundmax), [Yuri Ulianov](https://github.com/yukeeul), [Egor Kratkov](https://github.com/jegorus), [Azat Sibagatulin](https://github.com/azatnv), [Vadim Vetrov](https://github.com/Waujito)
+
+

rectools-0.10.0/README.md

@@ -0,0 +1,198 @@
+# RecTools
+
+[![Python versions](https://img.shields.io/pypi/pyversions/rectools.svg)](https://pypi.org/project/rectools)
+[![PyPI](https://img.shields.io/pypi/v/rectools.svg)](https://pypi.org/project/rectools)
+[![Docs](https://img.shields.io/github/actions/workflow/status/MobileTeleSystems/RecTools/publish.yml?label=docs)](https://rectools.readthedocs.io)
+
+[![License](https://img.shields.io/github/license/MobileTeleSystems/RecTools.svg)](https://github.com/MobileTeleSystems/RecTools/blob/main/LICENSE)
+[![Coverage](https://img.shields.io/codecov/c/github/MobileTeleSystems/RecTools.svg)](https://app.codecov.io/gh/MobileTeleSystems/RecTools)
+[![Tests](https://img.shields.io/github/actions/workflow/status/MobileTeleSystems/RecTools/test.yml?branch=main&label=tests)](https://github.com/MobileTeleSystems/RecTools/actions/workflows/test.yml?query=branch%3Amain++)
+
+[![Contributors](https://img.shields.io/github/contributors/MobileTeleSystems/RecTools.svg)](https://github.com/MobileTeleSystems/RecTools/graphs/contributors)
+[![Downloads](https://static.pepy.tech/badge/rectools)](https://pepy.tech/project/rectools)
+[![Telegram](https://img.shields.io/badge/channel-telegram-blue)](https://t.me/RecTools_Support)
+
+<p align="center">
+  <a href="https://rectools.readthedocs.io/en/stable/">Documentation</a> |
+  <a href="https://github.com/MobileTeleSystems/RecTools/tree/main/examples">Examples</a> |
+    <a href="https://github.com/MobileTeleSystems/RecTools/tree/main/examples/tutorials">Tutorials</a> |
+  <a href="https://github.com/MobileTeleSystems/RecTools/blob/main/CONTRIBUTING.rst">Contributing</a> |
+  <a href="https://github.com/MobileTeleSystems/RecTools/releases">Releases</a> |
+  <a href="https://github.com/orgs/MobileTeleSystems/projects/1">Developers Board</a>
+</p>
+
+RecTools is an easy-to-use Python library which makes the process of building recommendation systems easier, 
+faster and more structured than ever before.
+It includes built-in toolkits for data processing and metrics calculation, 
+a variety of recommender models, some wrappers for already existing implementations of popular algorithms 
+and model selection framework.
+The aim is to collect ready-to-use solutions and best practices in one place to make processes 
+of creating your first MVP and deploying model to production as fast and easy as possible.
+
+
+
+## Get started
+
+Prepare data with
+
+```shell
+wget https://files.grouplens.org/datasets/movielens/ml-1m.zip
+unzip ml-1m.zip
+```
+
+```python
+import pandas as pd
+from implicit.nearest_neighbours import TFIDFRecommender
+    
+from rectools import Columns
+from rectools.dataset import Dataset
+from rectools.models import ImplicitItemKNNWrapperModel
+
+# Read the data
+ratings = pd.read_csv(
+    "ml-1m/ratings.dat", 
+    sep="::",
+    engine="python",  # Because of 2-chars separators
+    header=None,
+    names=[Columns.User, Columns.Item, Columns.Weight, Columns.Datetime],
+)
+    
+# Create dataset
+dataset = Dataset.construct(ratings)
+    
+# Fit model
+model = ImplicitItemKNNWrapperModel(TFIDFRecommender(K=10))
+model.fit(dataset)
+
+# Make recommendations
+recos = model.recommend(
+    users=ratings[Columns.User].unique(),
+    dataset=dataset,
+    k=10,
+    filter_viewed=True,
+)
+```
+
+## Installation
+
+RecTools is on PyPI, so you can use `pip` to install it.
+```
+pip install rectools
+```
+The default version doesn't contain all the dependencies, because some of them are needed only for specific functionality. Available user extensions are the following:
+
+- `lightfm`: adds wrapper for LightFM model,
+- `torch`: adds models based on neural nets,
+- `visuals`: adds visualization tools,
+- `nmslib`: adds fast ANN recommenders.
+
+Install extension:
+```
+pip install rectools[extension-name]
+```
+
+Install all extensions:
+```
+pip install rectools[all]
+```
+
+
+## Recommender Models
+The table below lists recommender models that are available in RecTools.  
+See [recommender baselines extended tutorial](https://github.com/MobileTeleSystems/RecTools/blob/main/examples/tutorials/baselines_extended_tutorial.ipynb) for deep dive into theory & practice of our supported models.
+
+| Model | Type | Description (🎏 for user/item features, 🔆 for warm inference, ❄️ for cold inference support) | Tutorials & Benchmarks |
+|----|----|---------|--------|
+| [implicit](https://github.com/benfred/implicit) ALS Wrapper | Matrix Factorization | `rectools.models.ImplicitALSWrapperModel` - Alternating Least Squares Matrix Factorizattion algorithm for implicit feedback. <br>🎏| 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#Implicit-ALS)<br> 🚀 [50% boost to metrics with user & item features](examples/5_benchmark_iALS_with_features.ipynb) |
+| [implicit](https://github.com/benfred/implicit) BPR-MF Wrapper | Matrix Factorization | `rectools.models.ImplicitBPRWrapperModel` - Bayesian Personalized Ranking Matrix Factorization algorithm. | 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#Bayesian-Personalized-Ranking-Matrix-Factorization-(BPR-MF)) |
+| [implicit](https://github.com/benfred/implicit) ItemKNN Wrapper | Nearest Neighbours | `rectools.models.ImplicitItemKNNWrapperModel` - Algorithm that calculates item-item similarity matrix using distances between item vectors in user-item interactions matrix | 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#ItemKNN) |
+| [LightFM](https://github.com/lyst/lightfm) Wrapper | Matrix Factorization | `rectools.models.LightFMWrapperModel` - Hybrid matrix factorization algorithm which utilises user and item features and supports a variety of losses.<br>🎏 🔆 ❄️| 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#LightFM)<br>🚀 [10-25 times faster inference with RecTools](examples/6_benchmark_lightfm_inference.ipynb)|
+| EASE | Linear Autoencoder | `rectools.models.EASEModel` - Embarassingly Shallow Autoencoders implementation that explicitly calculates dense item-item similarity matrix | 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#EASE) |
+| PureSVD | Matrix Factorization | `rectools.models.PureSVDModel` - Truncated Singular Value Decomposition of user-item interactions matrix | 📙 [Theory & Practice](https://rectools.readthedocs.io/en/latest/examples/tutorials/baselines_extended_tutorial.html#PureSVD) |
+| DSSM | Neural Network | `rectools.models.DSSMModel` - Two-tower Neural model that learns user and item embeddings utilising their explicit features and learning on triplet loss.<br>🎏 🔆 | - |
+| Popular | Heuristic | `rectools.models.PopularModel` - Classic baseline which computes popularity of items and also accepts params like time window and type of popularity computation.<br>❄️| - |
+| Popular in Category | Heuristic |  `rectools.models.PopularInCategoryModel` - Model that computes poularity within category and applies mixing strategy to increase Diversity.<br>❄️| - |
+| Random |  Heuristic | `rectools.models.RandomModel` - Simple random algorithm useful to benchmark Novelty, Coverage, etc.<br>❄️| - |
+
+- All of the models follow the same interface. **No exceptions**
+- No need for manual creation of sparse matrixes or mapping ids. Preparing data for models is as simple as `dataset = Dataset.construct(interactions_df)`
+- Fitting any model is as simple as `model.fit(dataset)`
+- For getting recommendations `filter_viewed` and `items_to_recommend` options are available
+- For item-to-item recommendations use `recommend_to_items` method
+- For feeding user/item features to model just specify dataframes when constructing `Dataset`. [Check our tutorial](examples/4_dataset_with_features.ipynb)
+- For warm / cold inference just provide all required ids in `users` or `target_items` parameters of `recommend` or `recommend_to_items` methods and make sure you have features in the dataset for warm users/items. **Nothing else is needed, everything works out of the box.**
+
+
+## Extended validation tools
+
+### `DebiasConfig` for debiased metrics calculation
+
+[User guide](https://github.com/MobileTeleSystems/RecTools/blob/main/examples/8_debiased_metrics.ipynb) | [Documentation](https://rectools.readthedocs.io/en/stable/api/rectools.metrics.debias.DebiasConfig.html)
+
+### `VisualApp` for model recommendations comparison
+
+<img src="https://recsysart.ru/images/visual_app.gif" width=500>
+
+
+[Example](https://github.com/MobileTeleSystems/RecTools/blob/main/examples/7_visualization.ipynb) | [Demo](https://recsysart.ru/voila/) | [Documentation](https://rectools.readthedocs.io/en/stable/api/rectools.visuals.visual_app.VisualApp.html)
+
+
+
+### `MetricsApp` for metrics trade-off analysis
+
+
+<img src="https://recsysart.ru/images/metrics_app.gif" width=600>
+
+[Example](https://github.com/MobileTeleSystems/RecTools/blob/main/examples/2_cross_validation.ipynb) |
+[Documentation](https://rectools.readthedocs.io/en/stable/api/rectools.visuals.metrics_app.MetricsApp.html)
+
+
+## Contribution
+[Contributing guide](CONTRIBUTING.rst)
+
+To install all requirements
+- you must have `python3` and `poetry` installed
+- make sure you have no active virtual environments (deactivate conda `base` if applicable)
+- run
+```
+make install
+```
+
+
+For autoformatting run 
+```
+make format
+```
+
+For linters check run 
+```
+make lint
+```
+
+For tests run 
+```
+make test
+```
+
+For coverage run 
+```
+make coverage
+```
+
+To remove virtual environment run
+```
+make clean
+```
+
+## RecTools Team
+
+- [Emiliy Feldman](https://github.com/feldlime) [Maintainer]
+- [Daria Tikhonovich](https://github.com/blondered) [Maintainer]
+- [Andrey Semenov](https://github.com/In48semenov)
+- [Mike Sokolov](https://github.com/mikesokolovv)
+- [Maya Spirina](https://github.com/spirinamayya)
+- [Grigoriy Gusarov](https://github.com/Gooogr)
+- [Aki Ariga](https://github.com/chezou)
+
+Previous contributors: [Ildar Safilo](https://github.com/irsafilo) [ex-Maintainer], [Daniil Potapov](https://github.com/sharthZ23) [ex-Maintainer], [Alexander Butenko](https://github.com/iomallach), [Igor Belkov](https://github.com/OzmundSedler), [Artem Senin](https://github.com/artemseninhse), [Mikhail Khasykov](https://github.com/mkhasykov), [Julia Karamnova](https://github.com/JuliaKup), [Maxim Lukin](https://github.com/groundmax), [Yuri Ulianov](https://github.com/yukeeul), [Egor Kratkov](https://github.com/jegorus), [Azat Sibagatulin](https://github.com/azatnv), [Vadim Vetrov](https://github.com/Waujito)
+