gaspersic/Gymnasium
1
0
Fork 0
mirror of https://github.com/Farama-Foundation/Gymnasium.git synced 2025-08-16 11:39:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix and complete docstrings to match the documentation page (#2697)

Browse Source
This commit is contained in:
Manuel Goulão
2022-04-06 20:12:55 +01:00
committed by GitHub
parent 07fd227a4f
commit 658d4081c0
9 changed files with 94 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
gym/spaces/multi_binary.py
View File

@@ -11,23 +11,18 @@ class MultiBinary(Space[np.ndarray]):
"""
An n-shape binary space.
The argument to MultiBinary defines n, which could be a number or a `list` of numbers.
The argument to MultiBinary defines n, which could be a number or a ``list`` of numbers.
Example Usage:
Example Usage::
>> self.observation_space = spaces.MultiBinary(5)
>> self.observation_space.sample()
array([0, 1, 0, 1, 0], dtype=int8)
>> self.observation_space = spaces.MultiBinary([3, 2])
>> self.observation_space.sample()
array([[0, 0],
[0, 1],
[1, 1]], dtype=int8)
>>> self.observation_space = spaces.MultiBinary(5)
>>> self.observation_space.sample()
array([0, 1, 0, 1, 0], dtype=int8)
>>> self.observation_space = spaces.MultiBinary([3, 2])
>>> self.observation_space.sample()
array([[0, 0],
[0, 1],
[1, 1]], dtype=int8)
"""