Skip to content

Commit 1a11316

Browse files
committed
Clarify Box2D baseline documentation
1 parent 3b5a6d7 commit 1a11316

1 file changed

Lines changed: 12 additions & 14 deletions

File tree

docs/env/box2d.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
Box2D
22
=====
33

4-
We use ``box2d==2.4.2`` and ``gym==0.23.1`` as the codebase. See
5-
https://github.com/erincatto/box2d/tree/v2.4.2 and
6-
https://github.com/openai/gym/tree/v0.23.1/gym/envs/box2d
4+
EnvPool's Box2D implementation follows ``box2d==2.4.2``. The current Python
5+
baseline checks compare against Gymnasium ``1.2.3`` Box2D environments backed
6+
by the ``box2d`` wheel.
77

88

99
BipedalWalker-v3, BipedalWalkerHardcore-v3
@@ -50,7 +50,7 @@ The episode will terminate if the hull gets in contact with the ground or
5050
if the walker exceeds the right end of the terrain length.
5151

5252

53-
CarRacing-v2
53+
CarRacing-v3
5454
------------
5555

5656
The easiest control task to learn from pixels - a top-down racing environment.
@@ -86,7 +86,7 @@ The episode finishes when all of the tiles are visited. The car can also go
8686
outside of the playfield - that is, far off the track, in which case it will
8787
receive -100 reward and die.
8888

89-
LunarLander-v2, LunarLanderContinuous-v2
89+
LunarLander-v3, LunarLanderContinuous-v3
9090
----------------------------------------
9191

9292
This environment is a classic rocket trajectory optimization problem.
@@ -152,13 +152,11 @@ The episode finishes if:
152152
Notes on Box2D versions
153153
-----------------------
154154

155-
``box2d_correctness_test.py`` aims to address the correctness of our Box2D
156-
implementation.
155+
``box2d_correctness_test.py`` checks EnvPool against the current Gymnasium
156+
``v3`` Box2D baselines.
157157

158-
We used gym's historical baseline with dependency ``box2d-py==2.3.5`` (see
159-
https://github.com/openai/box2d-py/tree/2.3.5) for 1000 episode and averaged
160-
reward as our threshold.
161-
162-
The current implementation of envpool is based on box2d 2.4.2 version.
163-
If you want to use box2d==2.3.5 to run the test, please checkout commit
164-
``4de47ebb6615052c67fdfbbe9bc3e9b1d5692f99`` and build the wheel.
158+
Older EnvPool releases used Gym's historical baseline with dependency
159+
``box2d-py==2.3.5`` (see
160+
https://github.com/openai/box2d-py/tree/2.3.5) for these comparisons. If you
161+
need to reproduce that historical setup, please checkout commit
162+
``4de47ebb6615052c67fdfbbe9bc3e9b1d5692f99`` and build the wheel from there.

0 commit comments

Comments
 (0)