SerialEnv¶

class torchrl.envs.SerialEnv(*args, **kwargs)[source]¶

在同一程序中建立一系列環境。批處理環境允許使用者查詢遠端執行環境的任意方法/屬性。

這些查詢將返回一個列表，其長度等於 worker 數量，列表中包含查詢結果的值。

>>> env = ParallelEnv(3, my_env_fun)
>>> custom_attribute_list = env.custom_attribute
>>> custom_method_list = env.custom_method(*args)

引數:

num_workers – 同時部署的 worker (即環境例項) 數量；
create_env_fn (callable 或 callable 列表) – 用於建立環境的函式 (或函式列表)。如果使用單個任務，應使用單個 callable 而不是相同的 callable 列表：如果提供了 callable 列表，環境將按需多個不同任務的方式執行，這會帶來輕微的計算開銷；

關鍵字引數:

create_env_kwargs (dict 或 dict 列表，可選) – 用於建立環境的 kwargs；
share_individual_td (bool，可選) – 如果為 True，則為每個程序/worker 建立一個不同的 tensordict，並返回一個 lazy stack。預設值為 None (如果為單個任務則為 False)；
shared_memory (bool) – 返回的 tensordict 是否會放置在共享記憶體中；
memmap (bool) – 返回的 tensordict 是否會放置在記憶體對映中。
policy_proof (callable，可選) – 如果提供，將用於獲取透過 step() 和 reset() 方法返回的張量列表，例如 "hidden" 等。
device (str, int, torch.device) – 可以傳遞批處理環境的裝置。如果未傳遞，則從環境推斷。在這種情況下，假定所有環境的裝置匹配。如果提供了裝置，它可以與子環境裝置不同。在這種情況下，資料在收集期間將自動轉換為適當的裝置。當轉換為裝置引入開銷時 (例如，基於 numpy 的環境等)，這可用於加速收集：透過為批處理環境使用 "cuda" 裝置，但為巢狀環境使用 "cpu" 裝置，可以將開銷降至最低。
num_threads (int，可選) – 此程序的執行緒數量。應等於每個子程序中啟動的程序數量加一 (如果啟動單個程序則為一)。預設值為 worker 數量加 1。此引數對 SerialEnv 類沒有影響。
num_sub_threads (int，可選) – 子程序的執行緒數量。出於安全考慮，預設值為 1：如果未指定，啟動多個 worker 可能會使 CPU 負載過高並損害效能。此引數對 SerialEnv 類沒有影響。
serial_for_single (bool，可選) – 如果為 True，使用單個 worker 建立並行環境將轉而返回 SerialEnv。此選項對 SerialEnv 沒有影響。預設值為 False。
non_blocking (bool，可選) – 如果為 True，裝置移動將使用 non_blocking=True 選項完成。預設值為 True。
mp_start_method (str，可選) – 多程序啟動方法。如果未指定，則使用預設啟動方法 (在 TorchRL 中，如果首次匯入前未另外初始化，則預設為 ‘spawn’)。僅與 ParallelEnv 子類一起使用。
use_buffers (bool，可選) –
worker 之間是否應透過迴圈預分配記憶體緩衝區進行通訊。除非其中一個環境具有動態 specs，否則預設值為 True。

注意

在此處瞭解更多關於動態 specs 和環境的資訊。

注意

可以使用以下技術將關鍵字引數傳遞給每個子環境：reset() 中的每個關鍵字引數都將傳遞給每個環境，但 list_of_kwargs 引數除外；如果存在，該引數應包含一個與 worker 數量相同長度的列表，其中包含儲存在字典中的 worker 特定關鍵字引數。如果查詢部分重置，則將忽略 list_of_kwargs 中與未重置的子環境對應的元素。

示例

>>> from torchrl.envs import GymEnv, ParallelEnv, SerialEnv, EnvCreator
>>> make_env = EnvCreator(lambda: GymEnv("Pendulum-v1")) # EnvCreator ensures that the env is sharable. Optional in most cases.
>>> env = SerialEnv(2, make_env)  # Makes 2 identical copies of the Pendulum env, runs them on the same process serially
>>> env = ParallelEnv(2, make_env)  # Makes 2 identical copies of the Pendulum env, runs them on dedicated processes
>>> from torchrl.envs import DMControlEnv
>>> env = ParallelEnv(2, [
...     lambda: DMControlEnv("humanoid", "stand"),
...     lambda: DMControlEnv("humanoid", "walk")])  # Creates two independent copies of Humanoid, one that walks one that stands
>>> rollout = env.rollout(10)  # executes 10 random steps in the environment
>>> rollout[0]  # data for Humanoid stand
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
        com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
        done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False),
        head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
        joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
        next: TensorDict(
            fields={
                com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
                done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False),
                head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
                joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
                terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
                truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
        truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)},
    batch_size=torch.Size([10]),
    device=cpu,
    is_shared=False)
>>> rollout[1]  # data for Humanoid walk
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
        com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
        done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False),
        head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
        joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
        next: TensorDict(
            fields={
                com_velocity: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
                done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                extremities: Tensor(shape=torch.Size([10, 12]), device=cpu, dtype=torch.float64, is_shared=False),
                head_height: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
                joint_angles: Tensor(shape=torch.Size([10, 21]), device=cpu, dtype=torch.float64, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float64, is_shared=False),
                terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
                truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
                velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        torso_vertical: Tensor(shape=torch.Size([10, 3]), device=cpu, dtype=torch.float64, is_shared=False),
        truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False),
        velocity: Tensor(shape=torch.Size([10, 27]), device=cpu, dtype=torch.float64, is_shared=False)},
    batch_size=torch.Size([10]),
    device=cpu,
    is_shared=False)
>>> # serial_for_single to avoid creating parallel envs if not necessary
>>> env = ParallelEnv(1, make_env, serial_for_single=True)
>>> assert isinstance(env, SerialEnv)  # serial_for_single allows you to avoid creating parallel envs when not necessary

property action_key: NestedKey¶

環境的動作鍵。

預設情況下，此值為 “action”。

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

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

環境的動作鍵列表。

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

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

property action_spec: TensorSpec¶

action specs。

action_spec 始終儲存為複合 specs。

如果 action specs 作為簡單 specs 提供，將返回此值。

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

如果 action specs 作為複合 specs 提供且僅包含一個 leaf，此函式將僅返回該 leaf。

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

如果 action specs 作為複合 specs 提供且包含多個 leaf，此函式將返回整個 specs。

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

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

>>> 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¶: 返回環境的 action specs，就像它沒有批處理維度一樣。

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

將子模組新增到當前模組。

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

引數:

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

add_truncated_keys()¶: 向環境新增截斷鍵。

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

根據 action specs 生成所有可能的動作。

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

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

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

返回一個轉換後的環境，其中應用了傳入的 callable/transform。

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

示例

>>> 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，以推斷環境的輸入和輸出 specs。它根據 rollout 期間收集的資料更新環境的 action、observation、reward 和 done 訊號的 specs。

引數:

policy (Callable[[TensorDictBase], TensorDictBase]) – 一個 callable 策略，接受 TensorDictBase 作為輸入並返回 TensorDictBase 作為輸出。此策略用於執行 rollout 並確定 specs。

關鍵字引數:

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

返回:

具有更新 specs 的環境例項。

返回型別:

EnvBase

引發:

RuntimeError – 如果輸出 specs 中存在未包含在提供的鍵中的鍵。

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

property batch_locked: bool¶

環境是否可以使用與初始化時不同的批次大小。

如果為 True，則環境需要使用與環境具有相同批次大小的 tensordict。batch_locked 是一個不可變屬性。

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 的一個包裝器。

當 action specs 可變時，此類很有用

動作數量可能未定義，例如 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 的結果測試環境 specs。

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

損壞的環境 specs 可能使得使用並行環境變得不可能。

引數:

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

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

children() → Iterator[Module]¶

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

生成:: Module – 子模組

compile(*args, **kwargs)¶

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

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

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

cpu() → T¶

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

注意

此方法會就地修改模組。

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

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

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

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

注意

此方法會就地修改模組。

引數:: device (int, optional) —— 如果指定，所有引數將複製到該裝置
返回:: self
返回型別:: Module

property done_key¶

環境的完成鍵（done key）。

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

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

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

環境的完成鍵（done keys）。

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

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

property done_keys_groups¶

完成鍵（done keys）的列表，按重置鍵（reset keys）分組。

這是一個列表的列表。外部列表的長度與重置鍵（reset keys）的數量一致，內部列表包含完成鍵（done keys）（例如，“done”和“truncated”），當重置鍵不存在時，可以讀取這些完成鍵來確定是否需要重置。

property done_spec: TensorSpec¶

The done 規範。

The done_spec 總是作為組合規範儲存。

如果完成規範（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)

如果完成規範（done spec）作為組合規範提供且僅包含一個葉子節點，此函式將僅返回該葉子節點。

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

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

>>> 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¶: 返回環境的完成規範（done spec），就像它沒有批次維度一樣。

double() → T¶

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

注意

此方法會就地修改模組。

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

empty_cache()¶

擦除所有快取的值。

對於常規環境，鍵列表（例如 reward、done 等）會被快取，但在某些情況下，它們在程式碼執行期間可能會改變（例如，新增 transform 時）。

eval() → T¶

將模組設定為評估模式。

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

這等效於 self.train(False)。

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

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

extra_repr() → str¶

返回模組的額外表示。

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

fake_tensordict() → TensorDictBase¶: 返回一個假的 tensordict，其鍵值對的 shape、device 和 dtype 與環境 rollout 期間預期的相匹配。

float() → T¶

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

注意

此方法會就地修改模組。

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

forward(*args, **kwargs)¶

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

應由所有子類覆蓋。

注意

儘管前向傳播（forward pass）的實現需要在函式內部定義，但之後應呼叫 Module 例項而不是此函式本身，因為前者會負責執行已註冊的 hook，而後者會靜默忽略它們。

property full_action_spec: Composite¶

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

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¶: 返回環境的 action specs，就像它沒有批處理維度一樣。

property full_done_spec: Composite¶

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

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¶: 返回環境的完成規範（done spec），就像它沒有批次維度一樣。

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

property full_reward_spec: Composite¶

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

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¶: 返回環境的獎勵規範（reward spec），就像它沒有批次維度一樣。

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

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

get_buffer(target: str) → Tensor¶

如果存在由 target 指定的緩衝區，則返回該緩衝區，否則引發錯誤。

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

引數:: 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 指定的引數，則返回該引數，否則引發錯誤。

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

引數:: 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_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)（N 為傳遞模組的數量）。因此，對於檢查某個子模組是否存在這種簡單情況，應始終使用 get_submodule。

引數:
target —— 要查詢的子模組的完全限定字串名稱。（有關如何指定完全限定字串，請參見上述示例。）

返回:
由 target 引用的子模組

返回型別:
torch.nn.Module

引發:
AttributeError —— 如果目標字串引用了無效路徑或解析為非 nn.Module 的內容





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

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


返回:
self

返回型別:
Module






property input_spec: TensorSpec¶
輸入規範（Input 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([]))






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




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

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


引數:
device (int, optional) —— 如果指定，所有引數將複製到該裝置

返回:
self

返回型別:
Module






property is_spec_locked¶
獲取環境規範是否被鎖定。
此屬性可以直接修改。

返回:
如果規範被鎖定，則為 True；否則為 False。

返回型別:
bool



另請參見
鎖定環境規範.





load_state_dict(*args, **kwargs)[source]¶
將引數和緩衝區從 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 時，保留當前模組中 tensor 的屬性，而設定為 True 時，保留 state dict 中 Tensor 的屬性。唯一的例外是 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 key），如果需要，在環境完成時進行重置。

引數:
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, optional) —— 如果指定，所有引數將複製到該裝置

返回:
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 —— 一個用於儲存已新增到結果中的模組集合的備忘錄
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、transform 結果等輸出都儲存在 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¶
輸出規範。
包含環境所有資料輸出規範的複合規範。
它包含

“full_reward_spec”：reward 的規範
“full_done_spec”：done 的規範
“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]]) → RemovableHandle¶
在模組上註冊一個 backward hook。
此函式已被棄用，請優先使用 register_full_backward_hook()。此函式的行為將在未來版本中發生變化。

返回:
一個控制代碼，透過呼叫 handle.remove() 可以用來移除已新增的 hook。

返回型別:
torch.utils.hooks.RemovableHandle






register_buffer(name: str, tensor: Optional[Tensor], persistent: bool = True) → None¶
向模組新增一個 buffer。
這通常用於註冊不應被視為模型引數的 buffer。例如，BatchNorm 的 running_mean 不是引數，但它是模組狀態的一部分。預設情況下，buffer 是持久的，並將與引數一起儲存。透過將 persistent 設定為 False 可以更改此行為。持久 buffer 和非持久 buffer 之間的唯一區別在於，後者不屬於此模組的 state_dict。
buffer 可以使用給定的名稱作為屬性進行訪問。

引數:

name (str) – buffer 的名稱。可以使用給定的名稱從此模組訪問該 buffer
tensor (Tensor or None) – 要註冊的 buffer。如果為 None，則對 buffer 進行的操作（例如 cuda）將被忽略。如果為 None，則此 buffer **不**包含在模組的 state_dict 中。
persistent (bool) – buffer 是否是此模組的 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 hook。
每次 forward() 計算出輸出後，都會呼叫該 hook。
如果 with_kwargs 為 False 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hook，僅傳遞給 forward。hook 可以修改輸出。它可以原地修改輸入，但由於是在呼叫 forward() 之後呼叫此 hook，因此對 forward 沒有影響。hook 應具有以下簽名：
hook(module, args, output) -> None or modified output


如果 with_kwargs 為 True，forward hook 將會接收傳遞給 forward 函式的 kwargs，並應返回可能已修改的輸出。hook 應具有以下簽名：
hook(module, args, kwargs, output) -> None or modified output



引數:

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


返回:
一個控制代碼，透過呼叫 handle.remove() 可以用來移除已新增的 hook。

返回型別:
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 pre-hook。
每次呼叫 forward() 之前，都會呼叫該 hook。
如果 with_kwargs 為 false 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hook，僅傳遞給 forward。hook 可以修改輸入。使用者可以在 hook 中返回一個元組或一個修改後的單個值。如果返回單個值（除非該值本身就是一個元組），我們將把該值包裝成一個元組。hook 應具有以下簽名：
hook(module, args) -> None or modified input


如果 with_kwargs 為 true，forward pre-hook 將會接收傳遞給 forward 函式的 kwargs。如果 hook 修改了輸入，則應同時返回 args 和 kwargs。hook 應具有以下簽名：
hook(module, args, kwargs) -> None or a tuple of modified input and kwargs



引數:

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


返回:
一個控制代碼，透過呼叫 handle.remove() 可以用來移除已新增的 hook。

返回型別:
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¶
在模組上註冊一個 backward hook。
每當計算模組的梯度時都會呼叫該 hook，即只有在計算模組輸出的梯度時，該 hook 才會執行。該 hook 應具有以下簽名：
hook(module, grad_input, grad_output) -> tuple(Tensor) or None


`grad_input` 和 `grad_output` 是包含分別對應輸入和輸出梯度的元組。hook 不應修改其引數，但可以選擇返回一個對應輸入的新梯度，該梯度將在後續計算中替換 `grad_input`。`grad_input` 僅對應作為位置引數給出的輸入，所有 kwarg 引數都會被忽略。對於所有非 Tensor 引數，`grad_input` 和 `grad_output` 中的條目將為 `None`。
出於技術原因，當此 hook 應用於模組時，其 forward 函式將接收傳遞給模組的每個 Tensor 的檢視。類似地，呼叫者也將接收模組 forward 函式返回的每個 Tensor 的檢視。

警告
在使用 backward hook 時，不允許原地修改輸入或輸出，否則會引發錯誤。


引數:

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


返回:
一個控制代碼，透過呼叫 handle.remove() 可以用來移除已新增的 hook。

返回型別:
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¶
在此模組上註冊一個 backward pre-hook（反向傳播前置 hook）。
每次計算模組的梯度時，都會呼叫此 hook。此 hook 應具有以下簽名：
hook(module, grad_output) -> tuple[Tensor] or None


引數 grad_output 是一個元組。hook 不應修改其引數，但可以選擇返回一個相對於輸出的新梯度，該梯度將代替 grad_output 用於後續計算。grad_output 中的所有非 Tensor 引數的條目將是 None。
出於技術原因，當此 hook 應用於模組時，其 forward 函式將接收傳遞給模組的每個 Tensor 的檢視。類似地，呼叫者也將接收模組 forward 函式返回的每個 Tensor 的檢視。

警告
使用 backward hook 時，不允許就地修改輸入，否則會引發錯誤。


引數:

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


返回:
一個控制代碼，透過呼叫 handle.remove() 可以用來移除已新增的 hook。

返回型別:
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) 中註冊一個環境。
此方法的設計考慮了以下範圍：

在使用 Gym 的框架中整合一個以 TorchRL 為優先的環境；
在使用 Gym 的框架中整合另一個環境（例如，DeepMind Control、Brax、Jumanji 等）。


引數:
id (字串) – 環境名稱。應遵循 gym 命名約定。

關鍵字引數:

entry_point (可呼叫物件, 可選) –
用於構建環境的入口點。如果未傳入，將使用父類作為入口點。通常，這用於註冊不一定繼承自當前使用的基類的環境
>>> 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], 可選) –
如果提供，這些鍵將用於構建 info 字典，並從 observation 鍵中排除。此引數可在呼叫 make() 時傳入（參見下面的示例）。

警告
使用 info_keys 可能會導致 spec 為空，因為內容已移至 info 字典。Gym 不喜歡 spec 中的空 Dict，因此應使用 RemoveEmptySpecs 刪除此空內容。


backend (字串, 可選) – 後端。可以是 “gym” 或 “gymnasium”，或任何其他與 set_gym_backend 相容的後端。
to_numpy (布林型, 可選) – 如果為 True，則對 step 和 reset 的呼叫結果將對映到 numpy 陣列。預設為 False（結果為 tensors）。此引數可在呼叫 make() 時傳入（參見下面的示例）。
reward_threshold (float, 可選) – [Gym kwarg] 認為已學會環境的獎勵閾值。
nondeterministic (布林型, 可選) – [Gym kwarg] 環境是否是非確定性的（即使知道初始種子和所有動作）。預設為 False。
max_episode_steps (整型, 可選) – [Gym kwarg] 截斷前最大回合步數。由 Time Limit wrapper 使用。
order_enforce (布林型, 可選) – [Gym >= 0.14] 是否應用 order enforcer wrapper 以確保使用者按正確順序執行函式。預設為 True。
autoreset (布林型, 可選) – [Gym >= 0.14] 是否新增 autoreset 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 引數來精細控制哪些內容被視為 observation，哪些內容應被視為 info。

示例
>>> # 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)¶
註冊一個 post-hook（後置 hook），在呼叫模組的 load_state_dict() 後執行。

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


引數 module 是註冊此 hook 的當前模組，引數 incompatible_keys 是一個由屬性 missing_keys 和 unexpected_keys 組成的 NamedTuple。missing_keys 是一個包含缺失鍵的 str list，unexpected_keys 是一個包含意外部索引鍵的 str list。
如有需要，可以就地修改給定的 incompatible_keys。
請注意，正如預期，當呼叫 load_state_dict() 並設定 strict=True 時執行的檢查會受到 hook 對 missing_keys 或 unexpected_keys 所做修改的影響。向任一鍵集中新增內容都會在 strict=True 時引發錯誤，而清除所有缺失和意外部索引鍵則可以避免錯誤。

返回:
一個控制代碼，透過呼叫 handle.remove() 可以用來移除已新增的 hook。

返回型別:
torch.utils.hooks.RemovableHandle






register_load_state_dict_pre_hook(hook)¶
註冊一個 pre-hook（前置 hook），在呼叫模組的 load_state_dict() 之前執行。

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



引數:
hook (可呼叫物件) – 在載入 state dict 之前將被呼叫的可呼叫 hook。






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




register_parameter(name: str, param: Optional[Parameter]) → None¶
向模組新增一個 parameter。
可以使用給定名稱作為屬性訪問該 parameter。

引數:

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







register_state_dict_post_hook(hook)¶
為 state_dict() 方法註冊一個 post-hook（後置 hook）。

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


註冊的 hook 可以就地修改 state_dict。




register_state_dict_pre_hook(hook)¶
為 state_dict() 方法註冊一個 pre-hook（前置 hook）。

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


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




requires_grad_(requires_grad: bool = True) → T¶
更改 autograd 是否應在此模組中記錄對 parameter 的操作。
此方法就地設定 parameter 的 requires_grad 屬性。
此方法有助於凍結模組的部分內容進行微調，或單獨訓練模型的部分內容（例如，GAN 訓練）。
請參閱 區域性停用梯度計算，瞭解 .requires_grad_() 與其他可能混淆的類似機制之間的比較。

引數:
requires_grad (布林型) – autograd 是否應在此模組中記錄對 parameter 的操作。預設值：True。

返回:
self

返回型別:
Module






reset(tensordict: TensorDictBase | None = None, **kwargs) → TensorDictBase¶
重置環境。
與 step 和 _step 類似，只有私有方法 _reset 應該被 EnvBase 子類覆蓋。

引數:

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


返回:
一個 tensordict（如果提供了輸入 tensordict，則為該輸入 tensordict），其中就地修改了產生的 observation。



注意
reset 不應被 EnvBase 子類覆蓋。應修改的方法是 _reset()。





property reset_keys: list[tensordict._nestedkey.NestedKey]¶
返回 reset 鍵列表。
Reset 鍵是表示部分重置的鍵，用於批次、多工或多智慧體設定中。它們的結構是 (*prefix, "_reset")，其中 prefix 是一個（可能為空的）字串元組，指向 tensordict 中可以找到完成狀態的位置。
鍵按資料樹中的深度排序。




property reward_key¶
環境的 reward 鍵。
預設情況下，這將是 “reward”。
如果環境中存在多個 reward 鍵，此函式將引發異常。




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




property reward_spec: TensorSpec¶
reward 規範（spec）。
reward_spec 總是儲存為複合規範。
如果 reward 規範提供為簡單規範，將返回此規範。
>>> 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)


如果 reward 規範提供為複合規範且只包含一個葉子，此函式將只返回該葉子。
>>> 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)


如果 reward 規範提供為複合規範且包含多個葉子，此函式將返回整個規範。
>>> 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([]))


要檢索傳遞的完整 specs，請使用
>>> 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¶
在環境中執行一次 rollout。
一旦任何包含的環境達到任何完成狀態，函式就會立即返回。

引數:

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


關鍵字引數:

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

資料收集推演（rollouts）示例
>>> 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(*args, **kwargs)[source]¶
設定環境的種子並返回要使用的下一個種子（如果存在單個環境，則為輸入的種子）。

引數:

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


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

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






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

引數:
mode (bool) – 是否鎖定 (True) 或解鎖 (False) 規範。預設為 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_c 和 linear。net_c 然後有一個子模組 conv。）
要用新的子模組 Linear 覆蓋 Conv2d，您可以呼叫 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

引數:

target —— 要查詢的子模組的完全限定字串名稱。（有關如何指定完全限定字串，請參見上述示例。）
module – 要將子模組設定為的模組。


引發:

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







property shape¶
等價於 batch_size。




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




property specs: Composite¶
返回一個包含所有環境的 Composite 容器。
此功能允許建立一個環境，在一個數據容器中檢索所有規範（specs），然後從工作區中擦除環境。




state_dict(*args, **kwargs)[source]¶
返回一個字典，其中包含對模組整個狀態的引用。
引數和持久緩衝區（例如執行平均值）都包括在內。鍵是相應的引數和緩衝區名稱。設定為 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 keys）。
預設情況下，只會有一個名為“state”的鍵。
鍵按資料樹中的深度排序。




property state_spec: Composite¶
狀態規範（State spec）。
必須是 torchrl.data.Composite 例項。此處列出的鍵應作為輸入與動作（actions）一起提供給環境。
在 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）。
Step 接受一個引數 tensordict，該引數通常帶有一個“action”鍵，指示要採取的動作。Step 將呼叫一個非就地的私有方法 _step，這是 EnvBase 子類需要重寫的方法。

引數:
tensordict (TensorDictBase) – 包含要採取的動作的 Tensordict。如果輸入的 tensordict 包含“next”條目，則其中包含的值將優先於新計算的值。這提供了一種覆蓋底層計算的機制。

返回:
輸入的 tensordict，就地修改，包含結果觀測（observations）、完成狀態（done state）和獎勵（reward）（如果需要，還包含其他）。






step_and_maybe_reset(tensordict: TensorDictBase) → tuple[tensordict.base.TensorDictBase, tensordict.base.TensorDictBase]¶
在環境中執行一步（step），並在需要時（部分）重置它。

引數:
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 包含更新的觀測（observations）和任何其他相關狀態資訊，鍵根據環境規範（specifications）進行管理。
在內部，此方法利用預計算的 _StepMDP 例項來高效處理狀態、觀測、動作、獎勵和完成鍵的轉換。_StepMDP 類透過預計算要包含和排除的鍵來最佳化過程，減少重複呼叫期間的執行時開銷。_StepMDP 例項使用 exclude_action=False 建立，這意味著動作鍵保留在根 tensordict 中。

引數:
next_tensordict (TensorDictBase) – 一個 tensordict，包含環境在下一個時間步的狀態。此 tensordict 應包含觀測（observations）、動作（actions）、獎勵（rewards）和完成標誌（done flags）的鍵，具體取決於環境規範（specifications）。

返回:
表示環境向前推進一步後的新 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])[source]¶
移動和/或轉換引數和緩衝區的型別。
可以按如下方式呼叫：


to(device=None, dtype=None, non_blocking=False)[source]




to(dtype, non_blocking=False)[source]




to(tensor, non_blocking=False)[source]




to(memory_format=torch.channels_last)[source]


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

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


引數:

device (torch.device) – 此模組中引數和緩衝區的期望裝置
dtype (torch.dtype) – 此模組中引數和緩衝區的期望浮點或複數資料型別
tensor (torch.Tensor) – 其資料型別和裝置是此模組中所有引數和緩衝區期望的資料型別和裝置的張量
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






update_kwargs(kwargs: Union[dict, List[dict]]) → None¶
給定一個字典或字典列表，更新每個環境的 kwargs。

引數:
kwargs (dict or list of dict) – 用於環境的新 kwargs






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

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


引數:
device (int, optional) —— 如果指定，所有引數將複製到該裝置

返回:
self

返回型別:
Module






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

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

SerialEnv¶

文件

教程

資源