PendulumEnv¶

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

一個無狀態的 Pendulum 環境。

有關更多詳細資訊，請參閱 Pendulum 教程：教程。

規格

>>> env = PendulumEnv()
>>> env.specs
Composite(
    output_spec: Composite(
        full_observation_spec: Composite(
            th: BoundedContinuous(
                shape=torch.Size([]),
                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),
            thdot: BoundedContinuous(
                shape=torch.Size([]),
                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),
            params: Composite(
                max_speed: UnboundedDiscrete(
                    shape=torch.Size([]),
                    space=ContinuousBox(
                        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, contiguous=True),
                        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, contiguous=True)),
                    device=cpu,
                    dtype=torch.int64,
                    domain=discrete),
                max_torque: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                dt: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                g: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                m: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                l: UnboundedContinuous(
                    shape=torch.Size([]),
                    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=None,
            shape=torch.Size([])),
        full_reward_spec: 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)),
                device=cpu,
                dtype=torch.float32,
                domain=continuous),
            device=None,
            shape=torch.Size([])),
        full_done_spec: Composite(
            done: Categorical(
                shape=torch.Size([1]),
                space=CategoricalBox(n=2),
                device=cpu,
                dtype=torch.bool,
                domain=discrete),
            terminated: Categorical(
                shape=torch.Size([1]),
                space=CategoricalBox(n=2),
                device=cpu,
                dtype=torch.bool,
                domain=discrete),
            device=None,
            shape=torch.Size([])),
        device=None,
        shape=torch.Size([])),
    input_spec: Composite(
        full_state_spec: Composite(
            th: BoundedContinuous(
                shape=torch.Size([]),
                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),
            thdot: BoundedContinuous(
                shape=torch.Size([]),
                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),
            params: Composite(
                max_speed: UnboundedDiscrete(
                    shape=torch.Size([]),
                    space=ContinuousBox(
                        low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, contiguous=True),
                        high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, contiguous=True)),
                    device=cpu,
                    dtype=torch.int64,
                    domain=discrete),
                max_torque: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                dt: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                g: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                m: UnboundedContinuous(
                    shape=torch.Size([]),
                    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),
                l: UnboundedContinuous(
                    shape=torch.Size([]),
                    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=None,
            shape=torch.Size([])),
        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=None,
            shape=torch.Size([])),
        device=None,
        shape=torch.Size([])),
    device=None,
    shape=torch.Size([]))

property action_key: NestedKey¶

環境的動作鍵。

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

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

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

環境的動作鍵列表。

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

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

property action_spec: TensorSpec¶

action 規格。

action_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¶: 向環境新增截斷鍵。

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

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

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

引數：: tensordict (TensorDictBase, 可選) – 如果給定，則使用此 tensordict 呼叫 reset()。
返回：: 一個 tensordict 物件，其中的“action”條目已使用所有可能動作的批次進行更新。動作在首個維度上堆疊在一起。

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

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

引數：: transform (Transform 或 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
返回型別：: Module

示例

>>> @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, 可選) – 一個可選的 TensorDictBase 例項，用作 rollout 的初始狀態。如果未提供，將呼叫環境的 reset 方法以獲取初始狀態。
action_key (NestedKey 或 List[NestedKey], 可選) – 用於在 TensorDictBase 中識別動作的鍵。預設為“action”。
done_key (NestedKey 或 List[NestedKey] 或 None, 可選) – 用於在 TensorDictBase 中識別終止訊號的鍵。預設為 None，此時將嘗試使用 [“done”、“terminated”、“truncated”] 作為潛在鍵。
observation_key (NestedKey 或 List[NestedKey], 可選) – 用於在 TensorDictBase 中識別觀測的鍵。預設為“observation”。
reward_key (NestedKey 或 List[NestedKey], 可選) – 用於在 TensorDictBase 中識別獎勵的鍵。預設為“reward”。

返回：

更新規格後的環境例項。

返回型別：

EnvBase

引發：

RuntimeError – 如果輸出規格中有未在提供的鍵中包含的鍵。

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

property batch_size: Size¶

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

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

bfloat16() → T¶

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

注意

此方法會就地修改模組。

返回：: self
返回型別：: Module

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

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

引數：: recurse (bool) – 如果為 True，則返回此模組及其所有子模組的緩衝區。否則，僅返回屬於此模組直接成員的緩衝區。
返回：: 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¶

動作空間的基數（數量）。

預設情況下，這只是 env.action_space.cardinality 的一個簡單封裝。

當動作規格可變時，此方法很有用：

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

在這些情況下，應覆蓋 cardinality() 方法，

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

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

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

此測試函式應作為對使用 torchrl 的 EnvBase 子類包裝的環境進行完整性檢查：預期資料與收集的資料之間的任何差異都應引發斷言錯誤。

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

引數：

env (EnvBase) – 需要根據資料檢查規格的環境。
return_contiguous (bool, 可選) – 如果為 True，則隨機 rollout 將使用 return_contiguous=True 呼叫。這在某些情況下（例如，輸入/輸出形狀異構）可能會失敗。預設為 None（由是否存在動態規格決定）。
check_dtype (bool, 可選) – 如果為 False，則跳過資料型別檢查。預設為 True。
seed (int, 可選) – 為了可重現性，可以設定種子。種子將在 pytorch 中臨時設定，然後 RNG 狀態將恢復到之前。對於環境，我們設定種子，但由於將 rng 狀態恢復到之前並非大多數環境的特性，我們將其留給使用者自行完成。預設為 None。
tensordict (TensorDict, 可選) – 一個可選的 tensordict 例項，用於 reset。

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

children() → Iterator[Module]¶

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

返回：: Module – 一個子模組

compile(*args, **kwargs)¶

使用 torch.compile() 編譯此模組的前向傳播。

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

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

cpu() → T¶

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

注意

此方法會就地修改模組。

返回：: self
返回型別：: Module

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

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

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

注意

此方法會就地修改模組。

引數：: device (int, 可選) – 如果指定，所有引數將被複制到該裝置
返回：: self
返回型別：: Module

property done_key¶

環境的終止鍵。

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

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

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

環境的終止鍵列表。

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

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

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

property done_keys_groups¶

終止鍵的列表，按 reset 鍵分組。

這是一個列表的列表。外層列表的長度與 reset 鍵的數量相同，內層列表包含可以讀取的終止鍵（例如，done 和 truncated），用於在 reset 鍵不存在時確定是否需要 reset。

property done_spec: TensorSpec¶

done 規格。

done_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)

要始終檢索傳遞的完整規格，請使用: property done_spec_unbatched: TensorSpec¶

返回環境的終止規格，如同它沒有批次維度一樣。

double() → T¶

注意

此方法會就地修改模組。

返回：: self
返回型別：: Module

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

empty_cache()¶

清除所有快取值。

eval() → T¶

將模組設定為評估模式。

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

這等效於 self.train(False)。

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

返回：: self
返回型別：: Module

extra_repr() → str¶

返回模組的額外表示。

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

fake_tensordict() → TensorDictBase¶: 返回一個偽造的 tensordict，其鍵值對的形狀、裝置和 dtype 與環境 rollout 期間預期的相匹配。

float() → T¶

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

注意

此方法會就地修改模組。

返回：: self
返回型別：: Module

forward(*args, **kwargs)¶

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

應該被所有子類覆蓋。

注意

儘管正向傳播的“配方”需要在此函式中定義，但應該在呼叫此函式後呼叫 Module 例項，而不是直接呼叫此函式，因為前者負責執行註冊的鉤子，而後者會靜默地忽略它們。

property full_action_spec: Composite¶

完整的動作規格。

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

示例

>>> 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([]))

property full_action_spec_unbatched: Composite¶: 返回環境的動作規格，如同它沒有批次維度一樣。

property full_done_spec: Composite¶

完整的完成規格。

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

示例

>>> 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([]))

property full_done_spec_unbatched: Composite¶: property done_spec_unbatched: TensorSpec¶

property full_observation_spec_unbatched: Composite¶: 返回環境的觀測規格，就像它沒有批次維度一樣。

property full_reward_spec: Composite¶

完整的獎勵規格。

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

示例

>>> 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([]))

property full_reward_spec_unbatched: Composite¶: 返回環境的獎勵規格，就像它沒有批次維度一樣。

property full_state_spec: Composite¶

完整的狀態規格。

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([]))

property full_state_spec_unbatched: Composite¶: 返回環境的狀態規格，就像它沒有批次維度一樣。

static gen_params(g=10.0, batch_size=None, device=None) → TensorDictBase[source]¶: 返回一個 tensordict，包含物理引數，例如引力、扭矩或速度限制。

get_buffer(target: str) → Tensor¶

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

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

引數：: target – 要查詢的緩衝區的完全限定字串名稱。（請參閱 get_submodule 瞭解如何指定完全限定字串）。
返回：: 由 target 引用的緩衝區
返回型別：: torch.Tensor
引發：: AttributeError – 如果目標字串引用了無效路徑或解析到的不是緩衝區

get_extra_state() → Any¶

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

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

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

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

get_parameter(target: str) → Parameter¶

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

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

引數：: target – 要查詢的 Parameter 的完全限定字串名稱。（請參閱 get_submodule 瞭解如何指定完全限定字串）。
返回：: 由 target 引用的 Parameter
返回型別：: torch.nn.Parameter
引發：: AttributeError – 如果目標字串引用了無效路徑或解析到的不是 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_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 – 要查詢的子模組的完全限定字串名稱。（請參閱上面示例瞭解如何指定完全限定字串）。
返回：: 由 target 引用的子模組
返回型別：: torch.nn.Module
引發：: AttributeError – 如果目標字串引用了無效路徑或解析到的不是 nn.Module

half() → T¶

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

注意

此方法會就地修改模組。

返回：: self
返回型別：: Module

property input_spec: TensorSpec¶

輸入規格。

包含所有環境輸入資料規格的組合規格。

它包含：

“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([]))

property input_spec_unbatched: Composite¶: 返回環境的輸入規格，就像它沒有批次維度一樣。

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

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

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

注意

此方法會就地修改模組。

引數：: device (int, 可選) – 如果指定，所有引數將被複制到該裝置
返回：: self
返回型別：: Module

property is_spec_locked¶

獲取環境的規格是否已鎖定。

此屬性可以直接修改。

返回：: 如果規格已鎖定則為 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，則必須在呼叫 load_state_dict 之後建立最佳化器，除非 get_swap_module_params_on_conversion() 為 True。

引數：

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

返回：

missing_keys 是一個字串列表，包含由此模組期望但提供的 state_dict
中缺失的鍵。
unexpected_keys 是一個字串列表，包含由此模組不期望但在提供的 state_dict
中存在的鍵。

返回型別：

NamedTuple 包含 missing_keys 和 unexpected_keys 欄位

注意

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

maybe_reset(tensordict: TensorDictBase) → TensorDictBase¶

檢查輸入 tensordict 的完成鍵，如果需要，在環境完成時進行重置。

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

modules() → Iterator[Module]¶

返回網路中所有模組的迭代器。

返回：: 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, 可選) – 如果指定，所有引數將被複制到該裝置
返回：: self
返回型別：: Module

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

返回模組緩衝區的迭代器，同時產生緩衝區的名稱和緩衝區本身。

引數：

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

返回：

(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]]¶

返回直接子模組的迭代器，同時產生模組的名稱和模組本身。

返回：: (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 – 用於儲存已新增到結果中的模組集合的 memo
prefix – 將新增到模組名稱前面的字首
remove_duplicate – 是否移除結果中重複的模組例項

返回：

(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。

返回：

(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 例項。規範中列出的鍵在重置和步進後可直接訪問。

在 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¶: 返回環境的觀測規格，就像它沒有批次維度一樣。

property output_spec: TensorSpec¶

輸出規範。

包含環境所有資料輸出規範的複合規範。

它包含：

“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，則生成此模組和所有子模組的引數。否則，僅生成作為此模組直接成員的引數。
返回：: 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: TensorDictBase | None = None)¶

根據 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]], prepend: bool = False) → 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 或 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，hook 將被傳遞給 forward 函式的關鍵字引數。預設值：False
always_call (bool) – 如果為 True，無論呼叫 Module 時是否引發異常，都將執行 hook。預設值：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，hook 將被傳遞給 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 只對應作為位置引數給定的輸入，所有關鍵字引數將被忽略。grad_input 和 grad_output 中的條目對於所有非 Tensor 引數將是 None。

出於技術原因，當此鉤子應用於 Module 時，其前向函式將接收傳遞給 Module 的每個 Tensor 的檢視。類似地，呼叫方將接收 Module 前向函式返回的每個 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 時，其前向函式將接收傳遞給 Module 的每個 Tensor 的檢視。類似地，呼叫方將接收 Module 前向函式返回的每個 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-first 環境整合到使用 Gym 的框架中；
將其他環境（例如 DeepMind Control、Brax、Jumanji 等）整合到使用 Gym 的框架中。

引數：

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

關鍵字引數：

entry_point (callable, 可選) –

構建環境的入口點。如果沒有傳遞，將使用父類作為入口點。通常，這用於註冊一個不一定繼承自所使用的基類的環境

>>> 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], 可選) –
如果提供，這些鍵將用於構建資訊字典，並將從觀測鍵中排除。此引數可以在呼叫 make() 時傳遞（參見下面的示例）。

警告

使用 info_keys 可能會導致規範變空，因為內容已移至資訊字典。Gym 不喜歡規範中的空 Dict，因此應使用 RemoveEmptySpecs 移除此空內容。
backend (str, 可選) – 後端。可以是 "gym" 或 "gymnasium"，或與 set_gym_backend 相容的任何其他後端。
to_numpy (bool, 可選) – 如果為 True，對 step 和 reset 的呼叫結果將被對映到 numpy 陣列。預設為 False（結果是張量）。此引數可以在呼叫 make() 時傳遞（參見下面的示例）。
reward_threshold ([float](#torchrl.envs.PendulumEnv.float), 可選) – [Gym kwarg] 認為已學會環境的獎勵閾值。
nondeterministic (bool, 可選) – [Gym kwarg 如果環境是非確定性的（即使知道初始種子和所有動作）。預設為 False。
max_episode_steps (int, 可選) – [Gym kwarg] 截斷前最大回合步數。由 Time Limit wrapper 使用。
order_enforce (bool, 可選) – [Gym >= 0.14] 是否應應用順序強制包裝器以確保使用者按正確順序執行函式。預設為 True。
autoreset (bool, 可選) – [Gym >= 0.14] 是否應新增 autoreset 包裝器，以便無需呼叫 reset。預設為 False。
disable_env_checker – [Gym >= 0.14] 是否應為環境停用環境檢查器。預設為 False。
apply_api_compatibility – [Gym >= 0.26] 是否應用 StepAPICompatibility 包裝器。預設為 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`](torchrl.envs.BraxEnv.html#torchrl.envs.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()`](https://pytorch.com.tw/docs/stable/generated/torch.nn.Module.html#torch.nn.Module.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。

請注意，使用 strict=True 呼叫 [`load_state_dict()`](#torchrl.envs.PendulumEnv.load_state_dict) 時執行的檢查會受到鉤子對 missing_keys 或 unexpected_keys 的修改的影響，這是符合預期的。向任一鍵集合新增內容都會在 strict=True 時導致丟擲錯誤，而清除缺失和意外部索引鍵則可以避免錯誤。

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

register_load_state_dict_pre_hook(hook)¶

註冊一個前置鉤子，在模組的 [`load_state_dict()`](https://pytorch.com.tw/docs/stable/generated/torch.nn.Module.html#torch.nn.Module.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()](#torchrl.envs.PendulumEnv.add_module) 的別名。

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

向模組新增一個引數。

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

引數：

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

register_state_dict_post_hook(hook)¶

為 [`state_dict()`](https://pytorch.com.tw/docs/stable/generated/torch.nn.Module.html#torch.nn.Module.state_dict) 方法註冊一個後置鉤子。

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

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

register_state_dict_pre_hook(hook)¶

為 [`state_dict()`](https://pytorch.com.tw/docs/stable/generated/torch.nn.Module.html#torch.nn.Module.state_dict) 方法註冊一個前置鉤子。

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

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

requires_grad_(requires_grad: bool = True) → T¶

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

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

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

請參閱[區域性停用梯度計算](https://pytorch.com.tw/docs/stable/notes/autograd.html#locally-disable-grad-doc)，瞭解 .requires_grad_() 與可能與之混淆的幾種類似機制之間的比較。

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

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

重置環境。

與 step 和 _step 類似，[`EnvBase`](torchrl.envs.EnvBase.html#torchrl.envs.EnvBase) 子類只應覆蓋私有方法 _reset。

引數：

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

返回：

一個 tensordict（或輸入的 tensordict，如果提供了），透過產生的觀測就地修改。

注意

[EnvBase`](torchrl.envs.EnvBase.html#torchrl.envs.EnvBase) 子類不應覆蓋 reset。要修改的方法是 _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¶
返回環境的獎勵規格，就像它沒有批次維度一樣。




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¶
在環境中執行一次 rollout。
一旦任何包含的環境到達任何完成狀態，函式將立即返回。

引數：

max_steps (int) – 要執行的最大步數。如果環境在達到 max_steps 之前到達完成狀態，實際步數可能會更少。
policy (callable, 可選) – 用於計算期望動作的可呼叫物件。如果未提供策略，將使用 env.rand_step() 呼叫動作。策略可以是任何可呼叫物件，它可以讀取 tensordict 或按 env.observation_spec.keys() **排序**的整個觀測條目序列。預設為 None。
callback (Callable[[*TensorDict*]*, Any]*, 可選*) – 在每次迭代時用給定的 TensorDict 呼叫的函式。預設為 None。callback 的輸出**不會**被收集，如果資料需要傳遞到 rollout 呼叫之外，使用者有責任在回撥函式呼叫內儲存任何結果。


關鍵字引數：

auto_reset (bool, 可選) – 如果為 True，將在開始 rollout 前重置包含的環境。如果為 False，則 rollout 將從先前狀態繼續，這需要透過 tensordict 引數傳遞先前的 rollout 資料。預設值為 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 是否有 done 標誌，並（如有需要）在這些維度上重置環境。如果 tensordict 是 reset 的輸出，通常不應該發生這種情況，但如果 tensordict 是上一個 rollout 的最後一步，則可能發生。當 auto_reset=True 時，如果需要將元資料傳遞給 reset 方法（例如無狀態環境的批大小或裝置），也可以提供一個 tensordict。
set_truncated (bool, optional) – 如果為 True，在 rollout 完成後，"truncated" 和 "done" 鍵將被設定為 True。如果在 done_spec 中找不到 "truncated" 鍵，則會丟擲異常。截斷鍵可以透過 env.add_truncated_keys 設定。預設為 False。
trust_policy (bool, optional) – 如果為 True，非 TensorDictModule 策略將被信任並假定與收集器相容。對於 CudaGraphModules 預設為 True，否則為 False。


返回：
包含結果軌跡的 TensorDict 物件。


返回的資料將對 tensordict 的最後一個維度（在 env.ndim 索引處）標記為 “time” 維度名稱。
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 成為一個 tensordicts 的惰性堆疊（lazy stack）

非連續 rollout 的示例
>>> 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']




Rollout 可以在迴圈中使用以模擬資料收集。為此，你需要將上一個 rollout 的最後一個 tensordict 作為輸入傳遞，在對其呼叫 step_mdp() 之後。

資料收集 rollout 的示例
>>> 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


返回：
即，如果與此環境同時建立另一個環境，則應使用此種子。

返回型別：
表示“下一個種子”的整數






set_spec_lock_(mode: bool = True) → EnvBase¶
鎖定或解鎖環境的 specs。

引數：
mode (bool) – 是鎖定（True）還是解鎖（False） specs。預設為 True。

返回：
環境例項本身。

返回型別：
EnvBase



另請參閱
鎖定環境規格.





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_b 本身有兩個子模組 net_c 和 linear。然後 net_c 有一個子模組 conv。）
要用一個新的子模組 Linear 覆蓋 Conv2d，你可以呼叫 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

引數：

target – 要查詢的子模組的完全限定字串名稱。（請參閱上面示例瞭解如何指定完全限定字串）。
module – 用於設定子模組的模組。


引發：

ValueError – 如果目標字串為空。
AttributeError – 如果目標字串引用了無效路徑或解析到的不是 nn.Module







property shape¶
等同於 batch_size。




share_memory() → T¶
請參閱 torch.Tensor.share_memory_()。




property specs: Composite¶
返回一個包含所有環境的 Composite 容器。
此特性允許建立環境，在一個單獨的資料容器中檢索所有 specs，然後從工作空間中擦除環境。




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。


返回：
包含模組整個狀態的字典

返回型別：
字典


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






property state_keys: list[tensordict._nestedkey.NestedKey]¶
環境的狀態鍵。
預設情況下，只會有一個名為“state”的鍵。
鍵按資料樹中的深度排序。




property state_spec: Composite¶
狀態 spec。
必須是一個 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¶
返回環境的狀態規格，就像它沒有批次維度一樣。




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() 方法的輸入資料結構。


此方法可以輕鬆編寫不停止的 rollout 函式。
示例
>>> 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¶
移動和/或轉換（cast）引數和緩衝區。
可以這樣呼叫：


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，整型引數和緩衝區將被移動到該 device，但 dtype 保持不變。當設定 non_blocking 時，如果可能，它會嘗試相對於主機非同步轉換/移動，例如，將具有 pinned memory 的 CPU Tensor 移動到 CUDA 裝置。
示例如下。

注意
此方法會就地修改模組。


引數：

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


返回：
self

返回型別：
Module


示例
>>> # 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

返回型別：
Module






train(mode: bool = True) → T¶
將模組設定為訓練模式。
這僅對某些模組有效。有關特定模組在訓練/評估模式下的行為詳情，請參閱其文件，即它們是否受影響，例如 Dropout、BatchNorm 等。

引數：
mode (bool) – 是否設定為訓練模式（True）或評估模式（False）。預設值: True。

返回：
self

返回型別：
Module






type(dst_type: Union[dtype, str]) → T¶
將所有引數和緩衝區轉換為 dst_type。

注意
此方法會就地修改模組。


引數：
dst_type (type or string) – 目標型別。

返回：
self

返回型別：
Module






xpu(device: Optional[Union[int, device]] = None) → T¶
將所有模型引數和緩衝區移動到 XPU。
這也會使關聯的引數和緩衝區成為不同的物件。因此，如果模組在最佳化期間將在 XPU 上執行，則應在構建最佳化器之前呼叫此方法。

注意
此方法會就地修改模組。


引數：
device (int, 可選) – 如果指定，所有引數將被複制到該裝置

返回：
self

返回型別：
Module






zero_grad(set_to_none: bool = True) → None¶
重置所有模型引數的梯度。
有關更多上下文，請參閱 torch.optim.Optimizer 下的類似函式。

引數：
set_to_none (bool) – 不設定為零，而是將梯度設定為 None。有關詳情，請參閱 torch.optim.Optimizer.zero_grad()。

PendulumEnv¶

文件

教程

資源