ParallelEnv¶

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

為每個程序建立一個環境。

TensorDicts 透過共享記憶體或記憶體對映傳遞。

批處理環境允許使用者查詢遠端執行環境中任意方法/屬性。

這些查詢將返回一個列表，其長度等於 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 或 callables 列表) – 用於建立環境的函式（或函式列表）。如果使用單個任務，應使用 callable 而非相同 callables 的列表：如果提供 callable 列表，環境將像需要多個不同任務一樣執行，這會帶來輕微的計算開銷；

關鍵字引數:

create_env_kwargs (dict 或 dict 列表, 可選) – 用於建立環境的關鍵字引數；
share_individual_td (bool, 可選) – 如果為 True，則為每個程序/worker 建立一個不同的 tensordict，並返回一個 lazy stack。預設值 = None（如果為單個任務則為 False）；
shared_memory (bool) – 返回的 tensordict 是否將放置在共享記憶體中；
memmap (bool) – 返回的 tensordict 是否將放置在記憶體對映中。
policy_proof (callable, 可選) – 如果提供，它將用於獲取透過 step() 和 reset() 方法返回的 tensor 列表，例如 "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 和環境的資訊here。

注意

可以使用以下技術將關鍵字引數傳遞給每個子環境：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

注意

ParallelEnv 將在其中一個 worker 空閒達到指定時間後超時。這可以透過 BATCHED_PIPE_TIMEOUT 環境變數控制，該變數會修改 torchrl._utils.BATCHED_PIPE_TIMEOUT 整型值。預設超時值為 10000 秒。

警告

TorchRL 的 ParallelEnv 在環境 specs 方面相當嚴格，因為它們用於構建程序間通訊的共享記憶體緩衝區。因此，我們鼓勵使用者首先使用 check_env_specs() 檢查環境 specs。

>>> from torchrl.envs import check_env_specs
>>> env = make_env()
>>> check_env_specs(env) # if this passes without error you're good to go!
>>> penv = ParallelEnv(2, make_env)

特別是，如果未正確設定 specs，帶有 info-dict readers 的類似 gym 的環境可能難以跨程序共享，這很難自動完成。請檢視 set_info_dict_reader() 以獲取更多資訊。下面是一個簡短示例

>>> from torchrl.envs import GymEnv, set_gym_backend, check_env_specs, TransformedEnv, TensorDictPrimer
>>> import torch
>>> env = GymEnv("HalfCheetah-v4")
>>> env.rollout(3)  # no info registered, this env passes check_env_specs
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10, 6]), device=cpu, dtype=torch.float32, 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, 17]), device=cpu, dtype=torch.float64, 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, 17]), device=cpu, dtype=torch.float64, 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)
>>> check_env_specs(env)  # succeeds!
>>> env.set_info_dict_reader()  # sets the default info_dict reader
>>> env.rollout(10)  # because the info_dict is empty at reset time, we're missing the root infos!
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10, 6]), device=cpu, dtype=torch.float32, 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, 17]), device=cpu, dtype=torch.float64, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                reward_ctrl: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
                reward_run: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, 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),
                x_position: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
                x_velocity: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([10, 17]), device=cpu, dtype=torch.float64, 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)
>>> check_env_specs(env)  # This check now fails! We should not use an env constructed like this in a parallel env
>>> # This ad-hoc fix registers the info-spec for reset. It is wrapped inside `env.auto_register_info_dict()`
>>> env_fixed = TransformedEnv(env, TensorDictPrimer(env.info_dict_reader[0].info_spec))
>>> env_fixed.rollout(10)
TensorDict(
    fields={
        action: Tensor(shape=torch.Size([10, 6]), device=cpu, dtype=torch.float32, 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, 17]), device=cpu, dtype=torch.float64, is_shared=False),
                reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False),
                reward_ctrl: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
                reward_run: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, 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),
                x_position: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
                x_velocity: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False)},
            batch_size=torch.Size([10]),
            device=cpu,
            is_shared=False),
        observation: Tensor(shape=torch.Size([10, 17]), device=cpu, dtype=torch.float64, is_shared=False),
        reward_ctrl: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
        reward_run: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, 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),
        x_position: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False),
        x_velocity: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.float64, is_shared=False)},
    batch_size=torch.Size([10]),
    device=cpu,
    is_shared=False)
>>> check_env_specs(env_fixed)  # Succeeds! This env can be used within a parallel env!

相關類和方法：auto_register_info_dict() 和 default_info_dict_reader。

警告

選擇執行 ParallelEnv 的裝置會極大地影響其效能。經驗法則是

如果基礎環境（後端，例如 Gym）在 CPU 上執行，則子環境也應在 CPU 上執行，資料應透過共享物理記憶體傳遞。

如果基礎環境在 (或可以在) CUDA 上執行，則子環境也應放置在 CUDA 上。

如果 CUDA 裝置可用且策略將在 CUDA 上執行，則 ParallelEnv 裝置應設定為 CUDA。

因此，假設 CUDA 裝置可用，我們有以下場景

>>> # The sub-envs are executed on CPU, but the policy is on GPU
>>> env = ParallelEnv(N, MyEnv(..., device="cpu"), device="cuda")
>>> # The sub-envs are executed on CUDA
>>> env = ParallelEnv(N, MyEnv(..., device="cuda"), device="cuda")
>>> # this will create the exact same environment
>>> env = ParallelEnv(N, MyEnv(..., device="cuda"))
>>> # If no cuda device is available
>>> env = ParallelEnv(N, MyEnv(..., device="cpu"))

警告

ParallelEnv 在所有操作（step()、reset() 和 step_and_maybe_reset()）中停用梯度，因為梯度無法透過 multiprocessing.Pipe 物件傳遞。只有 SerialEnv 支援反向傳播。

property action_key: NestedKey¶

環境的動作鍵。

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

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

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

環境的動作鍵列表。

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

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

property action_spec: TensorSpec¶

action spec。

action_spec 始終儲存為複合 spec。

如果 action spec 作為簡單 spec 提供，則返回此簡單 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)

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

>>> 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 spec 作為複合 spec 提供且包含多個葉節點，此函式將返回整個 spec。

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

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

>>> 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 spec，就像它沒有批處理維度一樣。

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

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

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

引數:

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

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

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

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

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

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

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，以推斷環境的輸入和輸出規格。它根據 rollout 期間收集的資料更新環境的 actions、observations、rewards 和 done signals 的 specs。

引數:

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

關鍵字引數:

tensordict (TensorDictBase, 可選) – 一個可選的 TensorDictBase 例項，用作 rollout 的初始狀態。如果未提供，將呼叫環境的 reset 方法以獲取初始狀態。
action_key (NestedKey 或 List[NestedKey], 可選) – 用於在 TensorDictBase 中標識 actions 的鍵。預設為“action”。
done_key (NestedKey 或 List[NestedKey], 可選) – 用於在 TensorDictBase 中標識 done signals 的鍵。預設為 None，這將嘗試使用 ["done", "terminated", "truncated"] 作為潛在鍵。
observation_key (NestedKey 或 List[NestedKey], 可選) – 用於在 TensorDictBase 中標識 observations 的鍵。預設為“observation”。
reward_key (NestedKey 或 List[NestedKey], 可選) – 用於在 TensorDictBase 中標識 rewards 的鍵。預設為“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 (布林值) – 如果為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, 可選) – 包含計算基數所需資料的張量字典。

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 (布林值, 可選) – 如果為 ``True``，則將以 return_contiguous=True 呼叫隨機 rollout。在某些情況下（例如輸入/輸出形狀異構）這將失敗。預設為 ``None``（取決於是否存在動態規範）。
check_dtype (布林值, 可選) – 如果為 False，將跳過 dtype 檢查。預設為 True。
seed (整型, 可選) – 為了重現性，可以設定一個種子。種子將在 pytorch 中臨時設定，然後 RNG 狀態將恢復到之前的狀態。對於環境，我們設定種子，但由於將 rng 狀態恢復到之前並不是大多數環境的功能，因此我們將其留給使用者完成。預設為 ``None``。
tensordict (TensorDict, 可選) – 用於重置的可選 TensorDict 例項。

注意：此函式會重置環境種子。應將其“離線”使用，以檢查環境是否已充分構建，但它可能會影響實驗的種子設定，因此應將其排除在訓練指令碼之外。

children() → Iterator[Module]¶

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

生成:: Module – 子模組

compile(*args, **kwargs)¶

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

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

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

cpu() → T¶

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

注意

此方法就地修改模組。

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

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

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

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

注意

此方法就地修改模組。

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

property done_key¶

環境的完成鍵。

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

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

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

環境的完成鍵列表。

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

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

property done_keys_groups¶

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

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

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¶

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

注意

此方法就地修改模組。

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

empty_cache()¶

擦除所有快取值。

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

eval() → T¶

將模組設定為評估模式。

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

這等同於 self.train(False)。

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

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

extra_repr() → str¶

返回模組的額外表示。

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

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

float() → T¶

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

注意

此方法就地修改模組。

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

forward(*args, **kwargs)¶

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

應由所有子類覆蓋。

注意

雖然 forward 傳遞的實現需要在該函式內部定義，但之後應該呼叫 Module 例項而不是此函式，因為前者會負責執行註冊的 hook，而後者會靜默地忽略它們。

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

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

full_done_spec 是一個 Composite` 例項，包含所有完成條目。它可用於生成結構上模仿執行時獲得的資料的偽資料。: 返回環境的完成規範，如同它沒有批處理維度一樣。

property full_done_spec_unbatched: Composite¶

property full_observation_spec_unbatched: Composite¶

返回環境的觀察規範，如同它沒有批處理維度一樣。

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

完整獎勵規範。: full_reward_spec 是一個 Composite` 例項，包含所有獎勵條目。

property full_reward_spec_unbatched: Composite¶

返回環境的獎勵規範，如同它沒有批處理維度一樣。

property full_state_spec: Composite¶

示例

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

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

property full_state_spec_unbatched: Composite¶

返回環境的狀態規範，如同它沒有批處理維度一樣。

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() 時會呼叫此函式。
返回型別:: 請注意，額外狀態應該是可 picklable 的，以確保 state_dict 的序列化正常工作。我們僅為序列化張量提供向後相容性保證；如果其他物件的序列化 pickle 形式發生變化，可能會破壞向後相容性。

要儲存在模組 state_dict 中的任何額外狀態

object

get_buffer(target: str) → Tensor¶

引數:: get_parameter(target: str) → Parameter¶
返回:: 如果 target 指定的引數存在，則返回它，否則丟擲錯誤。
返回型別:: target – 要查詢的 Parameter 的完全限定字串名稱。（有關如何指定完全限定字串，請參閱 ``get_submodule``。）
引發:: 由 target 引用的 Parameter

torch.nn.Parameter

AttributeError – 如果目標字串引用了無效路徑或解析為非 ``nn.Parameter`` 的物件。

get_submodule(target: str) → Module¶

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

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

例如，假設您有一個 nn.Module A，它看起來像這樣：

（該圖顯示了一個 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`` 的物件。

注意

此方法就地修改模組。

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

half() → T¶

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

property input_spec: TensorSpec¶

輸入規範。

包含所有輸入到環境的資料規範的複合規範。
它包含

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

“full_state_spec”：所有其他環境輸入的規範: 此屬性被鎖定且應為只讀。相反，要設定其中包含的規範，請使用相應的屬性。

property input_spec_unbatched: Composite¶

返回環境的輸入規範，如同它沒有批處理維度一樣。

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

注意

此方法就地修改模組。

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

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

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

property is_spec_locked¶

返回:: 獲取環境規範是否被鎖定。
返回型別:: 此屬性可以直接修改。

如果規範被鎖定則為 True，否則為 False。

bool.

另請參閱

鎖定環境規範

load_state_dict(*args, **kwargs)[source]¶

警告

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

引數:

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

返回:

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

返回型別:

帶有 missing_keys 和 unexpected_keys 欄位的 NamedTuple

注意

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

maybe_reset(tensordict: TensorDictBase) → TensorDictBase¶

檢查輸入 tensordict 的 done 鍵，並在必要時重置已完成的環境。

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

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

返回模組緩衝區的迭代器，產生緩衝區的名稱及其本身。

引數:

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

生成:

(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, 可選) – 是否移除結果中的重複引數。預設值為 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 例項。規範中列出的鍵在 reset 和 step 後可直接訪問。

在 TorchRL 中，即使它們嚴格來說不是“觀測”，環境輸出的所有資訊、狀態、轉換結果等都儲存在 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”: 所有其他環境輸出的規範

“full_action_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, 可選) – 結果動作應寫入的 tensordict。
返回:: 一個 tensordict 物件，其 “action” 條目已更新為 action-spec 中的隨機樣本。

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

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

引數:: tensordict (TensorDictBase, 可選) – 結果資訊應寫入的 tensordict。
返回:: 一個 tensordict 物件，包含在環境中隨機步驟後的新觀測。動作將使用 “action” 鍵儲存。

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

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

此函式已被棄用，推薦使用 register_full_backward_hook()，並且此函式的行為將在未來版本中改變。

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

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

向模組新增一個緩衝區。

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

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

引數:

name (str) – 緩衝區的名稱。可以使用給定的名稱從此模組訪問緩衝區。
tensor (Tensor 或 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 函式的 kwargs。預設值: False
always_call (bool) – 如果為 True，無論呼叫模組時是否引發異常，都將執行 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，前向預鉤子將被傳遞給前向函式提供的關鍵字引數。如果鉤子修改了輸入，則應同時返回位置引數和關鍵字引數。鉤子應具有以下簽名：

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

引數:

hook (Callable) – 要註冊的使用者定義鉤子。
prepend (布林型別) – 如果為 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 (布林型別) – 如果為 True，hook 將被傳遞前向函式提供的關鍵字引數。預設值：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_output 中的條目對於所有非 Tensor 引數都將是 None。

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

警告

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

引數:

hook (可呼叫物件) – 要註冊的使用者定義的鉤子。
prepend (布林型別) – 如果為 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。

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

警告

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

引數:

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

返回:

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

返回型別:

torch.utils.hooks.RemovableHandle

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

在 gym(nasium) 中註冊一個環境。

此方法旨在考慮以下應用範圍：

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

引數:

id (字串型別) – 環境的名稱。應遵循 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 (列表[NestedKey], 可選) – 如果提供，這些鍵將用於構建 info 字典，並會從觀察鍵中排除。
此引數可以在呼叫 make() 時傳遞（參見下例）。

警告

可能出現的情況是，使用 info_keys 會使得規範（spec）變空，因為內容已移至 info 字典。Gym 不喜歡規範中的空 Dict，因此應使用 RemoveEmptySpecs 移除此空內容。
backend (字串型別, 可選) – 後端。可以是 “gym” 或 “gymnasium” 或任何其他與 set_gym_backend 相容的後端。
to_numpy (布林型別, 可選) – 如果為 True，呼叫 step 和 reset 的結果將被對映到 numpy 陣列。預設為 False（結果是 tensor）。此引數可以在呼叫 make() 時傳遞（參見下例）。
reward_threshold (浮點型別, optional) – [Gym 關鍵字引數] 被認為已學會一個環境的獎勵閾值。
nondeterministic (布林型別, 可選) – [Gym 關鍵字引數] 如果環境是非確定性的（即使知道初始種子和所有動作）。預設為 False。
max_episode_steps (整數型別, 可選) – [Gym 關鍵字引數] 截斷前的最大情節步數。由 Time Limit 包裝器使用。
order_enforce (布林型別, 可選) – [Gym 版本 >= 0.14] 是否應應用順序強制包裝器，以確保使用者按正確順序執行函式。預設為 True。
autoreset (布林型別, 可選) – [Gym 版本 >= 0.14] 是否應新增自動重置包裝器，以便無需呼叫 reset。預設為 False。
disable_env_checker – [Gym 版本 >= 0.14] 是否應對環境停用環境檢查器。預設為 False。
apply_api_compatibility – [Gym 版本 >= 0.26] 是否應用 StepAPICompatibility 包裝器。預設為 False。
\*\*kwargs – 傳遞給環境建構函式的任意關鍵字引數。

注意

TorchRL 的環境沒有“info”字典的概念，因為 TensorDict 提供了大多數訓練設定中所有被認為必要的儲存需求。不過，您可以使用 info_keys 引數來細粒度地控制哪些被視為觀察，哪些應被視為 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)¶

註冊一個後鉤子，該鉤子將在模組的 load_state_dict() 方法被呼叫後執行。

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

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

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

請注意，呼叫 load_state_dict() 並設定 strict=True 時執行的檢查會受到鉤子對 missing_keys 或 unexpected_keys 所做修改的影響，如預期。向任一鍵集合新增條目都會在 strict=True 時導致丟擲錯誤，而清空所有缺失和意外部索引鍵則會避免錯誤。

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

register_load_state_dict_pre_hook(hook)¶

註冊一個預鉤子，該鉤子將在模組的 load_state_dict() 方法被呼叫前執行。

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

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

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

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

向模組新增一個引數。

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

引數:

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

register_state_dict_post_hook(hook)¶

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

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

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

register_state_dict_pre_hook(hook)¶

註冊一個用於 state_dict() 方法的預鉤子（pre-hook）。

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

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

requires_grad_(requires_grad: bool = True) → T¶

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

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

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

請參閱區域性停用梯度計算，瞭解 .requires_grad_() 和與其可能混淆的幾個類似機制的比較。

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

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

重置環境。

與 step 和 _step 類似，只有私有方法 _reset 應該被 EnvBase 子類覆蓋。

引數:

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

返回:

一個 tensordict（如果提供了輸入 tensordict，則是該 tensordict），會用生成的觀測值進行原地修改。

注意

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

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

返回 reset 鍵的列表。

Reset 鍵是表示部分 reset 的鍵，用於批處理、多工或多智慧體設定。它們的結構是 (*prefix, "_reset")，其中 prefix 是一個（可能為空的）字串元組，指向 tensordict 中可以找到 done 狀態的位置。

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

property reward_key¶

環境的獎勵鍵。

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

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

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

環境的獎勵鍵列表。

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

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

property reward_spec: TensorSpec¶

reward 規格。

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

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

>>> 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¶: full_reward_spec 是一個 Composite` 例項，包含所有獎勵條目。

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。

一旦包含的任一環境達到任一 done 狀態，函式將立即返回。

引數:

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

關鍵字引數:

auto_reset (bool, 可選的) – 如果為 True，包含的環境將在開始 rollout 之前重置。如果為 False，rollout 將從先前的狀態繼續，這需要傳遞包含先前 rollout 狀態的 tensordict 引數。預設值為 True。
auto_cast_to_device (bool, 可選的) – 如果為 True，tensordict 的裝置將在使用策略之前自動轉換為策略的裝置。預設值為 False。
break_when_any_done (bool) – 如果為 True，則當包含的任一環境達到任一 done 狀態時中斷。如果為 False，則已完成的環境會自動重置。預設值為 True。
break_when_all_done (bool, 可選的) – 如果為 True，則當所有包含的環境都達到任一 done 狀態時中斷。如果為 False，則當至少一個環境達到任一 done 狀態時中斷。預設值為 False。
return_contiguous (bool) – 如果為 False，將返回一個 LazyStackedTensorDict。如果環境沒有動態規格，預設值為 True，否則為 False。
tensordict (TensorDict, 可選的) – 如果 auto_reset 為 False，必須提供一個初始 tensordict。Rollout 將檢查該 tensordict 是否有 done 標誌，並在這些維度上重置環境（如果需要）。如果 tensordict 是 reset 的輸出，通常不會發生這種情況，但如果 tensordict 是先前 rollout 的最後一步，則可能發生。如果需要向 reset 方法傳遞元資料（例如無狀態環境的 batch-size 或裝置），在 auto_reset=True 時也可以提供一個 tensordict。
set_truncated (bool, 可選的) – 如果為 True，在 rollout 完成後，"truncated" 和 "done" 鍵將被設定為 True。如果在 done_spec 中找不到 "truncated"，則引發異常。Truncated 鍵可以透過 env.add_truncated_keys 設定。預設值為 False。
trust_policy (bool, 可選的) – 如果為 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)

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

非 contiguous 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(*args, **kwargs)[源]¶

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

引數:

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

返回:

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

返回型別:

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

set_spec_lock_(mode: bool = True) → EnvBase¶

鎖定或解鎖環境的 specs。

引數:: mode (bool) – 是否鎖定 (True) 或解鎖 (False) specs。預設為 True。
返回:: 環境例項本身。
返回型別:: EnvBase

如果規範被鎖定則為 True，否則為 False。

bool.

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

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

get_submodule(target: str) → Module¶

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

引數:

要檢查是否存在 linear 子模組，我們可以呼叫 get_submodule("net_b.linear")。要檢查是否存在 conv 子模組，我們可以呼叫 get_submodule("net_b.net_c.conv")。
module – 要設定子模組的目標模組。

引發:

ValueError – 如果目標字串為空
由 target 引用的子模組

property shape¶: 等效於 batch_size。

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

property specs: Composite¶

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

此功能允許建立環境，將所有 specs 檢索到一個數據容器中，然後從工作空間中刪除環境。

state_dict(*args, **kwargs)[源]¶

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

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

注意

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

警告

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

警告

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

引數:

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

返回:

一個包含模組整個狀態的字典

返回型別:

dict

示例

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

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

環境的狀態鍵。

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

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

property state_spec: Composite¶

狀態規格。

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

在 TorchRL 中，即使它們並非嚴格意義上的“state”，所有非動作的環境輸入都儲存在 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¶: full_state_spec 是一個 Composite` 例項，包含所有狀態條目（即，非動作的輸入資料）。

step(tensordict: TensorDictBase) → TensorDictBase¶

在環境中執行一個步驟。

Step 方法接受一個引數 tensordict，該引數通常帶有一個 'action' 鍵，用於指示要採取的動作。Step 方法會呼叫一個 out-place 私有方法 _step，該方法需要由 EnvBase 子類進行重寫。

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

step_and_maybe_reset(*args, **kwargs)[source]¶

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

引數:: 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 例項來高效處理狀態、觀測、動作、獎勵和完成（done）鍵的轉換。 _StepMDP 類透過預計算要包含和排除的鍵來最佳化此過程，從而減少重複呼叫期間的執行時開銷。建立 _StepMDP 例項時設定 exclude_action=False，這意味著動作鍵會保留在根 tensordict 中。

引數:: next_tensordict (TensorDictBase) – 包含環境在下一個時間步的狀態的 tensordict。此 tensordict 應包含觀測、動作、獎勵和完成（done）標誌的鍵，這些鍵由環境的規範定義。
返回:: 一個新的 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（如果給定），但其 dtype 保持不變。當設定了 non_blocking 時，如果可能，它會嘗試相對於主機非同步轉換/移動，例如將具有固定記憶體的 CPU Tensor 移動到 CUDA 裝置。

參見下方示例。

注意

此方法就地修改模組。

引數:

device (torch.device) – 此模組中引數和緩衝區的目標裝置
dtype (torch.dtype) – 此模組中引數和緩衝區的目標浮點型或複數型 dtype
tensor (torch.Tensor) – 其 dtype 和 device 是此模組中所有引數和緩衝區的目標 dtype 和 device 的 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 (整型, 可選) – 如果指定，所有引數將複製到該裝置。
返回:: self
返回型別:: Module

zero_grad(set_to_none: bool = True) → None¶

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

有關更多上下文，請參閱 torch.optim.Optimizer 下的類似函式。

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

ParallelEnv¶

文件

教程

資源