Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mark gym_py as not to be upgraded. #18534

Merged
merged 1 commit into from
Jan 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions tools/workspace/gym_py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,23 @@ gym
===

This imports the OpenAI Gym RL tool into our build.


Note on Upgrading
=================

`stable_baselines3` lags `gym` by more than `gym`'s deprecation window and
does not document its compatiblity limit correctly (claims to support `gym`
<0.24 but in fact uses classes removed in 0.22, for example).

Because of this, it is unlikely that upgrading this package beyond 0.21 will
succeed, or is even desirable.

* Check https://github.com/DLR-RM/stable-baselines3/pull/780 for status.
* `stable_baselines3` allegedly will fix all of this version shear when gym
hits 1.0.
* `gym` will allegedly remove all the deprecated APIs that SB3 uses in 0.26.

A full upgrade of `gym` to 1.0 and correspondingly of `stable_baselines3` to
HEAD will be necessary in the future, but will require substantial changes to
the `stable_baselines3_internal` stub and to any corresponding unit tests.
1 change: 1 addition & 0 deletions tools/workspace/new_release.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
_IGNORED_REPOSITORIES = [
# We don't know how to check non-default branches yet.
"clang_cindex_python3_internal",
"gym_py", # Pinned at 0.21; see tools/workspace/gym_py/README.md.
"pybind11",
]

Expand Down