PettingZooEnv¶

torchrl.envs.PettingZooEnv(*args, **kwargs)[源代码]¶

PettingZoo 环境。

要安装 petting zoo，请按照此处指南 <https://github.com/Farama-Foundation/PettingZoo#installation>__操作。

此类是所有 PettingZoo 环境的通用 torchrl 包装器。它能够包装 pettingzoo.AECEnv 和 pettingzoo.ParallelEnv。

让我们更详细地了解一下

对于包装 pettingzoo.ParallelEnv，请提供你的 petting zoo 任务名称（在 task 参数中）并指定 parallel=True。这将构建该任务的 pettingzoo.ParallelEnv 版本（如果 pettingzoo 支持），并将其包装到 torchrl 中。在包装的 pettingzoo.ParallelEnv 中，所有智能体将在每个环境步骤中执行操作。如果任务期间的智能体数量发生变化，请设置 use_mask=True。"mask" 将作为每个组的输出提供，应用于屏蔽掉死亡的智能体。环境将在一个智能体完成时重置（除非 done_on_any 为 False）。

对于包装 pettingzoo.AECEnv，请提供你的 petting zoo 任务名称（在 task 参数中）并指定 parallel=False。这将构建该任务的 pettingzoo.AECEnv 版本并将其包装到 torchrl 中。在包装的 pettingzoo.AECEnv 中，每个步骤中只有一个智能体将执行操作。因此，对于此类型的环境，必须设置 use_mask=True。"mask" 将作为每个组的输出提供，可用于屏蔽掉未执行操作的智能体。只有当所有智能体都完成时，环境才会重置（除非 done_on_any 为 True）。

如果智能体有任何不可用的操作，环境还将自动更新其 action_spec 的掩码并为每个组输出一个 "action_mask" 以反映最新的可用操作。这应该在训练期间传递给掩码分布。

作为 torchrl 多智能体的一个特性，你可以控制环境中智能体的分组。你可以将智能体组合在一起（堆叠它们的张量）以利用向量化，当将其通过同一个神经网络时。你可以将智能体分成不同的组，在这些组中它们是异构的或应该由不同的神经网络处理。要进行分组，你只需要在环境构造时传递一个 group_map。

默认情况下，pettingzoo 中的智能体将按名称分组。例如，对于智能体 ["agent_0","agent_1","agent_2","adversary_0"]，tensordicts 将如下所示

>>> print(env.rand_action(env.reset()))
TensorDict(
    fields={
        agent: TensorDict(
            fields={
                action: Tensor(shape=torch.Size([3, 9]), device=cpu, dtype=torch.int64, is_shared=False),
                action_mask: Tensor(shape=torch.Size([3, 9]), device=cpu, dtype=torch.bool, is_shared=False),
                done: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([3, 3, 3, 2]), device=cpu, dtype=torch.int8, is_shared=False),
                terminated: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([3]))},
        adversary: TensorDict(
            fields={
                action: Tensor(shape=torch.Size([1, 9]), device=cpu, dtype=torch.int64, is_shared=False),
                action_mask: Tensor(shape=torch.Size([1, 9]), device=cpu, dtype=torch.bool, is_shared=False),
                done: Tensor(shape=torch.Size([1, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([1, 3, 3, 2]), device=cpu, dtype=torch.int8, is_shared=False),
                terminated: Tensor(shape=torch.Size([1, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([1, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([1]))},
    batch_size=torch.Size([]))
>>> print(env.group_map)
{"agent": ["agent_0", "agent_1", "agent_2"], "adversary": ["adversary_0"]}

否则，可以指定组映射或从一些预先制作的选项中进行选择。有关更多信息，请参阅 torchrl.envs.utils.MarlGroupMapType。例如，你可以提供 MarlGroupMapType.ONE_GROUP_PER_AGENT，表示每个智能体都应该有自己的 tensordict（类似于 pettingzoo 并行 API）。

分组对于利用其数据通过相同神经网络的智能体之间的向量化非常有用。

参数：

task (str) – 要以“<env>/<task>”格式（例如，“sisl/multiwalker_v9”）或“<task>”格式（例如，“multiwalker_v9”）创建的 pettingzoo 任务的名称。
parallel (bool) – 是否构建任务的 pettingzoo.ParallelEnv 版本或 pettingzoo.AECEnv 版本。
return_state (bool, 可选) – 是否从 pettingzoo 返回全局状态（并非所有环境都可用）。默认为 False。
group_map (MarlGroupMapType 或 Dict[str, List[str]]], 可选) – 如何在 tensordicts 中对智能体进行分组以进行输入/输出。默认情况下，智能体将按其名称分组。否则，可以指定组映射或从一些预先制作的选项中进行选择。有关更多信息，请参阅 torchrl.envs.utils.MarlGroupMapType。
use_mask (bool, 可选) – 环境是否应该输出 "mask"。在包装的 pettingzoo.AECEnv 中，这对于屏蔽掉未执行操作的智能体是必须的，并且也应该在智能体数量可能发生变化的 pettingzoo.ParallelEnv 中使用。默认为 False。
categorical_actions (bool, 可选) – 如果环境的操作是离散的，则是否将其转换为分类或独热编码。
seed (int, 可选) – 种子。默认为 None。
done_on_any (bool, 可选) – 环境的 done 键是否通过使用 any()（当 True 时）或 all()（当 False 时）聚合智能体键来设置。默认值（None）是对于并行环境使用 any()，对于 AEC 环境使用 all()。

示例

>>> # Parallel env
>>> from torchrl.envs.libs.pettingzoo import PettingZooEnv
>>> kwargs = {"n_pistons": 21, "continuous": True}
>>> env = PettingZooEnv(
...     task="pistonball_v6",
...     parallel=True,
...     return_state=True,
...     group_map=None, # Use default (all pistons grouped together)
...     **kwargs,
... )
>>> print(env.group_map)
... {'piston': ['piston_0', 'piston_1', ..., 'piston_20']}
>>> env.rollout(10)
>>> # AEC env
>>> from torchrl.envs.libs.pettingzoo import PettingZooEnv
>>> from torchrl.envs.utils import MarlGroupMapType
>>> env = PettingZooEnv(
...     task="tictactoe_v3",
...     parallel=False,
...     use_mask=True, # Must use it since one player plays at a time
...     group_map=None # # Use default for AEC (one group per player)
... )
>>> print(env.group_map)
... {'player_1': ['player_1'], 'player_2': ['player_2']}
>>> env.rollout(10)

PettingZooEnv¶

文档

教程

资源