Skip to content

Commit 15d5902

Browse files
vincentpierreeshvk
authored andcommitted
[Documentation] Added information for the environments the trainer cannot train with the default configurations (#1995)
1 parent 41950b9 commit 15d5902

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/Learning-Environment-Examples.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,9 @@ If you would like to contribute environments, please see our
126126
* Vector Action space: (Discrete) Size of 6, corresponding to turn clockwise
127127
and counterclockwise and move along four different face directions.
128128
* Visual Observations (Optional): One first-person camera. Use
129-
`VisualPushBlock` scene.
129+
`VisualPushBlock` scene. __The visual observation version of
130+
this environment does not train with the provided default
131+
training parameters.__
130132
* Reset Parameters: None.
131133
* Benchmark Mean Reward: 4.5
132134
* Optional Imitation Learning scene: `PushBlockIL`.
@@ -219,7 +221,9 @@ If you would like to contribute environments, please see our
219221
* Rotation (3 possible actions: Rotate Left, Rotate Right, No Action)
220222
* Laser (2 possible actions: Laser, No Action)
221223
* Visual Observations (Optional): First-person camera per-agent. Use
222-
`VisualBanana` scene.
224+
`VisualBanana` scene. __The visual observation version of
225+
this environment does not train with the provided default
226+
training parameters.__
223227
* Reset Parameters: None.
224228
* Benchmark Mean Reward: 10
225229
* Optional Imitation Learning scene: `BananaIL`.
@@ -243,7 +247,9 @@ If you would like to contribute environments, please see our
243247
* Vector Action space: (Discrete) 1 Branch, 4 actions corresponding to agent
244248
rotation and forward/backward movement.
245249
* Visual Observations (Optional): First-person view for the agent. Use
246-
`VisualHallway` scene.
250+
`VisualHallway` scene. __The visual observation version of
251+
this environment does not train with the provided default
252+
training parameters.__
247253
* Reset Parameters: None.
248254
* Benchmark Mean Reward: 0.7
249255
* To speed up training, you can enable curiosity by adding `use_curiosity: true` in `config/trainer_config.yaml`
@@ -300,7 +306,7 @@ If you would like to contribute environments, please see our
300306
* Visual Observations: None.
301307
* Reset Parameters: None
302308
* Benchmark Mean Reward (Striker & Goalie Brain): 0 (the means will be inverse
303-
of each other and criss crosses during training)
309+
of each other and criss crosses during training) __Note that our trainer is currently unable to consistently train this environment__
304310

305311
## Walker
306312

@@ -345,7 +351,9 @@ If you would like to contribute environments, please see our
345351
* Vector Action space: (Discrete) 4 corresponding to agent rotation and
346352
forward/backward movement.
347353
* Visual Observations (Optional): First-person camera per-agent. Us
348-
`VisualPyramids` scene.
354+
`VisualPyramids` scene. __The visual observation version of
355+
this environment does not train with the provided default
356+
training parameters.__
349357
* Reset Parameters: None.
350358
* Optional Imitation Learning scene: `PyramidsIL`.
351359
* Benchmark Mean Reward: 1.75

0 commit comments

Comments
 (0)