基础空间¶

在 \(\mathbb{R}^n\) 中的一个（可能无界的）盒子。

具体来说，Box 代表了 n 个闭区间的笛卡尔积。每个区间都具有以下形式之一：\([a, b]\)、\((-\infty, b]\)、\([a, \infty)\) 或 \((-\infty, \infty)\)。

有两个常见的用例

每个维度相同的边界

>>> Box(low=-1.0, high=2.0, shape=(3, 4), dtype=np.float32)
Box(-1.0, 2.0, (3, 4), float32)

每个维度独立的边界

>>> Box(low=np.array([-1.0, -2.0]), high=np.array([2.0, 4.0]), dtype=np.float32)
Box([-1. -2.], [2. 4.], (2,), float32)

参数：:

low (SupportsFloat | np.ndarray) – 区间的下界。如果为整数，则必须至少为 -2**63。
high (SupportsFloat | np.ndarray]) – 区间的上界。如果为整数，则必须最多为 2**63 - 2。
shape (Optional[Sequence[int]]) – 形状从 low 或 high 的形状推断出来，np.ndarray`s with `low 和 high 标量默认为 (1,) 形状。
dtype – 空间元素的 dtype。如果这是一个整数类型，则 Box 本质上是一个离散空间。
seed – 您可以选择使用此参数来为用于从空间中采样的 RNG 播种。

引发：:

ValueError – 如果没有提供形状信息（shape 为 None，low 为 None 且 high 为 None），则会引发值错误。

sample(mask: None = None) → ndarray[Any, dtype[Any]][source]¶

在 Box 中生成单个随机样本。

在创建 Box 的样本时，每个坐标都从一个分布中独立采样，该分布根据区间的形式进行选择

\([a, b]\) : 均匀分布
\([a, \infty)\) : 平移指数分布
\((-\infty, b]\) : 平移负指数分布
\((-\infty, \infty)\) : 正态分布

参数：:: mask – 从 Box 空间采样值的掩码，目前不支持。
返回：:: 从 Box 中采样的值

seed(seed: int | None = None) → int | list[int] | dict[str, int]¶

为该空间的伪随机数生成器 (PRNG) 以及子空间的 PRNG（如果适用）播种。

参数：:: seed – 空间的种子值。这会为组合空间扩展，以接受多个值。有关更多详细信息，请参阅空间的文档。
返回：:: 用于所有 PRNG 的种子值，对于组合空间，这可以是值元组或字典。

is_bounded(manner: str = 'both') → bool[source]¶

检查盒子在某种意义上是否是有界的。

参数：:: manner (str) – "both"、"below" 或 "above" 之一。
返回：:: 如果空间是有界的
引发：:: ValueError – 如果 manner 既不是 "both" 也不是 "below" 或 "above"

class gymnasium.spaces.Discrete(n: int | np.integer[Any], seed: int | np.random.Generator | None = None, start: int | np.integer[Any] = 0)[source]¶

一个包含有限元素的空间。

此类表示整数的有限子集，更具体地说，是形如 \(\{ a, a+1, \dots, a+n-1 \}\) 的集合。

示例

>>> from gymnasium.spaces import Discrete
>>> observation_space = Discrete(2, seed=42) # {0, 1}
>>> observation_space.sample()
np.int64(0)
>>> observation_space = Discrete(3, start=-1, seed=42)  # {-1, 0, 1}
>>> observation_space.sample()
np.int64(-1)

参数：:

n (int) – 此空间的元素数量。
seed – 可选地，您可以使用此参数来为用于从 Dict 空间中采样的 RNG 播种。
start (int) – 此空间的最小元素。

sample(mask: MaskNDArray | None = None) → np.int64[source]¶

从此空间生成单个随机样本。

如果提供掩码，则将从掩码中均匀随机选择一个样本。

参数：:: mask – 可选的掩码，用于指示是否可以选择某个动作。期望的 np.ndarray 形状为 (n,) 且 dtype 为 np.int8，其中 1 代表有效动作，0 代表无效/不可行的动作。如果没有可能的动作（即 np.all(mask == 0)），则将返回 space.start。
返回：:: 从空间中采样的整数

seed(seed: int | None = None) → int | list[int] | dict[str, int]¶

为该空间的伪随机数生成器 (PRNG) 以及子空间的 PRNG（如果适用）播种。

参数：:: seed – 空间的种子值。这会为组合空间扩展，以接受多个值。有关更多详细信息，请参阅空间的文档。
返回：:: 用于所有 PRNG 的种子值，对于组合空间，这可以是值元组或字典。

class gymnasium.spaces.MultiBinary(n: NDArray[np.integer[Any]] | Sequence[int] | int, seed: int | np.random.Generator | None = None)[source]¶

一个 n 形状的二进制空间。

此空间的元素是形状在构造期间固定的二进制数组。

示例

>>> from gymnasium.spaces import MultiBinary
>>> observation_space = MultiBinary(5, seed=42)
>>> observation_space.sample()
array([1, 0, 1, 0, 1], dtype=int8)
>>> observation_space = MultiBinary([3, 2], seed=42)
>>> observation_space.sample()
array([[1, 0],
       [1, 0],
       [1, 1]], dtype=int8)

参数：:

n – 这将固定空间元素的形状。它可以是整数（如果空间是平坦的），或者如果有多个轴，则可以是某种序列（元组、列表或 np.ndarray）。
seed – 您可以选择使用此参数来为用于从空间中采样的 RNG 播种。

sample(mask: MaskNDArray | None = None) → NDArray[np.int8][source]¶

从此空间生成单个随机样本。

通过独立的公平抛硬币（空间的每个二进制变量抛一次）来绘制样本。

参数：:: mask – 可选的 np.ndarray，用于掩盖样本，期望的形状为 space.shape。对于 mask == 0，样本将为 0，而对于 mask == 1` then random samples will be generated. The expected mask shape is the space shape and mask dtype is ``np.int8.
返回：:: 从空间中采样的值

seed(seed: int | None = None) → int | list[int] | dict[str, int]¶

为该空间的伪随机数生成器 (PRNG) 以及子空间的 PRNG（如果适用）播种。

参数：:: seed – 空间的种子值。这会为组合空间扩展，以接受多个值。有关更多详细信息，请参阅空间的文档。
返回：:: 用于所有 PRNG 的种子值，对于组合空间，这可以是值元组或字典。

这表示任意 Discrete 空间的笛卡尔积。

它用于表示游戏控制器或键盘，其中每个键都可以表示为一个离散动作空间。

注意

一些环境包装器假设值为 0 始终代表 NOOP 操作。

例如：任天堂游戏控制器 - 可以被概念化为 3 个独立的动作空间

方向键：离散 5 - NOOP[0]，上[1]，右[2]，下[3]，左[4] - 参数：最小值：0，最大值：4
A 键：离散 2 - NOOP[0]，按下[1] - 参数：最小值：0，最大值：1
B 键：离散 2 - NOOP[0]，按下[1] - 参数：最小值：0，最大值：1

它可以被初始化为 MultiDiscrete([ 5, 2, 2 ])，这样一来，一个样本可能就是 array([3, 1, 0])。

虽然此功能很少使用，但如果 nvec 有多个轴，MultiDiscrete 空间也可能有多个轴

示例

>>> from gymnasium.spaces import MultiDiscrete
>>> import numpy as np
>>> observation_space = MultiDiscrete(np.array([[1, 2], [3, 4]]), seed=42)
>>> observation_space.sample()
array([[0, 0],
       [2, 2]])

参数：:

nvec – 每个分类变量的计数向量。这通常是一个整数列表。但是，如果您希望空间具有多个轴，您也可以传递一个更复杂的 numpy 数组。
dtype – 这应该是一种整数类型。
seed – 您可以选择使用此参数来为用于从空间中采样的 RNG 播种。
start – 可选地，每个类别的元素将采用的起始值（默认值为 0）。

sample(mask: tuple[MaskNDArray, ...] | None = None) → NDArray[np.integer[Any]][source]¶

从此空间生成单个随机样本。

参数：:: mask – 多个离散的可选掩码，需要元组，每个动作的位置都有一个 np.ndarray 掩码，形状为 (n,)，其中 n 是动作数，dtype=np.int8。只有 mask values == 1 才能被采样，除非某个动作的所有掩码值都为 0，否则将采样默认动作 self.start（最小元素）。
返回：:: 一个 :meth:`Space.shape` 的 ``np.ndarray``

seed(seed: int | None = None) → int | list[int] | dict[str, int]¶

为该空间的伪随机数生成器 (PRNG) 以及子空间的 PRNG（如果适用）播种。

参数：:: seed – 空间的种子值。这会为组合空间扩展，以接受多个值。有关更多详细信息，请参阅空间的文档。
返回：:: 用于所有 PRNG 的种子值，对于组合空间，这可以是值元组或字典。

class gymnasium.spaces.Text(max_length: int, *, min_length: int = 1, charset: frozenset[str] | str = alphanumeric, seed: int | np.random.Generator | None = None)[source]¶

表示由给定字符集中的字符组成的字符串的空间。

示例

>>> from gymnasium.spaces import Text
>>> # {"", "B5", "hello", ...}
>>> Text(5)
Text(1, 5, charset=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz)
>>> # {"0", "42", "0123456789", ...}
>>> import string
>>> Text(min_length = 1,
...      max_length = 10,
...      charset = string.digits)
Text(1, 10, charset=0123456789)

参数：:

min_length (int) – 最小文本长度（以字符为单位）。默认为 1，以防止出现空字符串。
max_length (int) – 最大文本长度（以字符为单位）。
charset (Union[set], str) – 字符集，默认为英文大小写字母加拉丁数字。
seed – 从空间采样的种子。

sample(mask: None | tuple[int | None, NDArray[np.int8] | None] = None) → str[source]¶

默认情况下，从此空间生成单个随机样本，样本长度在 min_length 和 max_length 之间随机，并从 charset 中采样。

参数：:: mask – 文本的长度和掩码的可选元组。长度应在 min_length 和 max_length 之间，否则将选择 min_length 和 max_length 之间的随机整数。对于掩码，我们期望一个长度为传递的字符集的 numpy 数组，dtype == np.int8。如果 charlist 掩码全部为零，则无论 min_length 是什么，都会返回一个空字符串。
返回：:: 从空间中采样的字符串

seed(seed: int | None = None) → int | list[int] | dict[str, int]¶

为该空间的伪随机数生成器 (PRNG) 以及子空间的 PRNG（如果适用）播种。

参数：:: seed – 空间的种子值。这会为组合空间扩展，以接受多个值。有关更多详细信息，请参阅空间的文档。
返回：:: 用于所有 PRNG 的种子值，对于组合空间，这可以是值元组或字典。