isaac-sim / IsaacLab

Unified framework for robot learning built on NVIDIA Isaac Sim
https://isaac-sim.github.io/IsaacLab
Other
2.25k stars 924 forks source link

[Proposal] Relaxing gymnasium requirement #1002

Open BurakDmb opened 2 months ago

BurakDmb commented 2 months ago

Proposal

Hi, for some other libraries, I am forced to use Gymnasium version 0.29.1. However, Isaaclab has a 0.29.0 strict requirement.
https://github.com/isaac-sim/IsaacLab/blob/52af899614318a25404677bd7b754d867e743c45/source/extensions/omni.isaac.lab/setup.py#L29 and https://github.com/isaac-sim/IsaacLab/blob/52af899614318a25404677bd7b754d867e743c45/source/extensions/omni.isaac.lab/config/extension.toml#L26

Can you bump Gymnasium to 0.29.1 or at least relax the requirement to cover both 0.29.0 and 0.29.1

0.29.1 is a minor release and it only adds some small warnings, so I don't think anything will break in IsaacLab. https://github.com/Farama-Foundation/Gymnasium/releases/tag/v0.29.1

I can open a PR if help is needed.

Mayankm96 commented 2 months ago

We can relax it but then it becomes hard to ensure that things aren't breaking because other libraries made breaking changes.

Checking the diff between 0.29.0 and 0.29.1, I think we can do an update of that (provided everything works). But I'd be against making it always ">=".

BurakDmb commented 2 months ago

I suggest a version specifier like this could cover your concerns and flex the version by a little bit. I tested in my local setup for pip installation and setup py seems to be working. Source for specifying range in install_requires: https://packaging.python.org/en/latest/discussions/install-requires-vs-requirements/#install-requires

"gymnasium >=0.29.0, <=0.29.1"

BurakDmb commented 1 month ago

Hi, I can create a PR for that, or is someone working on this now? Do you happen to see any problems with this version suggestion? @Mayankm96

My suggestion is changing these lines with "gymnasium >=0.29.0, <=0.29.1" to support gymnasium versions 0.29.0 and 0.29.1:

https://github.com/isaac-sim/IsaacLab/blob/52af899614318a25404677bd7b754d867e743c45/source/extensions/omni.isaac.lab/setup.py#L29

https://github.com/isaac-sim/IsaacLab/blob/52af899614318a25404677bd7b754d867e743c45/source/extensions/omni.isaac.lab/config/extension.toml#L26

Mayankm96 commented 1 month ago

Gymnasium 1.0.0 is out. We would work on switching to it.

@Toni-SM for vis.