Upgrade to Python 3.11 (#139)

* Upgrade to Python 3.11

Signed-off-by: Fabrice Normandin <[email protected]>

* Remove block for Orion in python>=3.11

Signed-off-by: Fabrice Normandin <[email protected]>

* Upgrade torch-jax-interop and jax deps

Signed-off-by: Fabrice Normandin <[email protected]>

* Fix pre-commit issue with py311

Signed-off-by: Fabrice Normandin <[email protected]>

* Loosen jax requirement, fix small jax-related bugs

Signed-off-by: Fabrice Normandin <[email protected]>

* Update mkdocs.yml following mkdocs change

Signed-off-by: Fabrice Normandin <[email protected]>

* Fix jax extra version in templated pyproject.toml

Signed-off-by: Fabrice Normandin <[email protected]>

* Upgrade tensor_regression to fix bug in rl test

Signed-off-by: Fabrice Normandin <[email protected]>

* Fix bug in jax_ppo_test.py

Signed-off-by: Fabrice Normandin <[email protected]>

* Fix default python version used in int. tests

Signed-off-by: Fabrice Normandin <[email protected]>

* Jaxlib isn't installed explicitly, dont remove it

Signed-off-by: Fabrice Normandin <[email protected]>

* Upgrade pytorch version, use pytorch index

Signed-off-by: Fabrice Normandin <[email protected]>

* Also upgrade pytorch in templated pyproject file

Signed-off-by: Fabrice Normandin <[email protected]>

* Make flax and tomli dependencies explicit

Signed-off-by: Fabrice Normandin <[email protected]>

---------

Signed-off-by: Fabrice Normandin <[email protected]>

Author: lebrice

.github/workflows/build.yml

@@ -60,7 +60,7 @@ jobs:
       max-parallel: 4
       matrix:
         platform: [ubuntu-latest, macos-latest]
-        python-version: ["3.10"]
+        python-version: ["3.11"]
     steps:
       - uses: actions/checkout@v4
       - name: Install the latest version of uv

.python-version

@@ -1 +1 @@
-3.10.14
+3.11

copier.yaml

@@ -255,7 +255,7 @@ _tasks:
   ## Jax-related dependencies:
   - command: uv remove rejax gymnax gymnasium xtils --no-sync
     when: "{{ run_setup and 'jax_ppo' not in examples_to_include }}"
-  - command: uv remove jax jaxlib torch-jax-interop --no-sync
+  - command: uv remove jax torch-jax-interop flax --no-sync
     when: "{{ run_setup and 'jax_ppo' not in examples_to_include and 'jax_image_classifier' not in examples_to_include }}"
 
   ## Huggingface-related dependencies:

mkdocs.yml

@@ -92,7 +92,7 @@ plugins:
   - mkdocstrings:
       handlers:
         python:
-          import:
+          inventories:
             - https://docs.python-requests.org/en/master/objects.inv
             - https://omegaconf.readthedocs.io/en/latest/objects.inv
             - https://lightning.ai/docs/pytorch/stable/objects.inv

project/algorithms/callbacks/classification_metrics.py

@@ -1,14 +1,14 @@
 import warnings
 from logging import getLogger as get_logger
-from typing import Literal, TypedDict
+from typing import Literal, NotRequired, Required, TypedDict
 
 import lightning
 import torch
 import torchmetrics
 from lightning import LightningModule, Trainer
 from torch import Tensor
 from torchmetrics.classification import MulticlassAccuracy
-from typing_extensions import NotRequired, Required, override
+from typing_extensions import override
 
 from project.utils.typing_utils.protocols import ClassificationDataModule
 

project/algorithms/jax_ppo.py

@@ -40,6 +40,10 @@
 
 logger = get_logger(__name__)
 
+# Little compatibility patch for rejax.
+if not hasattr(jax, "tree_map"):
+    setattr(jax, "tree_map", jax.tree.map)
+
 TEnvParams = TypeVar("TEnvParams", bound=gymnax.EnvParams, default=gymnax.EnvParams)
 """Type variable for the env params (`gymnax.EnvParams`)."""
 

project/algorithms/jax_ppo_test.py

@@ -4,6 +4,7 @@
 import functools
 import operator
 import time
+import warnings
 from collections.abc import Callable, Iterable, Sequence
 from logging import getLogger
 from pathlib import Path
@@ -156,9 +157,7 @@ def test_ours(
     original_datadir: Path,
 ):
     ts, evaluations = results_ours
-    tensor_regression.check(
-        jax.tree.map(operator.methodcaller("__array__"), dataclasses.asdict(evaluations))
-    )
+    tensor_regression.check(jax.tree.map(np.asarray, dataclasses.asdict(evaluations)))
 
     eval_rng = rng
     if isinstance(seed, int):
@@ -311,7 +310,7 @@ def _visualize_rejax(rejax_algo: rejax.PPO, rejax_ts: Any, eval_rng: chex.PRNGKe
     actor = functools.partial(
         _actor,
         actor_ts=actor_ts,
-        rms_state=rejax_ts.rms_state,
+        rms_state=rejax_ts.obs_rms_state,  # changed in rejax recently.
         normalize_observations=rejax_algo.normalize_observations,
     )
     render_episode(
@@ -463,14 +462,19 @@ def debug_jit_warnings():
     # Temporarily make this particular warning into an error to help future-proof our jax code.
     import jax._src.deprecations
 
-    val_before = jax._src.deprecations._registered_deprecations["tracer-hash"].accelerated
-    jax._src.deprecations._registered_deprecations["tracer-hash"].accelerated = True
+    deprecations_to_trigger_error_for = ["tracer-hash"]
+    values_before = {}
+    for dep in deprecations_to_trigger_error_for:
+        if val := jax._src.deprecations._registered_deprecations.get(dep):
+            values_before[dep] = val.accelerated
+            val.accelerated = True
+        else:
+            warnings.warn(
+                f"Couldn't find jax deprecation {dep!r} to set to error, might not exist anymore."
+            )
     yield
-    jax._src.deprecations._registered_deprecations["tracer-hash"].accelerated = val_before
-
-    # train_pure_jax(algo, backend="cpu")
-    # train_rejax(env=algo.env, env_params=algo.env_params, hp=algo.hp, backend="cpu")
-    # train_lightning(algo, accelerator="cpu")
+    for dep, previous_value in values_before.items():
+        jax._src.deprecations._registered_deprecations[dep].accelerated = previous_value
 
 
 @pytest.fixture

project/utils/remote_launcher_plugin_test.py

@@ -92,7 +92,13 @@ def test_can_load_configs(command_line_args: str):
             # assert isinstance(launcher, remote_launcher_plugin.RemoteSlurmLauncher)
         else:
             launcher = hydra.utils.instantiate(launcher_config)
-            assert isinstance(launcher, SlurmLauncher)
+            # bug: Seems to be some weird reloading of classes happening, causing this test to
+            # fail when comparing two classes, which have the same name and a probably the same,
+            # but loaded twice?
+            assert (
+                isinstance(launcher, SlurmLauncher)
+                or type(launcher).__name__ == SlurmLauncher.__name__
+            )
 
 
 in_github_CI = os.environ.get("GITHUB_ACTIONS") == "true"

pyproject.toml

@@ -7,7 +7,7 @@ authors = [
     { name = "César Miguel Valdez Córdova", email = "[email protected]" },
 ]
 dependencies = [
-    "torch==2.4.1",
+    "torch>=2.9.1",
     "hydra-core>=1.3.2",
     "hydra-submitit-launcher>=1.2.0",
     "wandb>=0.17.6",
@@ -23,9 +23,9 @@ dependencies = [
     "transformers>=4.44.0",
     "datasets>=2.21.0",
     # Jax-related dependencies:
-    "jax==0.4.33",
-    "jaxlib==0.4.33",
-    "torch-jax-interop>=0.0.7",
+    "jax",
+    "flax",
+    "torch-jax-interop>=0.0.8",
     "gymnax @ git+https://www.github.com/lebrice/gymnax@fix-classic-control-rendering",
     "rejax>=0.1.0",
     "xtils[jitpp] @ git+https://github.com/jessefarebro/xtils",
@@ -34,10 +34,10 @@ dependencies = [
     "hydra-colorlog>=1.2.0",
     "remote-slurm-executor",
     "hydra-auto-schema>=0.0.7",
-    "hydra-orion-sweeper>=1.6.4 ; python_full_version < '3.11'",
+    "hydra-orion-sweeper>=1.6.4",
 ]
 readme = "README.md"
-requires-python = ">= 3.10"
+requires-python = ">= 3.11,<3.14"
 
 [dependency-groups]
 dev = [
@@ -53,8 +53,9 @@ dev = [
     "pytest-xdist>=3.6.1",
     "pytest>=8.3.2",
     "ruff>=0.6.0",
-    "tensor-regression>=0.0.8",
+    "tensor-regression>=0.1.2",
     "copier>=9.5.0",
+    "tomli>=2.3.0",
 ]
 
 [project.optional-dependencies]
@@ -71,7 +72,7 @@ docs = [
     "mkdocs-macros-plugin>=1.0.5",
     "mkdocs-autoref-plugin",
 ]
-gpu = ["jax[cuda12]>=0.4.31; sys_platform == 'linux'"]
+gpu = ["jax[cuda13]; sys_platform == 'linux'"]
 
 
 [tool.pytest.ini_options]
@@ -117,6 +118,18 @@ source = "uv-dynamic-versioning"
 [tool.uv]
 managed = true
 
+[[tool.uv.index]]
+name = "pytorch-cu130"
+url = "https://download.pytorch.org/whl/cu130"
+explicit = true
+
+
 [tool.uv.sources]
 remote-slurm-executor = { git = "https://github.com/lebrice/remote-slurm-executor", branch = "master" }
 mkdocs-autoref-plugin = { git = "https://github.com/lebrice/mkdocs-autoref-plugin", branch = "master" }
+torch = [
+    { index = "pytorch-cu130", marker = "sys_platform == 'linux' or sys_platform == 'win32'" },
+]
+torchvision = [
+    { index = "pytorch-cu130", marker = "sys_platform == 'linux' or sys_platform == 'win32'" },
+]

pyproject.toml.jinja

@@ -7,7 +7,7 @@ authors = [
 ]
 dependencies = [
 
-    "torch==2.4.1",
+    "torch>=2.9.1",
     "hydra-core>=1.3.2",
     "hydra-submitit-launcher>=1.2.0",
     "wandb>=0.17.6",
@@ -23,9 +23,9 @@ dependencies = [
     "transformers>=4.44.0",
     "datasets>=2.21.0",
     # Jax-related dependencies:
-    "jax==0.4.33",
-    "jaxlib==0.4.33",
-    "torch-jax-interop>=0.0.7",
+    "jax",
+    "flax",
+    "torch-jax-interop>=0.0.8",
     "gymnax @ git+https://www.github.com/lebrice/gymnax@fix-classic-control-rendering",
     "rejax>=0.1.0",
     "xtils[jitpp] @ git+https://github.com/jessefarebro/xtils",
@@ -34,10 +34,10 @@ dependencies = [
     "hydra-colorlog>=1.2.0",
     "remote-slurm-executor",
     "hydra-auto-schema>=0.0.7",
-    "hydra-orion-sweeper>=1.6.4 ; python_full_version < '3.11'",
+    "hydra-orion-sweeper>=1.6.4",
 ]
 readme = "README.md"
-requires-python = ">= {{python_version}}"
+requires-python = ">= {{python_version}},<3.14"
 
 [dependency-groups]
 dev = [
@@ -53,11 +53,11 @@ dev = [
     "pytest-xdist>=3.6.1",
     "pytest>=8.3.2",
     "ruff>=0.6.0",
-    "tensor-regression>=0.0.8",
+    "tensor-regression>=0.1.2",
 ]
 
 [project.optional-dependencies]
-gpu = ["jax[cuda12]>=0.4.31; sys_platform == 'linux'"]
+gpu = ["jax[cuda13]; sys_platform == 'linux'"]
 
 [tool.pytest.ini_options]
 testpaths = ["{{module_name}}", "tests"]
@@ -82,9 +82,6 @@ lint.select = ["E4", "E7", "E9", "F", "I", "UP"]
 [tool.uv]
 managed = true
 
-[tool.uv.sources]
-remote-slurm-executor = { git = "https://github.com/lebrice/remote-slurm-executor", branch = "master" }
-
 
 [build-system]
 requires = ["hatchling", "uv-dynamic-versioning"]
@@ -98,3 +95,17 @@ packages = ["{{module_name}}"]
 
 [tool.hatch.version]
 source = "uv-dynamic-versioning"
+
+[[tool.uv.index]]
+name = "pytorch-cu130"
+url = "https://download.pytorch.org/whl/cu130"
+explicit = true
+
+[tool.uv.sources]
+remote-slurm-executor = { git = "https://github.com/lebrice/remote-slurm-executor", branch = "master" }
+torch = [
+    { index = "pytorch-cu130", marker = "sys_platform == 'linux' or sys_platform == 'win32'" },
+]
+torchvision = [
+    { index = "pytorch-cu130", marker = "sys_platform == 'linux' or sys_platform == 'win32'" },
+]