Spaces Utils¶

gymnasium.spaces.utils.flatten_space(space: Space[Any]) → Box | Dict | Sequence | Tuple | Graph[source]¶

gymnasium.spaces.utils.flatten_space(space: Box) → Box

gymnasium.spaces.utils.flatten_space(space: Discrete | MultiBinary | MultiDiscrete) → Box

gymnasium.spaces.utils.flatten_space(space: Tuple) → Box | Tuple

gymnasium.spaces.utils.flatten_space(space: Dict) → Box | Dict

gymnasium.spaces.utils.flatten_space(space: Graph) → Graph

gymnasium.spaces.utils.flatten_space(space: Text) → Box

gymnasium.spaces.utils.flatten_space(space: Sequence) → Sequence

gymnasium.spaces.utils.flatten_space(space: OneOf) → Box

将空间展平为尽可能平坦的空间。

此函数将尝试将 space 展平为单个 gymnasium.spaces.Box 空间。但是，当 space 是 gymnasium.spaces.Graph、gymnasium.spaces.Sequence 的实例或包含 gymnasium.spaces.Graph 或 gymnasium.spaces.Sequence 空间的复合空间时，这可能无法实现。这等效于 flatten()，但作用于空间本身。非图空间的结果始终是具有平坦边界的 gymnasium.spaces.Box。而图空间的结果始终是 gymnasium.spaces.Graph，其中 Graph.node_space 是具有平坦边界的 Box，Graph.edge_space 是具有平坦边界的 Box 或 None。box 恰好有 flatdim() 个维度。展平原始空间的样本与获取展平空间的样本具有相同的效果。但是，从展平空间采样不一定是可逆的。例如，从展平的 Discrete 空间采样与从 Box 采样相同，结果可能不是整数或 one-hot 编码。这可能会导致错误或非均匀采样。

参数:: space – 要展平的空间
返回:: 展平的 Box
Raises:: NotImplementedError – 如果空间未在 gymnasium.spaces 中定义。

示例 - 展平 spaces.Box

>>> from gymnasium.spaces import Box
>>> box = Box(0.0, 1.0, shape=(3, 4, 5))
>>> box
Box(0.0, 1.0, (3, 4, 5), float32)
>>> flatten_space(box)
Box(0.0, 1.0, (60,), float32)
>>> flatten(box, box.sample()) in flatten_space(box)
True

示例 - 展平 spaces.Discrete

>>> from gymnasium.spaces import Discrete
>>> discrete = Discrete(5)
>>> flatten_space(discrete)
Box(0, 1, (5,), int64)
>>> flatten(discrete, discrete.sample()) in flatten_space(discrete)
True

示例 - 展平 spaces.Dict

>>> from gymnasium.spaces import Dict, Discrete, Box
>>> space = Dict({"position": Discrete(2), "velocity": Box(0, 1, shape=(2, 2))})
>>> flatten_space(space)
Box(0.0, 1.0, (6,), float64)
>>> flatten(space, space.sample()) in flatten_space(space)
True

示例 - 展平 spaces.Graph

>>> from gymnasium.spaces import Graph, Discrete, Box
>>> space = Graph(node_space=Box(low=-100, high=100, shape=(3, 4)), edge_space=Discrete(5))
>>> flatten_space(space)
Graph(Box(-100.0, 100.0, (12,), float32), Box(0, 1, (5,), int64))
>>> flatten(space, space.sample()) in flatten_space(space)
True

gymnasium.spaces.utils.flatten(space: Space[T], x: T) → ndarray[Any, dtype[Any]] | Dict[str, Any] | Tuple[Any, ...] | GraphInstance[source]¶

gymnasium.spaces.utils.flatten(space: Box | MultiBinary, x: NDArray[Any]) → NDArray[Any]

gymnasium.spaces.utils.flatten(space: Discrete, x: int64) → ndarray[Any, dtype[int64]]

gymnasium.spaces.utils.flatten(space: MultiDiscrete, x: ndarray[Any, dtype[int64]]) → ndarray[Any, dtype[int64]]

gymnasium.spaces.utils.flatten(space: Tuple, x: tuple[Any, ...]) → tuple[Any, ...] | NDArray[Any]

gymnasium.spaces.utils.flatten(space: Dict, x: dict[str, Any]) → dict[str, Any] | NDArray[Any]

gymnasium.spaces.utils.flatten(space: Graph, x: GraphInstance) → GraphInstance

gymnasium.spaces.utils.flatten(space: Text, x: str) → ndarray[Any, dtype[int32]]

gymnasium.spaces.utils.flatten(space: Sequence, x: tuple[Any, ...] | Any) → tuple[Any, ...] | Any

gymnasium.spaces.utils.flatten(space: OneOf, x: tuple[int, Any]) → ndarray[Any, dtype[Any]]

展平来自空间的数据点。

当例如必须将来自空间的点传递给神经网络时，这很有用，神经网络只理解浮点数的扁平数组。

参数:

space – 要展平 x 的空间
x – 要展平的值

返回:

展平的数据点 –

对于 gymnasium.spaces.Box 和 gymnasium.spaces.MultiBinary，这是一个展平的数组
对于 gymnasium.spaces.Discrete 和 gymnasium.spaces.MultiDiscrete，这是样本的展平 one-hot 数组
对于 gymnasium.spaces.Tuple 和 gymnasium.spaces.Dict，这是子空间的连接数组（不支持图子空间）
对于图空间，返回 GraphInstance，其中
- GraphInstance.nodes 是 n x k 数组
- GraphInstance.edges 是
  
  m x k 数组
  
  None
- GraphInstance.edge_links 是
  
  m x 2 数组
  
  None

Raises:

NotImplementedError – 如果空间未在 gymnasium.spaces 中定义。

示例

>>> from gymnasium.spaces import Box, Discrete, Tuple
>>> space = Box(0, 1, shape=(3, 5))
>>> flatten(space, space.sample()).shape
(15,)
>>> space = Discrete(4)
>>> flatten(space, 2)
array([0, 0, 1, 0])
>>> space = Tuple((Box(0, 1, shape=(2,)), Box(0, 1, shape=(3,)), Discrete(3)))
>>> example = ((.5, .25), (1., 0., .2), 1)
>>> flatten(space, example)
array([0.5 , 0.25, 1.  , 0.  , 0.2 , 0.  , 1.  , 0.  ])

gymnasium.spaces.utils.flatdim(space: Space[Any]) → int[source]¶

gymnasium.spaces.utils.flatdim(space: Box | MultiBinary) → int

gymnasium.spaces.utils.flatdim(space: Discrete) → int

gymnasium.spaces.utils.flatdim(space: MultiDiscrete) → int

gymnasium.spaces.utils.flatdim(space: Tuple) → int

gymnasium.spaces.utils.flatdim(space: Dict) → int

gymnasium.spaces.utils.flatdim(space: Graph)

gymnasium.spaces.utils.flatdim(space: Text) → int

gymnasium.spaces.utils.flatdim(space: OneOf) → int

返回此 space 的扁平化等效空间所具有的维度数量。

参数:

space – 返回扁平化空间的维度数量的空间

返回:

扁平化空间的维度数量

Raises:

NotImplementedError – 如果 space 未在 gym.spaces 中定义，则引发此错误。
ValueError – 如果 space 无法扁平化为 gymnasium.spaces.Box，则引发此错误

示例

>>> from gymnasium.spaces import Dict, Discrete
>>> space = Dict({"position": Discrete(2), "velocity": Discrete(3)})
>>> flatdim(space)
5

gymnasium.spaces.utils.unflatten(space: Space[T], x: ndarray[Any, dtype[Any]] | Dict[str, Any] | Tuple[Any, ...] | GraphInstance) → T[source]¶

gymnasium.spaces.utils.unflatten(space: Box | MultiBinary, x: NDArray[Any]) → NDArray[Any]

gymnasium.spaces.utils.unflatten(space: Discrete, x: ndarray[Any, dtype[int64]]) → int64

gymnasium.spaces.utils.unflatten(space: MultiDiscrete, x: ndarray[Any, dtype[integer[Any]]]) → ndarray[Any, dtype[integer[Any]]]

gymnasium.spaces.utils.unflatten(space: Tuple, x: NDArray[Any] | tuple[Any, ...]) → tuple[Any, ...]

gymnasium.spaces.utils.unflatten(space: Dict, x: NDArray[Any] | dict[str, Any]) → dict[str, Any]

gymnasium.spaces.utils.unflatten(space: Graph, x: GraphInstance) → GraphInstance

gymnasium.spaces.utils.unflatten(space: Text, x: ndarray[Any, dtype[int32]]) → str

gymnasium.spaces.utils.unflatten(space: Sequence, x: tuple[Any, ...]) → tuple[Any, ...] | Any

gymnasium.spaces.utils.unflatten(space: OneOf, x: ndarray[Any, dtype[Any]]) → tuple[int, Any]

从 space 中解扁平化一个数据点。

此操作会反转 flatten() 应用的转换。您必须确保 space 参数与调用 flatten() 时使用的 space 参数相同。

参数:

space – 用于解扁平化 x 的 space
x – 要解扁平化的数组

返回:

一个结构与 space 匹配的点。

Raises:

NotImplementedError – 如果空间未在 gymnasium.spaces 中定义。