Support Python 3.13 (#227)

chezou · web-flow · commit c003b6c5db21 · 2025-05-02T23:24:23.000+01:00
Support Python 3.13, including: - [x] torch - [x] cupy - [x] lightfm - [x] pytorch_lightning excluding: - nmslib metabrainz/nmslib-metabrainz#5 - nmslib-metabrainz only supports until Python 3.12.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -21,7 +21,7 @@ jobs:
           python-version: "3.10"
 
       - name: Install poetry
-        run: pip install urllib3==1.26.15 poetry==1.8.3
+        run: pip install urllib3==1.26.15 poetry==1.8.5
 
       - name: Load cached venv
         id: cached-poetry-dependencies
@@ -43,7 +43,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
 
     steps:
       - uses: actions/checkout@v4
@@ -54,7 +54,7 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install poetry
-        run: pip install urllib3==1.26.15 poetry==1.4.0
+        run: pip install urllib3==1.26.15 poetry==1.8.5
 
       - name: Load cached venv
         id: cached-poetry-dependencies
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -7,19 +7,15 @@ build:
   jobs:
     pre_build:
       - cp -r examples docs/source/
+    post_create_environment:
+      - pip install poetry
     post_install:
-      - pip install --no-cache-dir poetry==1.8.5
-      - poetry export -f requirements.txt -o requirements.txt -E all --without-hashes
-      - pip install --no-cache-dir -r requirements.txt
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install -E all --no-root --with docs
 
 sphinx:
   builder: html
   configuration: docs/source/conf.py
   fail_on_warning: false
 
-python:
-   install:
-   - requirements: docs/requirements.txt
-
 formats:
   - pdf
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+### Added
+
+- Python 3.13 support ([#227](https://github.com/MobileTeleSystems/RecTools/pull/227))
+
 ## [0.13.0] - 10.04.2025
 
 ### Added 
diff --git a/Makefile b/Makefile
@@ -61,7 +61,7 @@ install: .venv .reports
 	poetry run pytest ${TESTS} --cov=${SOURCES} --cov-report=xml
 
 .doctest:
-	poetry run pytest --doctest-modules ${SOURCES} --ignore=rectools/models/lightfm.py
+	poetry run pytest --doctest-modules ${SOURCES} --ignore=rectools/tools/ann.py
 
 coverage: .venv .reports
 	poetry run coverage run --source ${SOURCES} --module pytest
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -38,6 +38,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Intended Audience :: Science/Research",
@@ -52,13 +53,20 @@ packages = [
 
 
 [tool.poetry.dependencies]
-python = ">=3.9, <3.13"
+python = ">=3.9, <3.14"
 numpy = [
     {version = ">=1.22, <2.0.0", python = "<3.12"},
-    {version = ">=1.26, <2.0.0", python = "3.12"}  # numpy <1.26 fails to install on Python 3.12
+    {version = ">=1.26, <2.0.0", python = "3.12"},  # numpy <1.26 fails to install on Python 3.12
+    {version = ">=2.1.0, <3.0.0", python = ">=3.13"}  # numpy <2.1 fails to install on Python 3.13
+]
+pandas = [
+    {version = ">=1.5.0, <3.0.0", python = "<3.13"},
+    {version = ">=2.2.3, <3.0.0", python = ">=3.13"}  # pandas <2.2.3 fails to install on Python 3.13
+]
+scipy = [
+    {version = "^1.10.1, <1.13", python = "<3.10"},  # there is a bug in 1.13* https://github.com/scipy/scipy/issues/20670
+    {version = ">=1.14.1, <2.0.0", python = ">=3.10"}  # scipy >=1.14.1 fails to install on Python 3.9
 ]
-pandas = ">=1.5.0, <3.0.0"
-scipy = "^1.10.1, <1.13"  # in 1.13 were introduced significant changes breaking our logic
 tqdm = "^4.27.0"
 implicit = "^0.7.1"
 attrs = ">=19.1.0,<24.0.0"
@@ -76,16 +84,27 @@ nmslib-metabrainz = {version = "^2.1.3", python = ">=3.11, <3.13", optional = tr
 
 # The latest torch version available for MacOSX + x86_64 is 2.2.2
 torch = [
-    {version = ">=1.6.0, <2.3.0", markers = "sys_platform == 'darwin' and platform_machine == 'x86_64'", optional = true},
-    {version = ">=1.6.0, <3.0.0", optional = true}
+    {version = ">=1.6.0, <2.3.0", python = "<3.13", markers = "sys_platform == 'darwin' and platform_machine == 'x86_64'", optional = true},
+    {version = ">=1.6.0, <3.0.0", python = "<3.13", optional = true},
+    {version = ">=2.6.0, <3.0.0", python = ">=3.13", optional = true},
+]
+pytorch-lightning = [
+    {version = ">=1.6.0, <3.0.0", python = "<3.13", optional = true},
+    {version = ">=2.5.1, <3.0.0", python = ">=3.13", optional = true},
 ]
-pytorch-lightning = {version = ">=1.6.0, <3.0.0", optional = true}
 
 ipywidgets = {version = ">=7.7,<8.2", optional = true}
 plotly = {version="^5.22.0", optional = true}
 nbformat = {version = ">=4.2.0", optional = true}
-cupy-cuda12x = {version = "^13.3.0", python = "<3.13", optional = true}
-
+cupy-cuda12x = [
+    {version = "^13.3.0", python = "<3.13", optional = true},
+    {version = "^13.4.0", python = ">=3.13", optional = true},
+]
+# This is a dependency of cupy-cuda12x
+# poetry can't resolve appropriate version of fastrlock for Python 3.13
+# and cupy-cuda12x, so we add the version restriction here manually to avoid
+# installing older version of fastrlock which is incompatible with Python 3.13
+fastrlock = {version = "^0.8.3", optional = true}
 
 [tool.poetry.extras]
 lightfm = ["rectools-lightfm"]
@@ -103,13 +122,13 @@ all = [
 
 
 [tool.poetry.group.dev.dependencies]
-black = "24.4.2"
+black = "24.10.0"
 isort = "5.13.2"
 pylint = "3.1.0"
 mypy = "1.13.0"
 flake8 = "7.0.0"
 bandit = "1.7.8"
-pytest = "8.1.1"
+pytest = "8.3.3"
 radon = "6.0.1"
 coverage = "7.5.0"
 autopep8 = "2.1.0"
@@ -122,10 +141,17 @@ pytest-mock = "3.14.0"
 click = "8.1.7"
 gitpython = "3.1.43"
 
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+sphinx = "5.1.1"
+nbsphinx = "0.8.9"
+sphinx-rtd-theme = "1.0.0"
 
 [tool.black]
 line-length = 120
-target-version = ["py39", "py310", "py311", "py312"]
+target-version = ["py39", "py310", "py311", "py312", "py313"]
 
 
 [build-system]
diff --git a/rectools/metrics/scoring.py b/rectools/metrics/scoring.py
@@ -220,4 +220,4 @@ def calc_metrics(  # noqa  # pylint: disable=too-many-branches,too-many-locals,t
     if len(results) < expected_results_len:
         warnings.warn("Custom metrics are not supported.")
 
-    return results
+    return {k: v.item() if hasattr(v, "item") else v for k, v in results.items()}
diff --git a/rectools/models/nn/item_net.py b/rectools/models/nn/item_net.py
@@ -486,4 +486,4 @@ def forward(self, items: torch.Tensor) -> torch.Tensor:
     @property
     def out_dim(self) -> int:
         """Return item net constructor output dimension."""
-        return self.item_net_blocks[0].out_dim
+        return self.item_net_blocks[0].out_dim  # type: ignore[return-value]
diff --git a/rectools/models/nn/transformers/lightning.py b/rectools/models/nn/transformers/lightning.py
@@ -193,7 +193,7 @@ def _calc_bce_loss(cls, logits: torch.Tensor, y: torch.Tensor, w: torch.Tensor)
         return loss
 
     def _calc_gbce_loss(self, logits: torch.Tensor, y: torch.Tensor, w: torch.Tensor) -> torch.Tensor:
-        n_actual_items = self.torch_model.item_model.n_items - len(self.item_extra_tokens)
+        n_actual_items = tp.cast(int, self.torch_model.item_model.n_items) - len(self.item_extra_tokens)
         logits = self._get_reduced_overconfidence_logits(logits, n_actual_items)
         loss = self._calc_bce_loss(logits, y, w)
         return loss
diff --git a/tests/models/nn/test_dssm.py b/tests/models/nn/test_dssm.py
@@ -17,6 +17,7 @@
 import numpy as np
 import pandas as pd
 import pytest
+import pytorch_lightning  # noqa  # pylint: disable=unused-import
 from lightning_fabric import seed_everything
 
 from rectools.columns import Columns
@@ -29,8 +30,12 @@
 
 from ..data import INTERACTIONS
 
+filter_warnings_decorator = pytest.mark.filterwarnings(
+    "ignore::pytorch_lightning.utilities.warnings.PossibleUserWarning"
+)
 
-@pytest.mark.filterwarnings("ignore::pytorch_lightning.utilities.warnings.PossibleUserWarning")
+
+@filter_warnings_decorator
 @pytest.mark.filterwarnings("ignore::UserWarning")
 class TestDSSMModel:
     def setup_method(self) -> None:
diff --git a/tests/models/test_implicit_knn.py b/tests/models/test_implicit_knn.py
@@ -136,7 +136,7 @@ def test_with_whitelist(self, dataset: Dataset, filter_viewed: bool, expected: p
                 pd.DataFrame(
                     {
                         Columns.TargetItem: [11, 11, 12, 12],
-                        Columns.Item: [12, 15, 11, 14],
+                        Columns.Item: [12, 14, 11, 14],
                         Columns.Rank: [1, 2, 1, 2],
                     }
                 ),
@@ -154,10 +154,32 @@ def test_with_whitelist(self, dataset: Dataset, filter_viewed: bool, expected: p
             ),
         ),
     )
-    def test_i2i(
-        self, dataset: Dataset, filter_itself: bool, whitelist: tp.Optional[np.ndarray], expected: pd.DataFrame
-    ) -> None:
+    def test_i2i(self, filter_itself: bool, whitelist: tp.Optional[np.ndarray], expected: pd.DataFrame) -> None:
         base_model = TFIDFRecommender(K=5, num_threads=2)
+        # Recreate dataset to prevent same co-occurrence count between (11, 14) and (11, 15)
+        # which leads to different results in the test in Python 3.13
+        # This is because numpy.argpartition behavior was changed.
+        # See also: https://github.com/MobileTeleSystems/RecTools/pull/227#discussion_r1941872699
+        interactions = pd.DataFrame(
+            [
+                [10, 11],
+                [10, 12],
+                [10, 14],
+                [20, 11],
+                [20, 12],
+                [20, 13],
+                [30, 11],
+                [30, 12],
+                [30, 14],
+                [40, 11],
+                [40, 15],
+                [40, 17],
+            ],
+            columns=Columns.UserItem,
+        )
+        interactions[Columns.Weight] = 1
+        interactions[Columns.Datetime] = "2021-09-09"
+        dataset = Dataset.construct(interactions)
         model = ImplicitItemKNNWrapperModel(model=base_model).fit(dataset)
         actual = model.recommend_to_items(
             target_items=np.array([11, 12]),
diff --git a/tests/models/test_pure_svd.py b/tests/models/test_pure_svd.py
@@ -363,8 +363,8 @@ def test_from_config(self, mocker: MockerFixture, use_gpu: bool) -> None:
     def test_get_config(
         self, mocker: MockerFixture, random_state: tp.Optional[int], simple_types: bool, use_gpu: bool
     ) -> None:
-        mocker.patch("rectools.models.pure_svd.cp.cuda.is_available", return_value=True)
         mocker.patch("rectools.models.pure_svd.cp", return_value=True)
+        mocker.patch("rectools.models.pure_svd.cp.cuda.is_available", return_value=True)
         model = PureSVDModel(
             factors=100,
             tol=1.0,
diff --git a/tests/tools/test_ann.py b/tests/tools/test_ann.py
@@ -13,14 +13,22 @@
 #  limitations under the License.
 
 import pickle
+import sys
 from collections.abc import Hashable
 from typing import Callable, Dict, List, Union
 
 import numpy as np
 import pytest
 
 from rectools.dataset import IdMap
-from rectools.tools import ItemToItemAnnRecommender, UserToItemAnnRecommender
+
+try:
+    from rectools.tools import ItemToItemAnnRecommender, UserToItemAnnRecommender
+except ImportError:
+    pass
+
+
+pytestmark = pytest.mark.skipif(sys.version_info >= (3, 13), reason="`nsmlib` is not compatible with Python >= 3.13")
 
 
 class TestItemToItemAnnRecommender:
