Updated readme, docs and examples

README.md

@@ -151,13 +151,13 @@ To remove virtual environment run
 make clean
 ```
 
-## RecTools.Team
+## RecTools Team
 
-- [Emiliy Feldman](https://github.com/feldlime)
-- [Ildar Safilo](https://github.com/irsafilo)
-- [Daniil Potapov](https://github.com/sharthZ23) 
-- [Igor Belkov](https://github.com/OzmundSedler)
-- [Artem Senin](https://github.com/artemseninhse)
+- [Emiliy Feldman](https://github.com/feldlime) [Maintainer]
+- [Daria Tikhonovich](https://github.com/blondered) [Maintainer]
 - [Alexander Butenko](https://github.com/iomallach)
-- [Mikhail Khasykov](https://github.com/mkhasykov)
-- [Daria Tikhonovich](https://github.com/blondered)
+- [Andrey Semenov](https://github.com/In48semenov)
+- [Mike Sokolov](https://github.com/mikesokolovv)
+
+Previous contributors: [Ildar Safilo](https://github.com/irsafilo) [ex-Maintainer], [Daniil Potapov](https://github.com/sharthZ23) [ex-Maintainer], [Igor Belkov](https://github.com/OzmundSedler), [Artem Senin](https://github.com/artemseninhse), [Mikhail Khasykov](https://github.com/mkhasykov)
+

examples/4_dataset_with_features.ipynb

@@ -13,22 +13,24 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 26,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
     "import os\n",
+    "import threadpoolctl\n",
     "\n",
     "import numpy as np\n",
     "import pandas as pd\n",
-    "\n",
     "from implicit.als import AlternatingLeastSquares\n",
     "\n",
     "from rectools import Columns\n",
     "from rectools.dataset import Dataset\n",
     "from rectools.models import ImplicitALSWrapperModel\n",
     "\n",
-    "os.environ[\"OPENBLAS_NUM_THREADS\"] = \"1\"  # For implicit ALS"
+    "# For implicit ALS\n",
+    "os.environ[\"OPENBLAS_NUM_THREADS\"] = \"1\"\n",
+    "threadpoolctl.threadpool_limits(1, \"blas\")"
    ]
   },
   {
@@ -794,9 +796,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "rect",
+   "display_name": ".venv",
    "language": "python",
-   "name": "rect"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -808,7 +810,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.10"
+   "version": "3.9.12"
   },
   "toc": {
    "base_numbering": 1,

examples/5_benchmark_iALS_with_features.ipynb

@@ -24,6 +24,7 @@
    "outputs": [],
    "source": [
     "import os\n",
+    "import threadpoolctl\n",
     "import warnings\n",
     "from pathlib import Path\n",
     "\n",
@@ -39,8 +40,11 @@
     "from implicit.als import AlternatingLeastSquares\n",
     "\n",
     "warnings.filterwarnings('ignore')\n",
-    "os.environ[\"OPENBLAS_NUM_THREADS\"] = \"1\"  # For implicit ALS\n",
-    "sns.set_theme(style=\"whitegrid\")"
+    "sns.set_theme(style=\"whitegrid\")\n",
+    "\n",
+    "# For implicit ALS\n",
+    "os.environ[\"OPENBLAS_NUM_THREADS\"] = \"1\"\n",
+    "threadpoolctl.threadpool_limits(1, \"blas\")"
    ]
   },
   {
@@ -1273,7 +1277,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.10"
+   "version": "3.9.12"
   }
  },
  "nbformat": 4,

pyproject.toml

@@ -4,18 +4,18 @@ version = "0.4.2"
 description = "An easy-to-use Python library for building recommendation systems"
 license = "Apache-2.0"
 authors = [
+    "Emiliy Feldman <feldlime@yandex.ru",
+    "Daria Tikhonovich <daria.m.tikhonovich@gmail.com>",
     "Daniil Potapov <sharth23@gmail.com>",
     "Ildar Safilo <irsafilo@gmail.com>",
-    "Emiliy Feldman <feldlime@yandex.ru",
     "Alexander Butenko <a.butenko.o@gmail.com>",
     "Julia Karamnova <juliakaramnova@yandex.ru>",
     "Artem Senin <artemseninhse@gmail.com>",
     "Mikhail Khasykov <mkhasykov@gmail.com>",
-    "Daria Tikhonovich <daria.m.tikhonovich@gmail.com>",
+    "Mike Sokolov <mikesokolovv@gmail.com>",
+    "Andrey Semenov <in48semenov@yandex.ru>",
 ]
 maintainers = [
-    "Daniil Potapov <sharth23@gmail.com>",
-    "Ildar Safilo <irsafilo@gmail.com>",
     "Emiliy Feldman <feldlime@yandex.ru",
     "Daria Tikhonovich <daria.m.tikhonovich@gmail.com>",
 ]

rectools/metrics/novelty.py

@@ -52,7 +52,7 @@ class MeanInvUserFreq(MetricAtK):
     to the number of users who interacted with it.
 
     .. math::
-        MIUF@k = -(\sum_{i=1}^{k+1} \log_{2} (users(i) / n\_users)) / k
+        MIUF@k = -(\sum_{i=1}^{k} \log_{2} (users(i) / n\_users)) / k
 
     where
     - `users(i)` is number of users that previously interacted with item with rank `i`.

rectools/metrics/serendipity.py

@@ -51,7 +51,7 @@ class Serendipity(MetricAtK):
     Evaluates novelty and relevance together.
 
     .. math::
-        Serendipity@k = (\sum_{i=1}^{k+1} max(p(i) - pu(i), 0) * rel(i)) / k
+        Serendipity@k = (\sum_{i=1}^{k} max(p(i) - pu(i), 0) * rel(i)) / k
 
     where
         - :math:`p(i) = (n\_items + 1 - i) / n\_items`