mirror of
https://github.com/Farama-Foundation/Gymnasium.git
synced 2025-08-17 20:39:12 +00:00
745e7059e7
* Added docstrings for spaces, WIP * Formatting changes * Use raw docstring for Box.sample * Formatting fix * Formatting fix * Use :class:, :meth:, formatting fixes, resolve TODO, use Optional
33 lines
1.1 KiB
Python
33 lines
1.1 KiB
Python
"""This module implements various spaces.
|
|
|
|
Spaces describe mathematical sets and are used in Gym to specify valid actions and observations.
|
|
Every Gym environment must have the attributes ``action_space`` and ``observation_space``.
|
|
If, for instance, three possible actions (0,1,2) can be performed in your environment and observations
|
|
are vectors in the two-dimensional unit cube, the environment code may contain the following two lines::
|
|
|
|
self.action_space = spaces.Discrete(3)
|
|
self.observation_space = spaces.Box(0, 1, shape=(2,))
|
|
"""
|
|
from gym.spaces.box import Box
|
|
from gym.spaces.dict import Dict
|
|
from gym.spaces.discrete import Discrete
|
|
from gym.spaces.multi_binary import MultiBinary
|
|
from gym.spaces.multi_discrete import MultiDiscrete
|
|
from gym.spaces.space import Space
|
|
from gym.spaces.tuple import Tuple
|
|
from gym.spaces.utils import flatdim, flatten, flatten_space, unflatten
|
|
|
|
__all__ = [
|
|
"Space",
|
|
"Box",
|
|
"Discrete",
|
|
"MultiDiscrete",
|
|
"MultiBinary",
|
|
"Tuple",
|
|
"Dict",
|
|
"flatdim",
|
|
"flatten_space",
|
|
"flatten",
|
|
"unflatten",
|
|
]
|