TicTacToeEnv¶

class torchrl.envs.TicTacToeEnv(*args, **kwargs)[原始碼]¶

井字棋實現。

關鍵字引數:

single_player (bool, optional) – 是否需要考慮一個或兩個玩家。 single_player=True 表示 "player1" 隨機行動。如果為 False (預設)，則每回合由兩個玩家中的一個行動。
device (torch.device, optional) – 存放張量的裝置。預設為 None (預設裝置)。

環境是無狀態的。要在多個批次上執行它，請呼叫

>>> env.reset(TensorDict(batch_size=desired_batch_size))

如果存在 "mask" 入口，rand_action 會考慮它來生成下一個動作。在此環境中執行的任何策略都應考慮此掩碼以及玩家的回合 (儲存在 "turn" 輸出入口中)。

規範 (Specs)

>>> print(env.specs)
Composite(
    output_spec: Composite(
        full_observation_spec: Composite(
            board: Categorical(
                shape=torch.Size([3, 3]),
                space=DiscreteBox(n=2),
                dtype=torch.int32,
                domain=discrete),
            turn: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=2),
                dtype=torch.int32,
                domain=discrete),
            mask: Categorical(
                shape=torch.Size([9]),
                space=DiscreteBox(n=2),
                dtype=torch.bool,
                domain=discrete),
            shape=torch.Size([])),
        full_reward_spec: Composite(
            player0: Composite(
                reward: UnboundedContinuous(
                    shape=torch.Size([1]),
                    space=ContinuousBox(
                        low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True),
                        high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)),
                    dtype=torch.float32,
                    domain=continuous),
                shape=torch.Size([])),
            player1: Composite(
                reward: UnboundedContinuous(
                    shape=torch.Size([1]),
                    space=ContinuousBox(
                        low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True),
                        high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)),
                    dtype=torch.float32,
                    domain=continuous),
                shape=torch.Size([])),
            shape=torch.Size([])),
        full_done_spec: Composite(
            done: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=2),
                dtype=torch.bool,
                domain=discrete),
            terminated: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=2),
                dtype=torch.bool,
                domain=discrete),
            truncated: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=2),
                dtype=torch.bool,
                domain=discrete),
            shape=torch.Size([])),
        shape=torch.Size([])),
    input_spec: Composite(
        full_state_spec: Composite(
            board: Categorical(
                shape=torch.Size([3, 3]),
                space=DiscreteBox(n=2),
                dtype=torch.int32,
                domain=discrete),
            turn: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=2),
                dtype=torch.int32,
                domain=discrete),
            mask: Categorical(
                shape=torch.Size([9]),
                space=DiscreteBox(n=2),
                dtype=torch.bool,
                domain=discrete), shape=torch.Size([])),
        full_action_spec: Composite(
            action: Categorical(
                shape=torch.Size([1]),
                space=DiscreteBox(n=9),
                dtype=torch.int64,
                domain=discrete),
            shape=torch.Size([])),
        shape=torch.Size([])),
    shape=torch.Size([]))

要執行一個虛擬 rollout，請執行以下命令

示例

>>> env = TicTacToeEnv()
>>> env.rollout(10)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.int64, is_shared=False),
        board: Tensor(shape=torch.Size([9, 3, 3]), device=cpu, dtype=torch.int32, is_shared=False),
        done: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        mask: Tensor(shape=torch.Size([9, 9]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                board: Tensor(shape=torch.Size([9, 3, 3]), device=cpu, dtype=torch.int32, is_shared=False),
                done: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                mask: Tensor(shape=torch.Size([9, 9]), device=cpu, dtype=torch.bool, is_shared=False),
                player0: TensorDict(
                    fields={
                        reward: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
                    batch_size=torch.Size([9]),
                    device=None,
                    is_shared=False),
                player1: TensorDict(
                    fields={
                        reward: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.float32, is_shared=False)},
                    batch_size=torch.Size([9]),
                    device=None,
                    is_shared=False),
                terminated: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                turn: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.int32, is_shared=False)},
            batch_size=torch.Size([9]),
            device=None,
            is_shared=False),
        terminated: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        turn: Tensor(shape=torch.Size([9, 1]), device=cpu, dtype=torch.int32, is_shared=False)},
    batch_size=torch.Size([9]),
    device=None,
    is_shared=False)

property action_key: NestedKey¶

環境的動作鍵。

預設情況下，這將是“action”。

如果環境中存在多個動作鍵，此函式將引發異常。

property action_keys: list[tensordict._nestedkey.NestedKey]¶

環境的動作鍵。

預設情況下，只會有一個名為“action”的鍵。

鍵按資料樹中的深度排序。

property action_spec: TensorSpec¶

action 規範。

action_spec 始終儲存為複合規範 (composite spec)。

如果動作規範作為簡單規範提供，則返回該簡單規範。

>>> env.action_spec = Unbounded(1)
>>> env.action_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

如果動作規範作為複合規範提供且僅包含一個葉子節點，則此函式僅返回該葉子節點。

>>> env.action_spec = Composite({"nested": {"action": Unbounded(1)}})
>>> env.action_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

如果動作規範作為複合規範提供且包含多個葉子節點，則此函式將返回整個規範。

>>> env.action_spec = Composite({"nested": {"action": Unbounded(1), "another_action": Categorical(1)}})
>>> env.action_spec
Composite(
    nested: Composite(
        action: UnboundedContinuous(
            shape=torch.Size([1]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous),
        another_action: Categorical(
            shape=torch.Size([]),
            space=DiscreteBox(n=1),
            device=cpu,
            dtype=torch.int64,
            domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

要檢索傳遞的完整規範，請使用

>>> env.input_spec["full_action_spec"]

此屬性是可變的。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.action_spec
BoundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

property action_spec_unbatched: TensorSpec¶: 返回環境的動作規範，就像它沒有批處理維度一樣。

add_module(name: str, module: Optional[Module]) → None¶

向當前模組新增一個子模組。

該模組可以使用給定的名稱作為屬性訪問。

引數:

name (str) – 子模組的名稱。可以從當前模組使用此名稱訪問子模組。
module (Module) – 要新增到模組的子模組。

add_truncated_keys() → EnvBase¶: 向環境新增截斷鍵 (truncated keys)。

all_actions(tensordict: TensorDictBase | None = None) → TensorDictBase¶

從動作規範生成所有可能的動作。

這僅適用於完全離散動作的環境。

引數:: tensordict (TensorDictBase, optional) – 如果給定，將使用此 tensordict 呼叫 reset()。
返回:: 一個 tensordict 物件，其“action”入口已更新為所有可能動作的批次。動作在首維度堆疊在一起。

append_transform(transform: Transform | Callable[[TensorDictBase], TensorDictBase]) → EnvBase¶

返回一個轉換後的環境，其中應用了傳遞的可呼叫物件/變換。

引數:: transform (Transform or Callable[[TensorDictBase], TensorDictBase]) – 要應用於環境的變換。

示例

>>> from torchrl.envs import GymEnv
>>> import torch
>>> env = GymEnv("CartPole-v1")
>>> loc = 0.5
>>> scale = 1.0
>>> transform = lambda data: data.set("observation", (data.get("observation") - loc)/scale)
>>> env = env.append_transform(transform=transform)
>>> print(env)
TransformedEnv(
    env=GymEnv(env=CartPole-v1, batch_size=torch.Size([]), device=cpu),
    transform=_CallableTransform(keys=[]))

apply(fn: Callable[[Module], None]) → T¶

遞迴地將 fn 應用於每個子模組（由 .children() 返回）以及自身。

典型用法包括初始化模型的引數（另請參閱 torch.nn.init）。

引數:: fn (Module -> None) – 應用於每個子模組的函式。
返回:: 自身 (self)
返回型別:: 模組

示例

>>> @torch.no_grad()
>>> def init_weights(m):
>>>     print(m)
>>>     if type(m) == nn.Linear:
>>>         m.weight.fill_(1.0)
>>>         print(m.weight)
>>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2))
>>> net.apply(init_weights)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Linear(in_features=2, out_features=2, bias=True)
Parameter containing:
tensor([[1., 1.],
        [1., 1.]], requires_grad=True)
Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)

auto_specs_(policy: Callable[[TensorDictBase], TensorDictBase], *, tensordict: TensorDictBase | None = None, action_key: NestedKey | list[NestedKey] = 'action', done_key: NestedKey | list[NestedKey] | None = None, observation_key: NestedKey | list[NestedKey] = 'observation', reward_key: NestedKey | list[NestedKey] = 'reward')¶

根據使用給定策略進行的隨機 rollout 自動設定環境的規範 (specs)。

此方法使用提供的策略執行 rollout，以推斷環境的輸入和輸出規範。它會根據 rollout 期間收集的資料更新環境的動作、觀測、獎勵和完成訊號的規範。

引數:

policy (Callable[[TensorDictBase], TensorDictBase]) – 一個可呼叫策略，它接收 TensorDictBase 作為輸入，並返回 TensorDictBase 作為輸出。此策略用於執行 rollout 並確定規範。

關鍵字引數:

tensordict (TensorDictBase, optional) – 一個可選的 TensorDictBase 例項，用作 rollout 的初始狀態。如果未提供，將呼叫環境的 reset 方法獲取初始狀態。
action_key (NestedKey or List[NestedKey], optional) – 用於在 TensorDictBase 中識別動作的鍵。預設為“action”。
done_key (NestedKey or List[NestedKey], optional) – 用於在 TensorDictBase 中識別完成訊號的鍵。預設為 None，此時將嘗試使用 [“done”, “terminated”, “truncated”] 作為潛在鍵。
observation_key (NestedKey or List[NestedKey], optional) – 用於在 TensorDictBase 中識別觀測的鍵。預設為“observation”。
reward_key (NestedKey or List[NestedKey], optional) – 用於在 TensorDictBase 中識別獎勵的鍵。預設為“reward”。

返回:

返回:

返回型別:

具有更新規範的環境例項。

引發:

RuntimeError – 如果輸出規範中存在未在提供的鍵中考慮的鍵。

property batch_dims: int¶: 環境的批處理維度數量。

property batch_size: Size¶

此環境例項中批處理的環境數量，以 torch.Size() 物件組織。

環境可能相似或不同，但假定它們之間幾乎沒有（或根本沒有）互動（例如，多工或並行批處理執行）。

bfloat16() → T¶

將所有浮點引數和緩衝區轉換為 bfloat16 資料型別。

注意

此方法會就地修改模組。

返回:: 自身 (self)
返回型別:: 模組

buffers(recurse: bool = True) → Iterator[Tensor]¶

返回模組緩衝區的迭代器。

引數:: recurse (bool) – 如果為 True，則生成此模組和所有子模組的緩衝區。否則，僅生成作為此模組直接成員的緩衝區。
生成 (Yields):: torch.Tensor – 模組緩衝區

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

cardinality(tensordict: TensorDictBase | None = None) → int¶

動作空間的基數 (cardinality)。

預設情況下，這只是 env.action_space.cardinality 的一個包裝器。

當動作規範是可變的時，此類非常有用：

動作的數量可能未定義，例如 Categorical(n=-1)；
動作基數可能取決於動作掩碼；
形狀可以是動態的，如 Unbound(shape=(-1))。

在這些情況下，應該重寫 cardinality()。

引數:: tensordict (TensorDictBase, optional) – 包含計算基數所需資料的 tensordict。

check_env_specs(return_contiguous: bool | None = None, check_dtype=True, seed: int | None = None, tensordict: TensorDictBase | None = None)¶

根據短 rollout 的結果測試環境規範。

此測試函式應用作 sanity check，用於檢查用 torchrl 的 EnvBase 子類包裝的環境：期望資料與收集到的資料之間的任何差異都應引發斷言錯誤。

損壞的環境規範很可能導致無法使用並行環境。

引數:

env (EnvBase) – 需要對照資料檢查規範的環境。
return_contiguous (bool, optional) – 如果為 True，隨機 rollout 將以 return_contiguous=True 呼叫。在某些情況下（例如，輸入/輸出形狀異構）這將失敗。預設為 None（由動態規範的存在確定）。
check_dtype (bool, optional) – 如果為 False，將跳過 dtype 檢查。預設為 True。
seed (int, optional) – 為了重現性，可以設定種子。種子將暫時在 pytorch 中設定，然後 RNG 狀態將恢復到之前狀態。對於環境，我們設定種子，但由於大多數環境不具備將 rng 狀態恢復到之前狀態的功能，我們將其留給使用者完成。預設為 None。
tensordict (TensorDict, optional) – 可選的 tensordict 例項，用於重置。

注意：此函式會重置環境種子。它應用於“離線”檢查環境是否正確構建，但可能會影響實驗的種子設定，因此應避免在訓練指令碼中使用。

children() → Iterator[Module]¶

返回直接子模組的迭代器。

生成 (Yields):: Module – 子模組

compile(*args, **kwargs)¶

使用 torch.compile() 編譯此模組的 forward。

此模組的 __call__ 方法將被編譯，所有引數將原樣傳遞給 torch.compile()。

有關此函式引數的詳細資訊，請參閱 torch.compile()。

cpu() → T¶

將所有模型引數和緩衝區移動到 CPU。

注意

此方法會就地修改模組。

返回:: 自身 (self)
返回型別:: 模組

cuda(device: Optional[Union[int, device]] = None) → T¶

將所有模型引數和緩衝區移動到 GPU。

這也會使相關的引數和緩衝區成為不同的物件。因此，如果在最佳化模組時模組將駐留在 GPU 上，應在構建最佳化器之前呼叫此方法。

注意

此方法會就地修改模組。

引數:: device (int, optional) – 如果指定，所有引數將被複制到該裝置。
返回:: 自身 (self)
返回型別:: 模組

property done_key¶

環境的完成鍵 (done key)。

預設情況下，這將是“done”。

如果環境中存在多個完成鍵，此函式將引發異常。

property done_keys: list[tensordict._nestedkey.NestedKey]¶

環境的完成鍵 (done keys)。

預設情況下，只會有一個名為“done”的鍵。

鍵按資料樹中的深度排序。

property done_keys_groups¶

完成鍵的列表，按重置鍵分組。

這是一個列表的列表。外層列表的長度與重置鍵的數量相同，內層列表包含可以讀取以確定何時進行重置的完成鍵（例如，done 和 truncated），當它們不存在時。

property done_spec: TensorSpec¶

done 規範。

done_spec 始終儲存為複合規範 (composite spec)。

如果完成規範作為簡單規範提供，則返回該簡單規範。

>>> env.done_spec = Categorical(2, dtype=torch.bool)
>>> env.done_spec
Categorical(
    shape=torch.Size([]),
    space=DiscreteBox(n=2),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

如果完成規範作為複合規範提供且僅包含一個葉子節點，則此函式僅返回該葉子節點。

>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool)}})
>>> env.done_spec
Categorical(
    shape=torch.Size([]),
    space=DiscreteBox(n=2),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

如果完成規範作為複合規範提供且包含多個葉子節點，則此函式將返回整個規範。

>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool), "another_done": Categorical(2, dtype=torch.bool)}})
>>> env.done_spec
Composite(
    nested: Composite(
        done: Categorical(
            shape=torch.Size([]),
            space=DiscreteBox(n=2),
            device=cpu,
            dtype=torch.bool,
            domain=discrete),
        another_done: Categorical(
            shape=torch.Size([]),
            space=DiscreteBox(n=2),
            device=cpu,
            dtype=torch.bool,
            domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

要始終檢索傳遞的完整規範，請使用

>>> env.output_spec["full_done_spec"]

此屬性是可變的。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.done_spec
Categorical(
    shape=torch.Size([1]),
    space=DiscreteBox(n=2),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)

屬性 done_spec_unbatched: TensorSpec¶: 返回環境的 done spec，如同它沒有批次維度一樣。

double() → T¶

將所有浮點引數和緩衝區轉換為 double 資料型別。

注意

此方法會就地修改模組。

返回:: 自身 (self)
返回型別:: 模組

empty_cache()¶

清除所有快取值。

對於常規環境，鍵列表（獎勵、完成狀態等）會被快取，但在某些情況下（例如新增轉換時），它們可能在程式碼執行期間發生變化。

eval() → T¶

將模組設定為評估模式。

這僅對某些模組有效。有關特定模組在訓練/評估模式下的行為細節，即它們是否受影響，例如 Dropout、BatchNorm 等，請參閱其文件。

這等同於呼叫 self.train(False)。

有關 .eval() 與可能與之混淆的幾個類似機制之間的比較，請參閱 Locally disabling gradient computation。

返回:: 自身 (self)
返回型別:: 模組

extra_repr() → str¶

返回模組的額外表示。

要列印自定義的額外資訊，您應在自己的模組中重新實現此方法。單行和多行字串均可接受。

fake_tensordict() → TensorDictBase¶: 返回一個偽造的 tensordict，其鍵值對在形狀、裝置和資料型別上與環境 rollout 期間可能預期的一致。

float() → T¶

將所有浮點引數和緩衝區轉換為 float 資料型別。

注意

此方法會就地修改模組。

返回:: 自身 (self)
返回型別:: 模組

forward(*args, **kwargs)¶

定義每次呼叫時執行的計算。

應由所有子類重寫。

注意

雖然前向傳播的邏輯需要在本函式中定義，但之後應呼叫 Module 例項，而不是直接呼叫此函式，因為前者會負責執行已註冊的鉤子（hooks），而後者會靜默忽略它們。

屬性 full_action_spec: Composite¶

完整的動作規範（action spec）。

full_action_spec 是一個 Composite` 例項，包含所有動作條目（action entries）。

示例

>>> from torchrl.envs import BraxEnv
>>> for envname in BraxEnv.available_envs:
...     break
>>> env = BraxEnv(envname)
>>> env.full_action_spec
Composite(
    action: BoundedContinuous(
        shape=torch.Size([8]),
        space=ContinuousBox(
            low=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True),
            high=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True)),
        device=cpu,
        dtype=torch.float32,
        domain=continuous), device=cpu, shape=torch.Size([]))

屬性 full_action_spec_unbatched: Composite¶: 返回環境的動作規範，就像它沒有批處理維度一樣。

屬性 full_done_spec: Composite¶

完整的完成狀態規範（done spec）。

full_done_spec 是一個 Composite` 例項，包含所有完成狀態條目（done entries）。它可用於生成結構與執行時獲得的結構相似的偽造資料。

示例

>>> import gymnasium
>>> from torchrl.envs import GymWrapper
>>> env = GymWrapper(gymnasium.make("Pendulum-v1"))
>>> env.full_done_spec
Composite(
    done: Categorical(
        shape=torch.Size([1]),
        space=DiscreteBox(n=2),
        device=cpu,
        dtype=torch.bool,
        domain=discrete),
    truncated: Categorical(
        shape=torch.Size([1]),
        space=DiscreteBox(n=2),
        device=cpu,
        dtype=torch.bool,
        domain=discrete), device=cpu, shape=torch.Size([]))

屬性 full_done_spec_unbatched: Composite¶: 返回環境的 done spec，如同它沒有批次維度一樣。

屬性 full_observation_spec_unbatched: Composite¶: 返回環境的觀察規範（observation spec），如同它沒有批次維度一樣。

屬性 full_reward_spec: Composite¶

完整的獎勵規範（reward spec）。

full_reward_spec 是一個 Composite` 例項，包含所有獎勵條目（reward entries）。

示例

>>> import gymnasium
>>> from torchrl.envs import GymWrapper, TransformedEnv, RenameTransform
>>> base_env = GymWrapper(gymnasium.make("Pendulum-v1"))
>>> env = TransformedEnv(base_env, RenameTransform("reward", ("nested", "reward")))
>>> env.full_reward_spec
Composite(
    nested: Composite(
        reward: UnboundedContinuous(
            shape=torch.Size([1]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=None, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

屬性 full_reward_spec_unbatched: Composite¶: 返回環境的獎勵規範（reward spec），如同它沒有批次維度一樣。

屬性 full_state_spec: Composite¶

完整的狀態規範（state spec）。

full_state_spec 是一個 Composite` 例項，包含所有狀態條目（即非動作的輸入資料）。

示例

>>> from torchrl.envs import BraxEnv
>>> for envname in BraxEnv.available_envs:
...     break
>>> env = BraxEnv(envname)
>>> env.full_state_spec
Composite(
    state: Composite(
        pipeline_state: Composite(
            q: UnboundedContinuous(
                shape=torch.Size([15]),
                space=None,
                device=cpu,
                dtype=torch.float32,
                domain=continuous),
    [...], device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

屬性 full_state_spec_unbatched: Composite¶: 返回環境的狀態規範（state spec），如同它沒有批次維度一樣。

get_buffer(target: str) → Tensor¶

返回由 target 指定的緩衝區（如果存在），否則丟擲錯誤。

有關本方法功能的更詳細說明以及如何正確指定 target，請參閱 get_submodule 的文件字串。

引數:: target (str) – 要查詢的緩衝區的完全限定字串名稱。（有關如何指定完全限定字串，請參閱 get_submodule。）
返回:: 由 target 引用的緩衝區
返回型別:: torch.Tensor
引發:: AttributeError – 如果 target 字串引用了無效路徑或解析為非緩衝區的物件

get_extra_state() → Any¶

返回要包含在模組 state_dict 中的任何額外狀態。

如果您需要儲存額外狀態，請為您的模組實現此方法以及相應的 set_extra_state()。在構建模組的 state_dict() 時會呼叫此函式。

請注意，額外狀態應可序列化（picklable），以確保 state_dict 的序列化正常工作。我們僅為 Tensors 的序列化提供向後相容性保證；如果其他物件的序列化形式發生變化，可能會破壞向後相容性。

返回:: 要儲存在模組 state_dict 中的任何額外狀態
返回型別:: object

get_parameter(target: str) → Parameter¶

返回由 target 指定的引數（如果存在），否則丟擲錯誤。

有關本方法功能的更詳細說明以及如何正確指定 target，請參閱 get_submodule 的文件字串。

引數:: target (str) – 要查詢的 Parameter 的完全限定字串名稱。（有關如何指定完全限定字串，請參閱 get_submodule。）
返回:: 由 target 引用的 Parameter
返回型別:: torch.nn.Parameter
引發:: AttributeError – 如果 target 字串引用了無效路徑或解析為非 nn.Parameter 的物件

get_submodule(target: str) → Module¶

返回由 target 指定的子模組（如果存在），否則丟擲錯誤。

例如，假設您有一個 nn.Module A，其結構如下：

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

(圖示顯示了一個 nn.Module A。`A` 有一個巢狀子模組 net_b，`net_b` 本身有兩個子模組 net_c 和 linear。`net_c` 還有一個子模組 conv。)

要檢查我們是否有 linear 子模組，可以呼叫 get_submodule("net_b.linear")。要檢查我們是否有 conv 子模組，可以呼叫 get_submodule("net_b.net_c.conv")。

get_submodule 的執行時受 target 中模組巢狀深度的限制。對 named_modules 的查詢也能達到同樣的結果，但其複雜度與傳遞性模組的數量呈 O(N)。因此，對於簡單檢查某個子模組是否存在的情況，應始終使用 get_submodule。

引數:: target (str) – 要查詢的子模組的完全限定字串名稱。（有關如何指定完全限定字串，請參閱上述示例。）
返回:: 由 target 引用的子模組
返回型別:: torch.nn.Module
引發:: AttributeError – 如果 target 字串引用了無效路徑或解析為非 nn.Module 的物件

half() → T¶

將所有浮點引數和緩衝區轉換為 half 資料型別。

注意

此方法會就地修改模組。

返回:: 自身 (self)
返回型別:: 模組

屬性 input_spec: TensorSpec¶

輸入規範（Input spec）。

包含所有環境輸入資料規範的複合規範（composite spec）。

它包含：

“full_action_spec”：輸入動作的規範
“full_state_spec”：所有其他環境輸入的規範

此屬性已鎖定且應為只讀。相反，要設定其中包含的規範，請使用相應的屬性。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.input_spec
Composite(
    full_state_spec: None,
    full_action_spec: Composite(
        action: BoundedContinuous(
            shape=torch.Size([1]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

屬性 input_spec_unbatched: Composite¶: 返回環境的輸入規範（input spec），如同它沒有批次維度一樣。

ipu(device: Optional[Union[int, device]] = None) → T¶

將所有模型引數和緩衝區移動到 IPU。

這也會使相關的引數和緩衝區成為不同的物件。因此，如果模組將在 IPU 上進行最佳化，應在構建最佳化器之前呼叫此方法。

注意

此方法會就地修改模組。

引數:: device (int, optional) – 如果指定，所有引數將被複制到該裝置。
返回:: 自身 (self)
返回型別:: 模組

屬性 is_spec_locked¶

獲取環境的規範（specs）是否已鎖定。

此屬性可以直接修改。

返回:: 如果規範已鎖定，則為 True，否則為 False。
返回型別:: bool

另請參閱

鎖定環境規範.

load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)¶

將引數和緩衝區從 state_dict 複製到當前模組及其後代模組中。

如果 strict 為 True，則 state_dict 的鍵必須與當前模組 state_dict() 函式返回的鍵完全匹配。

警告

如果 assign 為 True，則除非 get_swap_module_params_on_conversion() 為 True，否則必須在呼叫 load_state_dict 後建立最佳化器。

引數:

state_dict (dict) – 包含引數和持久緩衝區的字典。
strict (bool, 可選) – 是否嚴格要求 state_dict 中的鍵與當前模組 state_dict() 函式返回的鍵匹配。預設值：True
assign (bool, 可選) – 設定為 False 時，保留當前模組中張量的屬性，而設定為 True 時，保留 state dict 中張量的屬性。唯一的例外是 Parameter 的 requires_grad 欄位。預設值：False`

返回:

missing_keys 是一個 str 列表，包含當前模組預期但在提供的 state_dict 中缺失的所有鍵。
unexpected_keys 是一個 str 列表，包含當前模組不預期但在提供的 state_dict 中出現的所有鍵。

返回型別:

帶有 missing_keys 和 unexpected_keys 欄位的 NamedTuple

注意

如果引數或緩衝區註冊為 None 且其對應的鍵存在於 state_dict 中，load_state_dict() 將引發 RuntimeError。

maybe_reset(tensordict: TensorDictBase) → TensorDictBase¶

檢查輸入 tensordict 的完成狀態鍵（done keys），並在需要時，在環境已完成（done）的地方重置環境。

引數:: tensordict (TensorDictBase) – 來自 step_mdp() 輸出的 tensordict。
返回:: 一個 tensordict，對於環境未重置的部分與輸入相同，對於環境已重置的部分包含新的重置資料。

modules() → Iterator[Module]¶

返回一個迭代器，遍歷網路中的所有模組。

生成 (Yields):: Module – 網路中的一個模組

注意

重複的模組只返回一次。在下面的示例中，l 將只返回一次。

示例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.modules()):
...     print(idx, '->', m)

0 -> Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
)
1 -> Linear(in_features=2, out_features=2, bias=True)

mtia(device: Optional[Union[int, device]] = None) → T¶

將所有模型引數和緩衝區移動到 MTIA。

這也會使相關的引數和緩衝區成為不同的物件。因此，如果模組將在 MTIA 上進行最佳化，應在構建最佳化器之前呼叫此方法。

注意

此方法會就地修改模組。

引數:: device (int, optional) – 如果指定，所有引數將被複制到該裝置。
返回:: 自身 (self)
返回型別:: 模組

named_buffers(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[Tuple[str, Tensor]]¶

返回一個迭代器，遍歷模組緩衝區，同時生成緩衝區的名稱和緩衝區本身。

引數:

prefix (str) – 要新增到所有緩衝區名稱前的字串字首。
recurse (bool, 可選) – 如果為 True，則生成當前模組及其所有子模組的緩衝區。否則，僅生成當前模組的直接成員緩衝區。預設值：True。
remove_duplicate (bool, 可選) – 是否移除結果中的重複緩衝區。預設值：True。

生成 (Yields):

(str, torch.Tensor) – 包含名稱和緩衝區的元組

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, buf in self.named_buffers():
>>>     if name in ['running_var']:
>>>         print(buf.size())

named_children() → Iterator[Tuple[str, Module]]¶

返回一個迭代器，遍歷直接子模組，同時生成模組的名稱和模組本身。

生成 (Yields):: (str, Module) – 包含名稱和子模組的元組

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, module in model.named_children():
>>>     if name in ['conv4', 'conv5']:
>>>         print(module)

named_modules(memo: Optional[Set[Module]] = None, prefix: str = '', remove_duplicate: bool = True)¶

返回網路中所有模組的迭代器，同時生成模組的名稱和模組本身。

引數:

memo – 一個備忘錄，用於儲存已新增到結果中的模組集合
prefix – 將新增到模組名稱的字首
remove_duplicate – 是否移除結果中的重複模組例項

生成 (Yields):

(str, Module) – 名稱和模組的元組

注意

重複的模組只返回一次。在下面的示例中，l 將只返回一次。

示例

>>> l = nn.Linear(2, 2)
>>> net = nn.Sequential(l, l)
>>> for idx, m in enumerate(net.named_modules()):
...     print(idx, '->', m)

0 -> ('', Sequential(
  (0): Linear(in_features=2, out_features=2, bias=True)
  (1): Linear(in_features=2, out_features=2, bias=True)
))
1 -> ('0', Linear(in_features=2, out_features=2, bias=True))

named_parameters(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) → Iterator[Tuple[str, Parameter]]¶

返回模組引數的迭代器，同時生成引數的名稱和引數本身。

引數:

prefix (str) – 新增到所有引數名稱前的字串字首。
recurse (bool) – 如果為 True，則生成此模組及其所有子模組的引數。否則，只生成直接屬於此模組的引數。
remove_duplicate (bool, optional) – 是否移除結果中的重複引數。預設為 True。

生成 (Yields):

(str, Parameter) – 包含名稱和引數的元組

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for name, param in self.named_parameters():
>>>     if name in ['bias']:
>>>         print(param.size())

property observation_keys: list[tensordict._nestedkey.NestedKey]¶

環境的觀察鍵。

預設情況下，只有一個名為“observation”的鍵。

鍵按資料樹中的深度排序。

property observation_spec: Composite¶

觀察規範。

必須是 torchrl.data.Composite 例項。規範中列出的鍵在 reset 和 step 後可直接訪問。

在 TorchRL 中，即使它們嚴格來說不是“觀察”，環境中輸出的所有資訊（info）、狀態（states）、變換結果（results of transforms）等都儲存在 observation_spec 中。

因此，"observation_spec" 應被視為一個通用資料容器，用於存放除 done 或 reward 資料之外的環境輸出。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.observation_spec
Composite(
    observation: BoundedContinuous(
        shape=torch.Size([3]),
        space=ContinuousBox(
            low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True),
            high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)),
        device=cpu,
        dtype=torch.float32,
        domain=continuous), device=cpu, shape=torch.Size([]))

property observation_spec_unbatched: Composite¶: 返回環境的觀察規範（observation spec），如同它沒有批次維度一樣。

property output_spec: TensorSpec¶

輸出規範。

包含環境中所有資料輸出規範的 Composite 規範。

它包含：

“full_reward_spec”：獎勵規範
“full_done_spec”：完成狀態規範
“full_observation_spec”：所有其他環境輸出的規範

此屬性已鎖定且應為只讀。相反，要設定其中包含的規範，請使用相應的屬性。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.output_spec
Composite(
    full_reward_spec: Composite(
        reward: UnboundedContinuous(
            shape=torch.Size([1]),
            space=None,
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=cpu, shape=torch.Size([])),
    full_observation_spec: Composite(
        observation: BoundedContinuous(
            shape=torch.Size([3]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous), device=cpu, shape=torch.Size([])),
    full_done_spec: Composite(
        done: Categorical(
            shape=torch.Size([1]),
            space=DiscreteBox(n=2),
            device=cpu,
            dtype=torch.bool,
            domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

property output_spec_unbatched: Composite¶: 返回環境的輸出規範，視其沒有批處理維度。

parameters(recurse: bool = True) → Iterator[Parameter]¶

返回模組引數的迭代器。

這通常傳遞給最佳化器。

引數:: recurse (bool) – 如果為 True，則生成此模組及其所有子模組的引數。否則，只生成直接屬於此模組的引數。
生成 (Yields):: Parameter – 模組引數

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> for param in model.parameters():
>>>     print(type(param), param.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

rand_action(tensordict: Optional[TensorDictBase] = None)[source]¶

根據 action_spec 屬性執行一個隨機動作。

引數:: tensordict (TensorDictBase, optional) – 應寫入結果動作的 tensordict。
返回:: 一個 tensordict 物件，其中的“action”條目已更新為來自 action-spec 的隨機樣本。

rand_step(tensordict: TensorDictBase | None = None) → TensorDictBase¶

根據 action_spec 屬性在環境中執行隨機步驟。

引數:: tensordict (TensorDictBase, optional) – 應寫入結果資訊的 tensordict。
返回:: 一個 tensordict 物件，其中包含在環境中隨機執行一步後的新觀察結果。動作將儲存在“action”鍵下。

register_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor], Union[None, Tuple[Tensor, ...], Tensor]]) → RemovableHandle¶

在模組上註冊一個反向傳播鉤子。

此函式已被棄用，請改用 register_full_backward_hook()，此函式的行為將在未來版本中更改。

返回:: 一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子
返回型別:: torch.utils.hooks.RemovableHandle

register_buffer(name: str, tensor: Optional[Tensor], persistent: bool = True) → None¶

向模組新增一個緩衝區。

這通常用於註冊不應被視為模型引數的緩衝區。例如，BatchNorm 的 running_mean 不是引數，但卻是模組狀態的一部分。緩衝區預設是持久的，將與引數一起儲存。可以透過將 persistent 設定為 False 來更改此行為。持久緩衝區和非持久緩衝區之間的唯一區別在於，後者不會成為此模組 state_dict 的一部分。

可以使用給定的名稱作為屬性訪問緩衝區。

引數:

name (str) – 緩衝區的名稱。可以使用給定的名稱從此模組訪問緩衝區
tensor (Tensor or None) – 要註冊的緩衝區。如果為 None，則在緩衝區上執行的操作（例如 cuda）將被忽略。如果為 None，緩衝區不包含在此模組的 state_dict 中。
persistent (bool) – 緩衝區是否為此模組 state_dict 的一部分。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook: Union[Callable[[T, Tuple[Any, ...], Any], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) → RemovableHandle¶

在模組上註冊一個正向傳播鉤子。

鉤子將在每次 forward() 計算輸出後被呼叫。

如果 with_kwargs 為 False 或未指定，輸入只包含傳遞給模組的位置引數。關鍵字引數不會傳遞給鉤子，只會傳遞給 forward。鉤子可以修改輸出。它可以在原地修改輸入，但這不會影響 forward，因為這是在呼叫 forward() 之後呼叫的。鉤子應具有以下簽名

hook(module, args, output) -> None or modified output

如果 with_kwargs 為 True，正向傳播鉤子將接收傳遞給 forward 函式的 kwargs，並應返回可能已修改的輸出。鉤子應具有以下簽名

hook(module, args, kwargs, output) -> None or modified output

引數:

hook (Callable) – 要註冊的使用者定義鉤子。
prepend (bool) – 如果為 True，則提供的 hook 將在此 torch.nn.modules.Module 上所有現有 forward 鉤子之前觸發。否則，提供的 hook 將在此 torch.nn.modules.Module 上所有現有 forward 鉤子之後觸發。請注意，使用 register_module_forward_hook() 註冊的全域性 forward 鉤子將在透過此方法註冊的所有鉤子之前觸發。預設值：False
with_kwargs (bool) – 如果為 True，則鉤子將接收傳遞給 forward 函式的關鍵字引數。預設值：False
always_call (bool) – 如果為 True，無論呼叫 Module 時是否引發異常，鉤子都將執行。預設值：False

返回:

一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子

返回型別:

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook: Union[Callable[[T, Tuple[Any, ...]], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any]], Optional[Tuple[Any, Dict[str, Any]]]]], *, prepend: bool = False, with_kwargs: bool = False) → RemovableHandle¶

在模組上註冊一個正向傳播前鉤子。

鉤子將在每次呼叫 forward() 之前被呼叫。

如果 with_kwargs 為 false 或未指定，輸入只包含傳遞給模組的位置引數。關鍵字引數不會傳遞給鉤子，只會傳遞給 forward。鉤子可以修改輸入。使用者可以在鉤子中返回一個元組或一個修改後的單個值。如果返回單個值，我們將把該值封裝到元組中（除非該值已經是元組）。鉤子應具有以下簽名

hook(module, args) -> None or modified input

如果 with_kwargs 為 true，正向傳播前鉤子將接收傳遞給 forward 函式的關鍵字引數。如果鉤子修改了輸入，則應返回 args 和 kwargs 兩者。鉤子應具有以下簽名

hook(module, args, kwargs) -> None or a tuple of modified input and kwargs

引數:

hook (Callable) – 要註冊的使用者定義鉤子。
prepend (bool) – 如果為 true，則提供的 hook 將在此 torch.nn.modules.Module 上所有現有 forward_pre 鉤子之前觸發。否則，提供的 hook 將在此 torch.nn.modules.Module 上所有現有 forward_pre 鉤子之後觸發。請注意，使用 register_module_forward_pre_hook() 註冊的全域性 forward_pre 鉤子將在透過此方法註冊的所有鉤子之前觸發。預設值：False
with_kwargs (bool) – 如果為 true，則鉤子將接收傳遞給 forward 函式的關鍵字引數。預設值：False

返回:

一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子

返回型別:

torch.utils.hooks.RemovableHandle

register_full_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle¶

在模組上註冊一個反向傳播鉤子。

每次計算相對於模組的梯度時，鉤子都會被呼叫，即只有當計算了相對於模組輸出的梯度時，鉤子才會執行。鉤子應具有以下簽名

hook(module, grad_input, grad_output) -> tuple(Tensor) or None

grad_input 和 grad_output 是元組，分別包含相對於輸入和輸出的梯度。鉤子不應修改其引數，但它可以選擇性地返回一個新的相對於輸入的梯度，該梯度將在後續計算中代替 grad_input 使用。grad_input 只對應於作為位置引數給定的輸入，所有關鍵字引數都被忽略。對於所有非 Tensor 引數，grad_input 和 grad_output 中的條目將為 None。

出於技術原因，當此鉤子應用於 Module 時，其 forward 函式將接收傳遞給 Module 的每個 Tensor 的檢視。類似地，呼叫者將接收 Module 的 forward 函式返回的每個 Tensor 的檢視。

警告

使用反向傳播鉤子時，不允許原地修改輸入或輸出，否則會引發錯誤。

引數:

hook (Callable) – 要註冊的使用者定義鉤子。
prepend (bool) – 如果為 true，則提供的 hook 將在此 torch.nn.modules.Module 上所有現有 backward 鉤子之前觸發。否則，提供的 hook 將在此 torch.nn.modules.Module 上所有現有 backward 鉤子之後觸發。請注意，使用 register_module_full_backward_hook() 註冊的全域性 backward 鉤子將在透過此方法註冊的所有鉤子之前觸發。

返回:

一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子

返回型別:

torch.utils.hooks.RemovableHandle

register_full_backward_pre_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) → RemovableHandle¶

在模組上註冊一個反向預鉤子。

每次計算模組的梯度時，都會呼叫此鉤子。該鉤子應具有以下簽名：

hook(module, grad_output) -> tuple[Tensor] or None

grad_output 是一個元組。鉤子不應修改其引數，但可以選擇返回一個新的相對於輸出的梯度，該梯度將在後續計算中取代 grad_output 使用。grad_output 中的非 Tensor 引數條目將為 None。

出於技術原因，當此鉤子應用於 Module 時，其 forward 函式將接收傳遞給 Module 的每個 Tensor 的檢視。類似地，呼叫者將接收 Module 的 forward 函式返回的每個 Tensor 的檢視。

警告

使用反向鉤子時不允許就地修改輸入，否則會引發錯誤。

引數:

hook (Callable) – 要註冊的使用者定義鉤子。
prepend (bool) – 如果為 True，則提供的 hook 將在此 torch.nn.modules.Module 上所有現有 backward_pre 鉤子之前觸發。否則，提供的 hook 將在此 torch.nn.modules.Module 上所有現有 backward_pre 鉤子之後觸發。請注意，使用 register_module_full_backward_pre_hook() 註冊的全域性 backward_pre 鉤子將在此方法註冊的所有鉤子之前觸發。

返回:

一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子

返回型別:

torch.utils.hooks.RemovableHandle

classmethod register_gym(id: str, *, entry_point: Callable | None = None, transform: Transform | None = None, info_keys: list[NestedKey] | None = None, backend: str = None, to_numpy: bool = False, reward_threshold: float | None = None, nondeterministic: bool = False, max_episode_steps: int | None = None, order_enforce: bool = True, autoreset: bool = False, disable_env_checker: bool = False, apply_api_compatibility: bool = False, **kwargs)¶

在 gym(nasium) 中註冊環境。

此方法的目的是考慮以下範圍：

將 TorchRL優先的環境整合到使用 Gym 的框架中；
將其他環境（例如，DeepMind Control、Brax、Jumanji 等）整合到使用 Gym 的框架中。

引數:

id (str) – 環境的名稱。應遵循 gym 命名約定。

關鍵字引數:

entry_point (callable, optional) –

構建環境的入口點。如果未傳遞，則使用父類作為入口點。通常，這用於註冊不一定繼承自正在使用的基類的環境

>>> from torchrl.envs import DMControlEnv
>>> DMControlEnv.register_gym("DMC-cheetah-v0", env_name="cheetah", task="run")
>>> # equivalently
>>> EnvBase.register_gym("DMC-cheetah-v0", entry_point=DMControlEnv, env_name="cheetah", task="run")

transform (torchrl.envs.Transform) – 與環境一起使用的轉換（或 torchrl.envs.Compose 例項中的轉換列表）。此引數可在呼叫 make() 時傳遞（見下文示例）。
info_keys (List[NestedKey], optional) –
如果提供，這些鍵將用於構建資訊字典，並從觀察鍵中排除。此引數可在呼叫 make() 時傳遞（見下文示例）。

警告

使用 info_keys 可能會導致 spec 為空，因為內容已移至資訊字典。Gym 不喜歡 spec 中的空 Dict，因此應使用 RemoveEmptySpecs 移除此空內容。
backend (str, optional) – 後端。可以是 “gym” 或 “gymnasium”，或任何其他與 set_gym_backend 相容的後端。
to_numpy (bool, optional) – 如果為 True，則呼叫 step 和 reset 的結果將被對映到 numpy 陣列。預設為 False（結果為張量）。此引數可在呼叫 make() 時傳遞（見下文示例）。
reward_threshold (float, optional) – [Gym kwarg] 認為已學會環境的獎勵閾值。
nondeterministic (bool, optional) – [Gym kwarg] 如果環境是非確定性的（即使知道初始種子和所有動作）。預設為 False。
max_episode_steps (int, optional) – [Gym kwarg] 截斷前的最大劇集步數。由 Time Limit wrapper 使用。
order_enforce (bool, optional) – [Gym >= 0.14] 是否應應用順序執行 wrapper，以確保使用者按正確順序執行函式。預設為 True。
autoreset (bool, optional) – [Gym >= 0.14] 是否應新增自動重置 wrapper，以便無需呼叫 reset。預設為 False。
disable_env_checker – [Gym >= 0.14] 是否應對環境停用環境檢查器。預設為 False。
apply_api_compatibility – [Gym >= 0.26] 是否應用 StepAPICompatibility wrapper。預設為 False。
**kwargs – 任意關鍵字引數，將傳遞給環境建構函式。

注意

TorchRL 的環境沒有 "info" 字典的概念，因為 TensorDict 提供了在大多數訓練設定中被認為必要的所有儲存需求。儘管如此，您可以使用 info_keys 引數精細控制哪些被視為觀察，哪些應被視為資訊。

示例

>>> # Register the "cheetah" env from DMControl with the "run" task
>>> from torchrl.envs import DMControlEnv
>>> import torch
>>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gym", env_name="cheetah", task_name="run")
>>> import gym
>>> envgym = gym.make("DMC-cheetah-v0")
>>> envgym.seed(0)
>>> torch.manual_seed(0)
>>> envgym.reset()
({'position': tensor([-0.0855,  0.0215, -0.0881, -0.0412, -0.1101,  0.0080,  0.0254,  0.0424],
       dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03,  3.3842e-02,  2.5338e-02,
         3.3064e-02,  1.0381e-04,  7.6656e-05,  1.0204e-02],
       dtype=torch.float64)}, {})
>>> envgym.step(envgym.action_space.sample())
({'position': tensor([-0.0833,  0.0275, -0.0612, -0.0770, -0.1256,  0.0082,  0.0186,  0.0476],
       dtype=torch.float64), 'velocity': tensor([ 0.2221,  0.2256,  0.5930,  2.6937, -3.5865, -1.5479,  0.0187, -0.6825,
         0.5224], dtype=torch.float64)}, tensor([0.0018], dtype=torch.float64), tensor([False]), tensor([False]), {})
>>> # same environment with observation stacked
>>> from torchrl.envs import CatTensors
>>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation"))
>>> envgym.reset()
({'observation': tensor([-0.1005,  0.0335, -0.0268,  0.0133, -0.0627,  0.0074, -0.0488, -0.0353,
        -0.0075, -0.0069,  0.0098, -0.0058,  0.0033, -0.0157, -0.0004, -0.0381,
        -0.0452], dtype=torch.float64)}, {})
>>> # same environment with numpy observations
>>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation"), to_numpy=True)
>>> envgym.reset()
({'observation': array([-0.11355747,  0.04257728,  0.00408397,  0.04155852, -0.0389733 ,
       -0.01409826, -0.0978704 , -0.08808327,  0.03970837,  0.00535434,
       -0.02353762,  0.05116226,  0.02788907,  0.06848346,  0.05154399,
        0.0371798 ,  0.05128025])}, {})
>>> # If gymnasium is installed, we can register the environment there too.
>>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gymnasium", env_name="cheetah", task_name="run")
>>> import gymnasium
>>> envgym = gymnasium.make("DMC-cheetah-v0")
>>> envgym.seed(0)
>>> torch.manual_seed(0)
>>> envgym.reset()
({'position': tensor([-0.0855,  0.0215, -0.0881, -0.0412, -0.1101,  0.0080,  0.0254,  0.0424],
       dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03,  3.3842e-02,  2.5338e-02,
         3.3064e-02,  1.0381e-04,  7.6656e-05,  1.0204e-02],
       dtype=torch.float64)}, {})

注意

此功能也適用於無狀態環境（例如，BraxEnv）。

>>> import gymnasium
>>> import torch
>>> from tensordict import TensorDict
>>> from torchrl.envs import BraxEnv, SelectTransform
>>>
>>> # get action for dydactic purposes
>>> env = BraxEnv("ant", batch_size=[2])
>>> env.set_seed(0)
>>> torch.manual_seed(0)
>>> td = env.rollout(10)
>>>
>>> actions = td.get("action")
>>>
>>> # register env
>>> env.register_gym("Brax-Ant-v0", env_name="ant", batch_size=[2], info_keys=["state"])
>>> gym_env = gymnasium.make("Brax-Ant-v0")
>>> gym_env.seed(0)
>>> torch.manual_seed(0)
>>>
>>> gym_env.reset()
>>> obs = []
>>> for i in range(10):
...     obs, reward, terminated, truncated, info = gym_env.step(td[..., i].get("action"))

register_load_state_dict_post_hook(hook)¶

註冊一個後置鉤子，在呼叫模組的 load_state_dict() 後執行。

它應具有以下簽名：: hook(module, incompatible_keys) -> None

module 引數是註冊此鉤子的當前模組，而 incompatible_keys 引數是一個 NamedTuple，包含屬性 missing_keys 和 unexpected_keys。missing_keys 是包含缺失鍵的 str 的 list，unexpected_keys 是包含意外部索引鍵的 str 的 list。

如果需要，可以就地修改給定的 incompatible_keys。

請注意，呼叫 load_state_dict() 並設定 strict=True 時執行的檢查會受到鉤子對 missing_keys 或 unexpected_keys 所做修改的影響，這是預期行為。向任何一組鍵新增內容都會在 strict=True 時引發錯誤，而清除缺失和意外部索引鍵則會避免錯誤。

返回:: 一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子
返回型別:: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)¶

註冊一個預置鉤子，在呼叫模組的 load_state_dict() 之前執行。

它應具有以下簽名：: hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

引數:: hook (Callable) – 在載入狀態字典之前將被呼叫的可呼叫鉤子。

register_module(name: str, module: Optional[Module]) → None¶: add_module() 的別名。

register_parameter(name: str, param: Optional[Parameter]) → None¶

向模組新增一個引數。

可以使用給定名稱作為屬性訪問該引數。

引數:

name (str) – 引數的名稱。可以使用給定名稱從此模組訪問該引數
param (Parameter or None) – 要新增到模組的引數。如果為 None，則對引數執行的操作（例如 cuda）將被忽略。如果為 None，則引數不包含在模組的 state_dict 中。

register_state_dict_post_hook(hook)¶

為 state_dict() 方法註冊一個後置鉤子。

它應具有以下簽名：: hook(module, state_dict, prefix, local_metadata) -> None

註冊的鉤子可以就地修改 state_dict。

register_state_dict_pre_hook(hook)¶

為 state_dict() 方法註冊一個預置鉤子。

它應具有以下簽名：: hook(module, prefix, keep_vars) -> None

註冊的鉤子可用於在進行 state_dict 呼叫之前執行預處理。

requires_grad_(requires_grad: bool = True) → T¶

更改 autograd 是否應記錄此模組中引數上的操作。

此方法會就地設定引數的 requires_grad 屬性。

此方法有助於凍結模組的一部分進行微調，或單獨訓練模型的某些部分（例如，GAN 訓練）。

有關 .requires_grad_() 與可能混淆的幾個類似機制之間的比較，請參閱本地停用梯度計算。

引數:: requires_grad (bool) – autograd 是否應記錄此模組中引數上的操作。預設值: True。
返回:: 自身 (self)
返回型別:: 模組

reset(tensordict: TensorDictBase | None = None, **kwargs) → TensorDictBase¶

重置環境。

對於 step 和 _step，只有私有方法 _reset 應由 EnvBase 子類覆蓋。

引數:

tensordict (TensorDictBase, optional) – 用於包含結果新觀察的 tensordict。在某些情況下，此輸入也可用於向重置函式傳遞引數。
kwargs (optional) – 要傳遞給原生重置函式的其他引數。

返回:

一個 tensordict（如果存在輸入 tensordict，則為輸入 tensordict），它會被結果觀察就地修改。

注意

reset 不應由 EnvBase 子類覆蓋。要修改的方法是 _reset()。

property reset_keys: list[tensordict._nestedkey.NestedKey]¶

返回重置鍵列表。

重置鍵是表示在批次、多工或多智慧體設定中部分重置的鍵。它們的結構為 (*prefix, "_reset")，其中 prefix 是指向 tensordict 中可以找到完成狀態位置的字串（可能為空）元組。

鍵按資料樹中的深度排序。

property reward_key¶

環境的獎勵鍵。

預設情況下，這將是 “reward”。

如果環境中存在多個獎勵鍵，此函式將引發異常。

property reward_keys: list[tensordict._nestedkey.NestedKey]¶

環境的獎勵鍵列表。

預設情況下，只有一個名為 “reward” 的鍵。

鍵按資料樹中的深度排序。

property reward_spec: TensorSpec¶

reward 規範。

reward_spec 總是作為複合規範儲存。

如果獎勵規範提供為簡單規範，則返回此規範。

>>> env.reward_spec = Unbounded(1)
>>> env.reward_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

如果獎勵規範提供為複合規範且只包含一個葉節點，此函式將只返回該葉節點。

>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1)}})
>>> env.reward_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=ContinuousBox(
        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

如果獎勵規範提供為複合規範且包含多個葉節點，此函式將返回整個規範。

>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1), "another_reward": Categorical(1)}})
>>> env.reward_spec
Composite(
    nested: Composite(
        reward: UnboundedContinuous(
            shape=torch.Size([1]),
            space=ContinuousBox(
                low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True),
                high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)),
            device=cpu,
            dtype=torch.float32,
            domain=continuous),
        another_reward: Categorical(
            shape=torch.Size([]),
            space=DiscreteBox(n=1),
            device=cpu,
            dtype=torch.int64,
            domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

要檢索傳遞的完整規範，請使用

>>> env.output_spec["full_reward_spec"]

此屬性是可變的。

示例

>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.reward_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=None,
    device=cpu,
    dtype=torch.float32,
    domain=continuous)

property reward_spec_unbatched: TensorSpec¶: 返回環境的獎勵規範（reward spec），如同它沒有批次維度一樣。

rollout(max_steps: int, policy: Callable[[TensorDictBase], TensorDictBase] | None = None, callback: Callable[[TensorDictBase, ...], Any] | None = None, *, auto_reset: bool = True, auto_cast_to_device: bool = False, break_when_any_done: bool | None = None, break_when_all_done: bool | None = None, return_contiguous: bool | None = False, tensordict: TensorDictBase | None = None, set_truncated: bool = False, out=None, trust_policy: bool = False) → TensorDictBase¶

在環境中執行推演。

引數:

只要包含的任何環境達到任何完成狀態，函式將立即返回。
max_steps (int) – 要執行的最大步數。如果環境在執行 max_steps 之前達到完成狀態，則實際步數可能會更少。
policy (callable, optional) – 用於計算所需動作的可呼叫物件。如果未提供策略，將使用 env.rand_step() 呼叫動作。策略可以是任何可呼叫物件，它讀取 tensordict 或按 env.observation_spec.keys() 排序的整個觀察條目序列。預設為 None。

關鍵字引數:

auto_reset (bool, optional) – 如果為 True，則在開始推演之前會重置包含的環境。如果為 False，則推演將從之前的狀態繼續，這要求傳遞包含之前推演的 tensordict 引數。預設為 True。
auto_cast_to_device (bool, optional) – 如果為 True，則在使用策略之前，tensordict 的裝置會自動轉換為策略裝置。預設為 False。
break_when_any_done (bool) – 如果為 True，則當任何包含的環境達到任何完成狀態時中斷。如果為 False，則完成的環境會自動重置。預設為 True。
break_when_all_done (bool, optional) – 如果為 True，則當所有包含的環境達到任何完成狀態時中斷。如果為 False，則當至少一個環境達到任何完成狀態時中斷。預設為 False。
return_contiguous (bool) – 如果 False，將返回一個 LazyStackedTensorDict。如果環境沒有動態 specs，則預設為 True，否則為 False。
tensordict (TensorDict, optional) – 如果 auto_reset 為 False，則必須提供一個初始 tensordict。Rollout 將檢查此 tensordict 是否有完成標誌，並在這些維度中重置環境（如果需要）。如果 tensordict 是重置的輸出，通常不會發生這種情況，但如果 tensordict 是之前推演的最後一步，則可能發生。即使 auto_reset=True，如果需要將元資料（例如批次大小或無狀態環境的裝置）傳遞給 reset 方法，也可以提供 tensordict。
set_truncated (bool, optional) – 如果為 True，則在推演完成後，"truncated" 和 "done" 鍵將被設定為 True。如果在 done_spec 中找不到 "truncated"，則會引發異常。可以透過 env.add_truncated_keys 設定截斷鍵。預設為 False。
trust_policy (bool, optional) – 如果為 True，則非 TensorDictModule 策略將被信任，並假定與 collector 相容。對於 CudaGraphModules，此預設值為 True，否則為 False。

返回:

包含結果軌跡的TensorDict物件。

返回的資料將使用“time”維度名稱標記tensordict的最後一個維度（位於env.ndim索引）。

rollout 對於顯示環境的資料結構非常方便。

示例

>>> # Using rollout without a policy
>>> from torchrl.envs.libs.gym import GymEnv
>>> from torchrl.envs.transforms import TransformedEnv, StepCounter
>>> env = TransformedEnv(GymEnv("Pendulum-v1"), StepCounter(max_steps=20))
>>> rollout = env.rollout(max_steps=1000)
>>> print(rollout)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.float32, is_shared=False),
        done: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([20, 3]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                step_count: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.int64, is_shared=False),
                truncated: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([20]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([20, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        step_count: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.int64, is_shared=False),
        truncated: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([20]),
    device=cpu,
    is_shared=False)
>>> print(rollout.names)
['time']
>>> # with envs that contain more dimensions
>>> from torchrl.envs import SerialEnv
>>> env = SerialEnv(3, lambda: TransformedEnv(GymEnv("Pendulum-v1"), StepCounter(max_steps=20)))
>>> rollout = env.rollout(max_steps=1000)
>>> print(rollout)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.float32, is_shared=False),
        done: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([3, 20, 3]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                step_count: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.int64, is_shared=False),
                truncated: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([3, 20]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([3, 20, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        step_count: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.int64, is_shared=False),
        truncated: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([3, 20]),
    device=cpu,
    is_shared=False)
>>> print(rollout.names)
[None, 'time']

使用策略（可以是常規的Module 或 TensorDictModule）也很容易

示例

>>> from torch import nn
>>> env = GymEnv("CartPole-v1", categorical_action_encoding=True)
>>> class ArgMaxModule(nn.Module):
...     def forward(self, values):
...         return values.argmax(-1)
>>> n_obs = env.observation_spec["observation"].shape[-1]
>>> n_act = env.action_spec.n
>>> # A deterministic policy
>>> policy = nn.Sequential(
...     nn.Linear(n_obs, n_act),
...     ArgMaxModule())
>>> env.rollout(max_steps=10, policy=policy)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.int64, is_shared=False),
        done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([10]),
    device=cpu,
    is_shared=False)
>>> # Under the hood, rollout will wrap the policy in a TensorDictModule
>>> # To speed things up we can do that ourselves
>>> from tensordict.nn import TensorDictModule
>>> policy = TensorDictModule(policy, in_keys=list(env.observation_spec.keys()), out_keys=["action"])
>>> env.rollout(max_steps=10, policy=policy)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.int64, is_shared=False),
        done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([10]),
    device=cpu,
    is_shared=False)

在某些情況下，無法獲得連續的 tensordict，因為它們無法堆疊。這可能發生在每個步驟返回的資料具有不同形狀時，或者當不同的環境一起執行時。在這種情況下，return_contiguous=False 將使得返回的 tensordict 成為一個 tensordict 的惰性堆疊。

非連續取樣的示例

>>> rollout = env.rollout(4, return_contiguous=False)
>>> print(rollout)
LazyStackedTensorDict(
    fields={
        action: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False),
        done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: LazyStackedTensorDict(
            fields={
                done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False),
                truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([3, 4]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False),
        step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False),
        truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([3, 4]),
    device=cpu,
    is_shared=False)
    >>> print(rollout.names)
    [None, 'time']

取樣序列可以在迴圈中使用以模擬資料收集。為此，你需要將前一個取樣序列中經過 step_mdp() 處理後的最後一個 tensordict 作為輸入傳遞。

資料收集取樣的示例

>>> from torchrl.envs import GymEnv, step_mdp
>>> env = GymEnv("CartPole-v1")
>>> epochs = 10
>>> input_td = env.reset()
>>> for i in range(epochs):
...     rollout_td = env.rollout(
...         max_steps=100,
...         break_when_any_done=False,
...         auto_reset=False,
...         tensordict=input_td,
...     )
...     input_td = step_mdp(
...         rollout_td[..., -1],
...     )

set_extra_state(state: Any) → None¶

設定載入的state_dict中包含的額外狀態。

此函式由 load_state_dict() 呼叫，用於處理在 state_dict 中找到的任何額外狀態。如果你的模組需要在其 state_dict 中儲存額外狀態，請實現此函式以及相應的 get_extra_state()。

引數:: state (dict) – 來自 state_dict 的額外狀態

set_seed(seed: int | None = None, static_seed: bool = False) → int | None¶

設定環境的種子，並返回下一個要使用的種子（如果只有一個環境存在，則返回輸入種子）。

引數:

seed (int) – 要設定的種子。種子僅在環境中區域性設定。要處理全域性種子，請參見 manual_seed()。
static_seed (bool, optional) – 如果為 True，種子不會增加。預設為 False

返回:

即，如果與當前環境同時建立另一個環境，則應使用該種子。

返回型別:

表示“下一個種子”的整數

property set_spec_lock_(mode: bool = True) → EnvBase¶

鎖定或解鎖環境的規格。

引數:: mode (bool) – 是否鎖定 (True) 或解鎖 (False) 規格。預設為 True。
返回:: 環境例項本身。
返回型別:: 具有更新規範的環境例項。

另請參閱

鎖定環境規範.

set_submodule(target: str, module: Module) → None¶

如果存在由 target 給定的子模組，則設定它，否則丟擲錯誤。

例如，假設您有一個 nn.Module A，其結構如下：

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

(該圖顯示一個 nn.Module A。A 包含一個巢狀子模組 net_b，它自身包含兩個子模組 net_c 和 linear。net_c 隨後包含一個子模組 conv。)

要用新的子模組 Linear 覆蓋 Conv2d，你可以呼叫 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

引數:

target (str) – 要查詢的子模組的完全限定字串名稱。（有關如何指定完全限定字串，請參閱上述示例。）
module – 用於設定子模組的模組。

引發:

ValueError – 如果目標字串為空
AttributeError – 如果 target 字串引用了無效路徑或解析為非 nn.Module 的物件

property shape¶: 等同於 batch_size。

share_memory() → T¶: 參見 torch.Tensor.share_memory_()。

property specs: Composite¶

返回一個 Composite 容器，其中包含所有的環境規格。

此功能允許建立一個環境，在一個數據容器中檢索所有的規格，然後從工作區中擦除該環境。

state_dict(*args, destination=None, prefix='', keep_vars=False)¶

返回一個字典，其中包含對模組整體狀態的引用。

引數和持久緩衝區（例如，執行平均值）都包含在內。鍵是相應的引數和緩衝區名稱。設定為 None 的引數和緩衝區不包含在內。

注意

返回的物件是淺複製。它包含對模組引數和緩衝區的引用。

警告

目前 state_dict() 也按順序接受 destination、prefix 和 keep_vars 的位置引數。但是，此用法正在被棄用，未來的版本將強制使用關鍵字引數。

警告

請避免使用引數 destination，因為它不為終端使用者設計。

引數:

destination (dict, optional) – 如果提供，模組的狀態將更新到該字典中，並返回同一物件。否則，將建立一個 OrderedDict 並返回。預設為 None。
prefix (str, optional) – 新增到引數和緩衝區名稱前面的字首，用於構成 state_dict 中的鍵。預設為 ''。
keep_vars (bool, optional) – 預設情況下，state dict 中返回的 Tensor 會從 autograd 中分離。如果設定為 True，將不執行分離操作。預設為 False。

返回:

包含模組整體狀態的字典

返回型別:

dict

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> module.state_dict().keys()
['bias', 'weight']

property state_keys: list[tensordict._nestedkey.NestedKey]¶

環境的狀態鍵。

預設情況下，只有一個名為“state”的鍵。

鍵按資料樹中的深度排序。

property state_spec: Composite¶

狀態規格。

必須是 torchrl.data.Composite 例項。這裡列出的鍵應該與動作一起作為輸入提供給環境。

在 TorchRL 中，即使它們嚴格來說不是“狀態”，所有不是動作的環境輸入都儲存在 state_spec 中。

因此，"state_spec" 應被視為一個通用資料容器，用於儲存非動作資料的環境輸入。

示例

>>> from torchrl.envs import BraxEnv
>>> for envname in BraxEnv.available_envs:
...     break
>>> env = BraxEnv(envname)
>>> env.state_spec
Composite(
    state: Composite(
        pipeline_state: Composite(
            q: UnboundedContinuous(
                shape=torch.Size([15]),
                space=None,
                device=cpu,
                dtype=torch.float32,
                domain=continuous),
    [...], device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))

property state_spec_unbatched: TensorSpec¶: 返回環境的狀態規範（state spec），如同它沒有批次維度一樣。

step(tensordict: TensorDictBase) → TensorDictBase¶

在環境中執行一個步進。

Step 接受一個引數，tensordict，它通常包含一個“action”鍵，指示要採取的動作。Step 將呼叫一個 out-place 私有方法 _step，該方法需要由 EnvBase 的子類重寫。

引數:: tensordict (TensorDictBase) – 包含要採取的動作的 Tensordict。如果輸入的 tensordict 包含一個 "next" 條目，則其中包含的值將優先於新計算的值。這提供了一種覆蓋底層計算的機制。
返回:: 修改輸入的 tensordict，在原處填充結果觀察、完成狀態和獎勵（如果需要，還包括其他）。

step_and_maybe_reset(tensordict: TensorDictBase) → tuple[tensordict.base.TensorDictBase, tensordict.base.TensorDictBase]¶

在環境中執行一個步進，並在需要時（部分地）重置它。

引數:: tensordict (TensorDictBase) – step() 方法的輸入資料結構。

此方法可以輕鬆編寫不停止的取樣函式。

示例

>>> from torchrl.envs import ParallelEnv, GymEnv
>>> def rollout(env, n):
...     data_ = env.reset()
...     result = []
...     for i in range(n):
...         data, data_ = env.step_and_maybe_reset(data_)
...         result.append(data)
...     return torch.stack(result)
>>> env = ParallelEnv(2, lambda: GymEnv("CartPole-v1"))
>>> print(rollout(env, 2))
TensorDict(
    fields={
        done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        next: TensorDict(
            fields={
                done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False),
                reward: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
            batch_size=torch.Size([2, 2]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False),
        terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)},
    batch_size=torch.Size([2, 2]),
    device=cpu,
    is_shared=False)

step_mdp(next_tensordict: TensorDictBase) → TensorDictBase¶

使用提供的 next_tensordict 將環境狀態向前推進一步。

此方法透過從當前狀態轉移到下一個狀態來更新環境的狀態，轉移由 next_tensordict 定義。結果 tensordict 包含更新的觀察以及任何其他相關的狀態資訊，其鍵根據環境的規格進行管理。

在內部，此方法利用預計算的 _StepMDP 例項來高效處理狀態、觀察、動作、獎勵和完成鍵的轉移。 _StepMDP 類透過預先計算要包含和排除的鍵來最佳化過程，減少重複呼叫期間的執行時開銷。 _StepMDP 例項使用 exclude_action=False 建立，這意味著動作鍵保留在根 tensordict 中。

引數:: next_tensordict (TensorDictBase) – 一個 tensordict，包含環境在下一個時間步的狀態。此 tensordict 應包含觀察、動作、獎勵和完成標誌的鍵，如環境規格所定義。
返回:: 一個新的 tensordict，表示環境向前推進一步後的狀態。
返回型別:: TensorDictBase

注意

此方法確保根據提供的 next_tensordict 驗證環境的鍵規格，並在發現差異時發出警告。

注意

此方法設計用於高效處理具有一致鍵規格的環境，利用 _StepMDP 類來最小化開銷。

示例

>>> from torchrl.envs import GymEnv
>>> env = GymEnv("Pendulum-1")
>>> data = env.reset()
>>> for i in range(10):
...     # compute action
...     env.rand_action(data)
...     # Perform action
...     next_data = env.step(reset_data)
...     data = env.step_mdp(next_data)

to(device: Union[device, str, int]) → EnvBase¶

移動和/或轉換引數和緩衝區。

可以這樣呼叫：

to(device=None, dtype=None, non_blocking=False)

to(dtype, non_blocking=False)

to(tensor, non_blocking=False)

to(memory_format=torch.channels_last)

其簽名類似於 torch.Tensor.to()，但只接受浮點或複數 dtype。此外，此方法只會將浮點或複數引數和緩衝區轉換為指定的 dtype（如果給定）。如果給定，整數引數和緩衝區將移動到指定的 device，但資料型別不變。當設定了 non_blocking 時，如果可能，它會嘗試相對於主機非同步地進行轉換/移動，例如，將具有固定記憶體的 CPU 張量移動到 CUDA 裝置。

參見下面的示例。

注意

此方法會就地修改模組。

引數:

device (torch.device) – 此模組中引數和緩衝區所需的目標裝置。
dtype (torch.dtype) – 此模組中引數和緩衝區所需的浮點或複數資料型別。
tensor (torch.Tensor) – 其資料型別和裝置為此模組中所有引數和緩衝區所需的目標資料型別和裝置的 Tensor。
memory_format (torch.memory_format) – 此模組中 4D 引數和緩衝區所需的目標記憶體格式（僅限關鍵字引數）。

返回:

自身 (self)

返回型別:

模組

示例

>>> # xdoctest: +IGNORE_WANT("non-deterministic")
>>> linear = nn.Linear(2, 2)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]])
>>> linear.to(torch.double)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1913, -0.3420],
        [-0.5113, -0.2325]], dtype=torch.float64)
>>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1)
>>> gpu1 = torch.device("cuda:1")
>>> linear.to(gpu1, dtype=torch.half, non_blocking=True)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16, device='cuda:1')
>>> cpu = torch.device("cpu")
>>> linear.to(cpu)
Linear(in_features=2, out_features=2, bias=True)
>>> linear.weight
Parameter containing:
tensor([[ 0.1914, -0.3420],
        [-0.5112, -0.2324]], dtype=torch.float16)

>>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble)
>>> linear.weight
Parameter containing:
tensor([[ 0.3741+0.j,  0.2382+0.j],
        [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128)
>>> linear(torch.ones(3, 2, dtype=torch.cdouble))
tensor([[0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j],
        [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)

to_empty(*, device: Optional[Union[int, str, device]], recurse: bool = True) → T¶

將引數和緩衝區移動到指定裝置，但不復制儲存。

引數:

device (torch.device) – 此模組中引數和緩衝區所需的目標裝置。
recurse (bool) – 子模組的引數和緩衝區是否應遞迴地移動到指定裝置。

返回:

自身 (self)

返回型別:

模組

train(mode: bool = True) → T¶

將模組設定為訓練模式。

這隻對某些模組有影響。有關特定模組在訓練/評估模式下的行為細節，即它們是否受影響（例如 Dropout、BatchNorm 等），請參見其文件。

引數:: mode (bool) – 是設定為訓練模式 (True) 還是評估模式 (False)。預設值：True。
返回:: 自身 (self)
返回型別:: 模組

type(dst_type: Union[dtype, str]) → T¶

將所有引數和緩衝區轉換為 dst_type。

注意

此方法會就地修改模組。

引數:: dst_type (type or string) – 所需的目標型別
返回:: 自身 (self)
返回型別:: 模組

xpu(device: Optional[Union[int, device]] = None) → T¶

將所有模型引數和緩衝區移動到 XPU。

這也會使得相關的引數和緩衝區成為不同的物件。因此，如果模組將在 XPU 上執行時進行最佳化，則應在構造最佳化器之前呼叫此方法。

注意

此方法會就地修改模組。

引數:: device (int, optional) – 如果指定，所有引數將被複制到該裝置。
返回:: 自身 (self)
返回型別:: 模組

zero_grad(set_to_none: bool = True) → None¶

重置所有模型引數的梯度。

參見 torch.optim.Optimizer 下的類似函式以獲取更多上下文。

引數:: set_to_none (bool) – 不設定為零，而是將梯度設定為 None。有關詳細資訊，請參見 torch.optim.Optimizer.zero_grad()。

TicTacToeEnv¶

文件

教程

資源