Impossible to reproduce simple example with Gymnasium

[liar666]

Describe the bug

I cannot run the "gym" example from the examples/ dir of mushroomrl:
https://github.com/MushroomRL/mushroom-rl/blob/dev/examples/gym_recurrent_ppo.py

I get Error:

Traceback (most recent call last):
  File "<string>", line 17, in __PYTHON_EL_eval
  File "/home/user/expl_from_lib.py", line 11, in <module>
    from mushroom_rl.environments import Gymnasium
ImportError: cannot import name 'Gymnasium' from 'mushroom_rl.environments' (/home/user/venv/lib/python3.11/site-packages/mushroom_rl/environments/__init__.py)

I have latest Gymnasium and MushroomRL libs installed:

$ pip freeze | grep -E '(ymn|ushro)'
gymnasium==1.2.2
mushroom-rl==1.10.2

To Reproduce

• Download code from https://github.com/MushroomRL/mushroom-rl/blob/dev/examples/gym_recurrent_ppo.py
• pip install mushroom-rl gymnasium
• Execute code
• Get error: "ImportError: cannot import name 'Gymnasium' from 'mushroom_rl.environments'"

Expected behavior

Examples from the library should work out-of-the-box (aren't they part of the Unit Test suite?)

System information (please complete the following information):

• OS: LMDE 6
• Python version Python 3.11.2
• Torch version 2.5.1
• Mushroom version 1.10.2

[liar666]

OK.... Reading the "Installation" section of README, I discovered that I need to run pip install mushroom_rl[all] if I want external Environments.

Unfortunately, When I run that command I get:

[✔] user@station:MMLLLLLLLL$ pip3 install mushroom_rl[all]
Requirement already satisfied: mushroom_rl[all] in /home/user/Python/DataScience/lib/python3.11/site-packages (1.10.2)
Requirement already satisfied: numpy==1.24.4 in /home/user/Python/DataScience/lib/python3.11/site-packages (from mushroom_rl[all]) (1.24.4)
Requirement already satisfied: scipy==1.15.2 in /home/user/Python/DataScience/lib/python3.11/site-packages (from mushroom_rl[all]) (1.15.2)
Requirement already satisfied: scikit-learn==1.6.1 in /home/user/Python/DataScience/lib/python3.11/site-packages (from mushroom_rl[all]) (1.6.1)
Requirement already satisfied: matplotlib==3.10.1 in /home/user/Python/DataScience/lib/python3.11/site-packages (from mushroom_rl[all]) (3.10.1)
Requirement already satisfied: joblib==1.4.2 in /home/user/Python/DataScience/lib/python3.11/site-packages (from mushroom_rl[all]) (1.4.2)
Requirement already satisfied: tqdm==4.67.1 in /home/user/Python/DataScience/lib/python3.11/site-packages (from mushroom_rl[all]) (4.67.1)
Requirement already satisfied: pygame==2.6.1 in /home/user/Python/DataScience/lib/python3.11/site-packages (from mushroom_rl[all]) (2.6.1)
Requirement already satisfied: opencv-python>=4.7 in /home/user/Python/DataScience/lib/python3.11/site-packages (from mushroom_rl[all]) (4.11.0.86)
Requirement already satisfied: torch==2.5.1 in /home/user/Python/DataScience/lib/python3.11/site-packages (from mushroom_rl[all]) (2.5.1)
Requirement already satisfied: pytest in /home/user/Python/DataScience/lib/python3.11/site-packages (from mushroom_rl[all]) (8.3.4)
***Collecting gym==0.24.1 (from mushroom_rl[all])*** <<-- WTF???
  Using cached gym-0.24.1.tar.gz (696 kB)
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
INFO: pip is looking at multiple versions of mushroom-rl[all] to determine which version is compatible with other requirements. This could take a while.
Collecting mushroom_rl[all]
  Using cached mushroom-rl-1.10.1.tar.gz (1.6 MB)
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
  Using cached mushroom-rl-1.10.0.post2.tar.gz (1.6 MB)
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
  Using cached mushroom-rl-1.9.2.tar.gz (1.6 MB)
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
Collecting numpy_ml (from mushroom_rl[all])
  Using cached numpy_ml-0.1.2-py2.py3-none-any.whl.metadata (6.9 kB)
Collecting mushroom_rl[all]
  Using cached mushroom-rl-1.9.1.tar.gz (1.6 MB)
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
  Using cached mushroom-rl-1.9.0.tar.gz (1.6 MB)
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
  Preparing metadata (pyproject.toml) ... done
***  Using cached mushroom-rl-1.7.2.tar.gz (20.7 MB)*** <<-- WTF??
  Installing build dependencies ... done
  Getting requirements to build wheel ... error
  error: subprocess-exited-with-error
  
  × Getting requirements to build wheel did not run successfully.
  │ exit code: 1
  ╰─> [39 lines of output]
      
      Error compiling Cython file:
      ------------------------------------------------------------
      ...
                                    float vce, float frcmtc,
                                    np.ndarray[np.float_t, ndim=1] r, np.ndarray[np.float_t, ndim=1] phiref,
                                    np.ndarray[np.float_t, ndim=1] phimaxref, np.ndarray[np.float_t, ndim=1] rho,
                                    np.ndarray[np.float_t, ndim=1] dirAng, np.ndarray[np.float_t, ndim=1] phiScale,
                                    np.ndarray[np.float_t, ndim=1] angJoi, np.ndarray[np.float_t, ndim=1] levelArm,
                                    np.ndarray[np.int_t, ndim=1] offsetCorr,
                                                  ^
      ------------------------------------------------------------
      mushroom_rl/environments/mujoco_envs/humanoid_gait/_external_simulation/muscle_simulation_stepupdate.pyx:24:44: Invalid type.
      Compiling mushroom_rl/environments/mujoco_envs/humanoid_gait/_external_simulation/muscle_simulation_stepupdate.pyx because it changed.
      [1/1] Cythonizing mushroom_rl/environments/mujoco_envs/humanoid_gait/_external_simulation/muscle_simulation_stepupdate.pyx
      Traceback (most recent call last):
        File "/home/user/Python/DataScience/lib/python3.11/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 389, in <module>
          main()
        File "/home/user/Python/DataScience/lib/python3.11/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 373, in main
          json_out["return_val"] = hook(**hook_input["kwargs"])
                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/home/user/Python/DataScience/lib/python3.11/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 143, in get_requires_for_build_wheel
          return hook(config_settings)
                 ^^^^^^^^^^^^^^^^^^^^^
        File "/tmp/pip-build-env-i7f0rr7i/overlay/lib/python3.11/site-packages/setuptools/build_meta.py", line 331, in get_requires_for_build_wheel
          return self._get_build_requires(config_settings, requirements=[])

I think the problem comes from the famous fact that Gym does not support NumPy 2...

But then the question is why oh why is pip install mushroom-rl[all] trying to install Gym instead of Gymnasium???? (see my WTF comments & highlights in the error message above).

[boris-il-forte]

I only saw this now.

Mushrtoom 1.10 only supports gym, so you would need to use an older version of python/numpy.

The dev branch, Mushroom 2.0, supports gymnasium. Unfortunately, the dev version is still under development and is not fully featured. For example, in Mushroom 2.0, it is not possible to run DQN on Atari. For this reason, we did not release 2.0 yet (and unfortunately, due to many reasons, the release has been delayed quite a lot, and there is no clear time plan)

Except that, the 2.0 verison is mostly usable and tested, and you can install it by cloning the dev branch and installing with the editable installation.

[boris-il-forte]

(see also #144)