ParallelEnv¶

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

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

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

批次環境允許使用者查詢遠端運行的環境的任意方法/屬性。

這些查詢將傳回一個長度等於工作者數量的列表，其中包含來自這些查詢的值。

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

參數:

num_workers – 要同時部署的工作者 (即環境實例) 數量；
create_env_fn (callable 或 callable 列表) – 用於環境建立的函數（或函數列表）。如果使用單個任務，則應使用 callable 而不是相同的 callable 列表：如果提供 callable 列表，則環境將被執行，就像需要多個不同的任務一樣，這會帶來輕微的計算開銷；

關鍵字引數:

create_env_kwargs (dict 或 dict 列表, 可選) – 與正在建立的環境一起使用的 kwargs；
share_individual_td (bool, 可選) – 如果 True，則為每個處理程序/工作者建立不同的 tensordict，並傳回 lazy stack。預設值 = None (如果是單個任務，則為 False)；
shared_memory (bool) – 傳回的 tensordict 是否放置在共享記憶體中；
memmap (bool) – 傳回的 tensordict 是否放置在記憶體映射中。
policy_proof (callable, 可選) – 如果提供，它將用於取得透過 step() 和 reset() 方法傳回的張量列表，例如 "hidden" 等。
device (str, int, torch.device) – 可以傳遞批次環境的設備。如果沒有，則從 env 推斷。在這種情況下，假設所有環境的設備都匹配。如果提供，它可以與子環境設備不同。在這種情況下，資料將在收集過程中自動轉換為適當的設備。這可以用於加速收集，以防轉換到設備引入開銷（例如，基於 numpy 的環境等）：透過為批次環境使用 "cuda" 設備，但為巢狀環境使用 "cpu" 設備，可以將開銷降至最低。
num_threads (int, 可選) – 此處理程序的執行緒數。應等於 1 加上每個子處理程序中啟動的處理程序數（如果只啟動一個處理程序，則為 1）。預設值為工作者數量 + 1。此參數對 SerialEnv 類別沒有影響。
num_sub_threads (int, optional) – 子進程的執行緒數量。預設值為 1 以確保安全：如果沒有指定，啟動多個 worker 可能會使 CPU 負載過重並損害效能。這個參數對 SerialEnv 類別沒有作用。
serial_for_single (bool, optional) – 如果 True，建立一個只有單個 worker 的平行環境將會回傳一個 SerialEnv。這個選項對 SerialEnv 沒有作用。預設值為 False。
non_blocking (bool, optional) – 如果 True，裝置移動將會使用 non_blocking=True 選項完成。預設值為 True。
mp_start_method (str, optional) – multiprocessing 的啟動方法。如果沒有指定，則使用預設的啟動方法（如果在第一次匯入之前沒有以其他方式啟動，則 TorchRL 中預設為 ‘spawn’）。僅能與 ParallelEnv 的子類別一起使用。
use_buffers (bool, optional) –
worker 之間的通訊是否應該透過預先分配的循環記憶體緩衝區進行。預設值為 True，除非其中一個環境具有動態規範。

注意

在這裡瞭解更多關於動態規範和環境的資訊：這裡。

注意

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

警告

TorchRL 的 ParallelEnv 對於環境規範非常嚴格，因為這些規範被用來為進程間通訊建立共享記憶體緩衝區。因此，我們鼓勵使用者首先使用 check_env_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)

特別是，如果沒有正確設定規範，具有 info-dict 讀取器的類似 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[NestedKey]¶

環境的動作鍵。

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

鍵會依照資料樹中的深度排序。

property action_spec: TensorSpec¶

action 規範。

action_spec 始終儲存為複合規範。

如果動作規範以簡單規範的形式提供，則將會回傳這個簡單規範。

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

如果動作規範以複合規範的形式提供，且只包含一個葉節點，則此函數將只回傳該葉節點。

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

如果動作規範以複合規範的形式提供，且有多個葉節點，則此函數將回傳完整的規範。

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

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

>>> env.input_spec["full_action_spec"]

這個屬性是可變的。

範例

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

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

將子模組添加到目前的模組。

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

參數:

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

add_truncated_keys()¶: 將截斷的鍵添加到環境中。

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

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

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

範例

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

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

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

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

參數:: fn (Module -> None) – 要應用於每個子模組的函數
回傳值:: self
回傳型別:: Module

範例

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

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)

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

如果環境中有多個完成鍵，此函數將引發例外。

property done_keys: List[NestedKey]¶

環境的完成鍵 (done keys)。

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

鍵會依照資料樹中的深度排序。

property done_keys_groups¶

完成鍵的列表，分組為重設鍵 (reset keys)。

這是一個列表的列表。外層列表的長度為重設鍵的數量，內層列表包含完成鍵（例如，done 和 truncated），當重設鍵不存在時，可以讀取這些完成鍵以確定重設。

property done_spec: TensorSpec¶

done 的規格 (spec)。

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

如果完成規格是以簡單規格 (simple 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)

如果完成規格是以複合規格形式提供，且只包含一個葉節點 (leaf)，則此函數將僅返回該葉節點。

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

double() → T¶

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

注意

此方法會就地修改模組。

回傳值:: self
回傳型別:: Module

empty_cache()¶

清除所有快取的值。

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

eval() → T¶

將模組設定為評估模式 (evaluation mode)。

這僅對某些模組產生影響。請參閱特定模組的文件，以了解它們在訓練/評估模式下的行為詳情（如果它們受到影響），例如 Dropout, BatchNorm 等。

這等同於 self.train(False)。

有關 .eval() 與幾個可能與之混淆的類似機制之間的比較，請參閱局部停用梯度計算 (Locally disabling gradient computation)。

回傳值:: self
回傳型別:: Module

extra_repr() → str¶

設定模組的額外表示 (extra representation)。

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

fake_tensordict() → TensorDictBase¶: 返回一個偽造的 tensordict，其鍵值對在形狀、裝置和資料類型方面與環境 rollout 期間預期的內容相符。

float() → T¶

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

注意

此方法會就地修改模組。

回傳值:: self
回傳型別:: Module

forward(tensordict: TensorDictBase) → TensorDictBase¶

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

應由所有子類別覆寫。

注意

雖然 forward pass 的配方需要在這個函數中定義，但之後應該呼叫 Module 實例，而不是這個函數，因為前者負責執行已註冊的 hook，而後者會靜默地忽略它們。

property full_action_spec: Composite¶

完整的動作規格 (full 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_done_spec: Composite¶

完整的 done spec。

full_done_spec 是一個 Composite` 實例，包含所有 done 項目。它可以用於生成假資料，其結構模仿在運行時獲得的結構。

範例

>>> 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_reward_spec: Composite¶

完整的 reward spec。

full_reward_spec 是一個 Composite` 實例，包含所有 reward 項目。

範例

>>> 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_state_spec: Composite¶

完整的 state spec。

full_state_spec 是一個 Composite` 實例，包含所有 state 項目（即，不是 action 的輸入資料）。

範例

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

get_buffer(target: str) → Tensor¶

如果存在 target 指定的 buffer，則返回該 buffer，否則拋出錯誤。

請參閱 get_submodule 的 docstring，以獲得關於此方法功能的更詳細解釋，以及如何正確指定 target。

參數:: target – 要尋找的 buffer 的完整字串名稱。（請參閱 get_submodule 了解如何指定完整的字串。）
回傳值:: target 引用的 buffer
回傳型別:: torch.Tensor
Raises:: AttributeError – 如果 target 字串引用無效路徑，或解析為不是 buffer 的東西

get_extra_state() → Any¶

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

如果需要儲存額外狀態，請為您的模組實作此方法和對應的 set_extra_state()。當建立模組的 state_dict() 時，會呼叫此函數。

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

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

get_parameter(target: str) → Parameter¶

如果存在 target 指定的 parameter，則返回該 parameter，否則拋出錯誤。

請參閱 get_submodule 的 docstring，以獲得關於此方法功能的更詳細解釋，以及如何正確指定 target。

參數:: target – 要尋找的 Parameter 的完整字串名稱。（請參閱 get_submodule 了解如何指定完整的字串。）
回傳值:: target 引用的 Parameter
回傳型別:: torch.nn.Parameter
Raises:: AttributeError – 如果 target 字串引用無效路徑，或解析為不是 nn.Parameter 的東西

get_submodule(target: str) → Module¶

如果存在 target 指定的 submodule，則返回該 submodule，否則拋出錯誤。

例如，假設您有一個 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 有一個巢狀 submodule net_b，它本身有兩個 submodule net_c 和 linear。net_c 然後有一個 submodule 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
Raises:: AttributeError – 如果目標字串引用了無效的路徑，或解析為不是 nn.Module 的內容

half() → T¶

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

注意

此方法會就地修改模組。

回傳值:: self
回傳型別:: Module

property input_spec: TensorSpec¶

輸入規格。

包含環境數據輸入的所有規格的複合規格。

它包含

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

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

範例

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

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

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

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

注意

此方法會就地修改模組。

參數:: device (int, optional) – 如果指定，所有參數將被複製到該裝置
回傳值:: self
回傳型別:: Module

load_state_dict(*args, **kwargs)[原始碼]¶

將參數和緩衝區從 state_dict 複製到此模組及其子系。

如果 strict 為 True，則 state_dict 的鍵必須與此模組的 state_dict() 函數傳回的鍵完全匹配。

警告

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

參數:

state_dict (dict) – 包含參數和持久性緩衝區的字典。
strict (bool, optional) – 是否嚴格強制執行 state_dict 中的鍵與此模組的 state_dict() 函數傳回的鍵匹配。預設值：True
assign (bool, optional) – 當 False 時，會保留目前模組中張量的屬性，而當 True 時，會保留狀態字典中張量的屬性。唯一的例外是 requires_grad 欄位預設： ``False`

回傳值:

missing_keys 是一個 str 列表，其中包含此模組預期但提供的 state_dict 中缺少的任何鍵。
由此模組預期但提供的 state_dict 中缺少的任何鍵。
unexpected_keys 是一個 str 列表，其中包含此模組不
預期但存在於提供的 state_dict 中的鍵。

回傳型別:

NamedTuple 具有 missing_keys 和 unexpected_keys 欄位

注意

如果參數或緩衝區註冊為 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 (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) – 包含名稱和緩衝區的 Tuple

範例

>>> # 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) – 包含名稱和子模組的 Tuple

範例

>>> # 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) – 名稱和模組的 Tuple

注意

重複的模組只會返回一次。在下面的例子中，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) – 包含名稱和參數的 Tuple

範例

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

property observation_spec: Composite¶

Observation spec（觀測規格）。

必須是一個 torchrl.data.Composite 實例。重置 (reset) 和步進 (step) 後可以直接存取 spec 中列出的鍵。

在 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 output_spec: TensorSpec¶

Output spec（輸出規格）。

包含環境資料輸出的所有規格的 composite spec。

它包含

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

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

回傳一個模組參數的迭代器。

這通常會傳遞給 optimizer（優化器）。

參數:: 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: Optional[TensorDictBase] = None)¶

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

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

rand_step(tensordict: Optional[TensorDictBase] = 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¶

在模組上註冊一個反向 hook。

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

回傳值:: 一個控制代柄 (handle)，可用於透過呼叫 handle.remove() 來移除新增的 hook。
回傳型別:: torch.utils.hooks.RemovableHandle

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

將一個 buffer 加入模組中。

這通常用於註冊不應被視為模型參數的 buffer。例如，BatchNorm 的 running_mean 不是參數，而是模組狀態的一部分。預設情況下，Buffers 是持久性的，將與參數一起保存。可以透過將 persistent 設定為 False 來更改此行為。持久性 buffer 和非持久性 buffer 之間的唯一區別是，後者不會成為此模組的 state_dict 的一部分。

可以使用給定的名稱作為屬性來存取 Buffers。

參數:

name (str) – buffer 的名稱。可以使用給定的名稱從此模組存取該 buffer
tensor (Tensor 或 None) – 要註冊的 buffer。如果 None，則會忽略在 buffers 上運行的操作，例如 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 或未指定，則輸入僅包含提供給模組的位置引數。關鍵字引數將不會傳遞給 hooks，而只會傳遞給 forward。該 hook 可以修改輸出。它可以就地修改輸入，但由於 forward() 是在 forward() 呼叫之後呼叫的，因此它不會對 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 hooks 之前觸發。否則，提供的 hook 將在此 torch.nn.modules.Module 上所有現有的 forward hooks 之後觸發。請注意，使用 register_module_forward_hook() 註冊的全域 forward hooks 將在由此方法註冊的所有 hooks 之前觸發。預設值：False
with_kwargs (bool) – 如果 True，則 hook 會被傳遞給 forward 函數的 kwargs。預設值：False
always_call (bool) – 如果 True，無論在呼叫 Module 時是否引發異常，都會執行 hook。預設值：False

回傳值:

一個控制代柄 (handle)，可用於透過呼叫 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 中回傳一個 tuple 或一個單一的修改值。如果回傳單一值（除非該值已經是 tuple），我們會將該值包裝成一個 tuple。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 hooks 之前觸發。否則，提供的 hook 將在這個 torch.nn.modules.Module 上所有現有的 forward_pre hooks 之後觸發。請注意，通過 register_module_forward_pre_hook() 註冊的全域 forward_pre hooks 將在通過此方法註冊的所有 hooks 之前觸發。預設值：False
with_kwargs (bool) – 如果為 true，則 hook 將被傳遞給 forward 函數的 kwargs。預設值：False

回傳值:

一個控制代柄 (handle)，可用於透過呼叫 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¶

在模組上註冊一個反向 hook。

每當計算模組的梯度時，將會呼叫此 hook，也就是說，只有在計算模組輸出的梯度時，才會執行此 hook。該 hook 應具有以下簽名：

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

grad_input 和 grad_output 是包含相對於輸入和輸出的梯度的元組。該 hook 不應修改其參數，但它可以選擇性地傳回相對於輸入的新梯度，該梯度將用於代替後續計算中的 grad_input 。grad_input 將僅對應於作為位置參數給出的輸入，並且所有 kwarg 參數都將被忽略。grad_input 和 grad_output 中的條目對於所有非 Tensor 參數都將為 None。

由於技術原因，當此 hook 應用於模組時，其 forward 函式將接收傳遞給模組的每個 Tensor 的視圖。同樣，呼叫者將接收模組的 forward 函式傳回的每個 Tensor 的視圖。

警告

使用 backward hooks 時，不允許就地修改輸入或輸出，並且會引發錯誤。

參數:

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

回傳值:

一個控制代柄 (handle)，可用於透過呼叫 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(module, grad_output) -> tuple[Tensor] or None

grad_output 是一個元組。該 hook 不應修改其參數，但它可以選擇性地傳回相對於輸出的新梯度，該梯度將用於代替後續計算中的 grad_output 。grad_output 中的條目對於所有非 Tensor 參數都將為 None。

由於技術原因，當此 hook 應用於模組時，其 forward 函式將接收傳遞給模組的每個 Tensor 的視圖。同樣，呼叫者將接收模組的 forward 函式傳回的每個 Tensor 的視圖。

警告

使用 backward hooks 時，不允許就地修改輸入，並且會引發錯誤。

參數:

hook (Callable) – 要註冊的使用者定義 hook。
prepend (bool) – 如果為 true，提供的 hook 將會在所有現有的 backward_pre hook 之前被觸發，這些 hook 位於這個 torch.nn.modules.Module 上。否則，提供的 hook 將會在所有現有的 backward_pre hook 之後被觸發，這些 hook 位於這個 torch.nn.modules.Module 上。請注意，使用 register_module_full_backward_pre_hook() 註冊的全域 backward_pre hook 將會在透過此方法註冊的所有 hook 之前觸發。

回傳值:

一個控制代柄 (handle)，可用於透過呼叫 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) 中註冊一個環境。

這個方法在設計時考慮了以下範圍：

將 TorchRL-first 環境整合到使用 Gym 的框架中；

將另一個環境（例如，DeepMind Control、Brax、Jumanji 等）整合到使用 Gym 的框架中。

參數:

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

關鍵字引數:

entry_point (callable, optional) –

構建環境的進入點。如果沒有傳遞任何內容，則父類別將用作進入點。通常，這用於註冊不一定繼承自正在使用的基礎的環境

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

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

警告

使用 info_keys 可能會導致 spec 為空，因為內容已移動到 info 字典。 Gym 不喜歡 spec 中有空的 Dict，因此應使用 RemoveEmptySpecs 刪除此空內容。
backend (str, optional) – 後端。可以是 “gym” 或 “gymnasium” 或任何其他與 set_gym_backend 相容的後端。
to_numpy (bool, optional) – 如果 True，對 step 和 reset 的呼叫結果將會對應到 numpy 陣列。預設為 False（結果為 tensors）。這個參數可以在呼叫 make() 時傳遞（見下面的例子）。
reward_threshold (float, optional) – [Gym kwarg] 認為已經學會環境的獎勵閾值。
nondeterministic (bool, optional) – [Gym kwarg] 如果環境是不確定的（即使知道初始 seed 和所有動作）。預設為 False。
max_episode_steps (int, optional) – [Gym kwarg] episode 在被截斷前的最大步數。由 Time Limit wrapper 使用。
order_enforce (bool, optional) – [Gym >= 0.14] 是否應使用順序強制執行 (order enforcer) wrapper 以確保使用者以正確的順序執行函式。預設為 True。
autoreset (bool, optional) – [Gym >= 0.14] 是否應加入 autoreset wrapper，如此一來便不需要呼叫 reset。預設為 False。
disable_env_checker – [Gym >= 0.14] 是否應停用環境檢查器 (environment checker)。預設為 False。
apply_api_compatibility – [Gym >= 0.26] 是否要套用 StepAPICompatibility wrapper。預設為 False。
**kwargs – 傳遞給環境建構子的任意關鍵字參數。

注意

TorchRL 的環境沒有 "info" 字典的概念，因為 TensorDict 提供了在大多數訓練設置中認為必要的所有儲存需求。儘管如此，您仍然可以使用 info_keys 引數來對什麼應該被視為觀察結果以及什麼應該被視為資訊進行細粒度的控制。

範例

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

注意

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

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

register_load_state_dict_post_hook(hook)¶

註冊一個 post-hook，以便在模組的 load_state_dict() 被呼叫後執行。

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

The module 引數是註冊此 hook 的當前模組，而 incompatible_keys 引數是一個 NamedTuple，由 missing_keys 和 unexpected_keys 屬性組成。 missing_keys 是一個 list 的 str 包含遺失的鍵，而 unexpected_keys 是一個 list 的 str 包含未預期的鍵。

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

請注意，在呼叫 load_state_dict() 時使用 strict=True 執行的檢查會受到 hook 對 missing_keys 或 unexpected_keys 進行修改的影響，正如預期的那樣。向任一組鍵添加內容將導致在 strict=True 時拋出錯誤，而清除遺失和未預期的鍵都將避免錯誤。

回傳值:: 一個控制代柄 (handle)，可用於透過呼叫 handle.remove() 來移除新增的 hook。
回傳型別:: torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)¶

註冊一個 pre-hook，以便在模組的 load_state_dict() 被呼叫之前執行。

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

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

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

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

將參數新增到模組。

可以使用給定的名稱作為屬性來存取參數。

參數:

name (str) – 參數的名稱。可以使用給定的名稱從此模組存取參數
param (Parameter 或 None) – 要新增到模組的參數。如果 None，則會忽略在參數上執行的操作，例如 cuda。如果 None，則參數不會包含在模組的 state_dict 中。

register_state_dict_post_hook(hook)¶

為 state_dict() 方法註冊一個 post-hook。

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

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

register_state_dict_pre_hook(hook)¶

為 state_dict() 方法註冊一個 pre-hook。

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

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

requires_grad_(requires_grad: bool = True) → T¶

變更 autograd 是否應記錄此模組中參數上的運算。

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

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

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

參數:: requires_grad (bool) – autograd 是否應記錄此模組中參數上的運算。預設值：True。
回傳值:: self
回傳型別:: Module

reset(tensordict: Optional[TensorDictBase] = None, **kwargs) → TensorDictBase¶

重設環境。

至於 step 和 _step，只有私有方法 _reset 應該被 EnvBase 子類別覆寫。

參數:

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

回傳值:

一個 tensordict（或輸入 tensordict，如果有的話），就地修改為包含產生的觀察。

property reset_keys: List[NestedKey]¶

傳回重設鍵的清單。

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

鍵會依照資料樹中的深度排序。

property reward_key¶

環境的獎勵鍵。

預設情況下，這將是 "reward"。

如果環境中有多個獎勵鍵，此函式將引發例外狀況。

property reward_keys: List[NestedKey]¶

環境的獎勵鍵。

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

鍵會依照資料樹中的深度排序。

property reward_spec: TensorSpec¶

reward 的 spec。

reward_spec 始終儲存為複合 spec。

如果獎勵 spec 作為簡單 spec 提供，則將傳回此值。

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

如果獎勵 spec 作為複合 spec 提供，且僅包含一個 leaf，則此函式將僅傳回 leaf。

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

如果獎勵 spec 作為複合 spec 提供，且有多個 leaf，則此函式將傳回整個 spec。

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

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

>>> env.output_spec["full_reward_spec"]

這個屬性是可變的。

範例

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

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

在環境中執行 rollout。

只要其中一個包含的環境返回 done=True，該函數就會停止。

參數:

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

關鍵字引數:

auto_reset (bool, optional) – 如果 True，如果在 rollout 啟動時環境處於 done 狀態，則自動重置環境。預設值為 True。
auto_cast_to_device (bool, optional) – 如果 True，則 tensordict 的裝置會在使用策略之前自動轉換為策略裝置。預設值為 False。
break_when_any_done (bool) – 如果任何一個 done 狀態為 True，則中斷。如果為 False，則會在已完成的子環境上呼叫 reset()。預設值為 True。
break_when_all_done (bool) – 待辦事項
return_contiguous (bool) – 如果為 False，將返回 LazyStackedTensorDict。預設值為 True。
tensordict (TensorDict, optional) – 如果 auto_reset 為 False，則必須提供初始 tensordict。 Rollout 將檢查此 tensordict 是否具有 done 標誌，並在這些維度中重置環境（如果需要）。如果 tensordict 是重置的輸出，則通常不應發生這種情況，但如果 tensordict 是先前 rollout 的最後一步，則可能會發生這種情況。如果需要將元資料傳遞給 reset 方法，例如用於無狀態環境的批次大小或裝置，則也可以在 auto_reset=True 時提供 tensordict。
set_truncated (bool, optional) – 若為 True，在 rollout 完成後，"truncated" 和 "done" 鍵將會被設為 True。如果在 done_spec 中找不到 "truncated"，則會引發例外。Truncated 鍵可以透過 env.add_truncated_keys 設定。預設值為 False。
trust_policy (bool, optional) – 若為 True，則會信任非 TensorDictModule 的 policy 與 collector 相容。對於 CudaGraphModules，預設值為 True，否則為 False。

回傳值:

包含結果軌跡的 TensorDict 物件。

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

rollout 非常方便用來顯示環境的資料結構。

範例

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

使用 policy (一個常規的 Module 或是一個 TensorDictModule)也很容易

範例

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

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

非連續 rollout 的範例

>>> 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 經過呼叫 step_mdp() 之後所得到的最後一個 tensordict 作為輸入。

資料收集 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)[來源]¶

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

參數:

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

回傳值:

也就是說，如果與此環境同時建立另一個環境，則應使用於該環境的種子。

回傳型別:

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

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 有一個巢狀 submodule net_b，它本身有兩個 submodule net_c 和 linear。net_c 然後有一個 submodule conv。）

若要使用新的子模組 Linear 來覆寫 Conv2d，您將呼叫 set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。

參數:

target – 要尋找的子模組的完整字串名稱。（有關如何指定完整字串，請參閱上面的範例。）
module – 要將子模組設定為的模組。

Raises:

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

property shape¶: 等同於 batch_size。

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

property specs: Composite¶

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

此功能允許建立環境，在單一資料容器中檢索所有規格，然後從工作區中刪除環境。

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

回傳一個包含模組完整狀態參考的字典。

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

注意

回傳的物件是淺層複製。它包含對模組參數和緩衝區的參考。

警告

目前，state_dict() 也接受位置引數，依序為 destination、prefix 和 keep_vars。然而，這種用法已被棄用，未來版本將強制使用關鍵字引數。

警告

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

參數:

destination (dict, optional) – 如果提供，模組的狀態將被更新到 dict 中，並回傳相同的物件。否則，將建立並回傳一個 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[NestedKey]¶

環境的狀態鍵。

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

鍵會依照資料樹中的深度排序。

property state_spec: Composite¶

狀態規格。

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

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

因此，"state_spec" 應該被視為環境輸入（非動作資料）的通用資料容器。

範例

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

step(tensordict: TensorDictBase) → TensorDictBase¶

在環境中執行一個步驟。

Step 接受一個單一引數 tensordict，它通常帶有一個 ‘action’ 鍵，指示要採取的動作。 Step 將呼叫一個異地的私有方法 _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)

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)[原始碼]

其簽名與 torch.Tensor.to() 相似，但僅接受浮點數或複數 dtype。此外，此方法只會將浮點數或複數參數和緩衝區轉換為 dtype（如果已給定）。整數參數和緩衝區將會移動到 device（如果已給定），但 dtype 不會改變。當 non_blocking 設定時，如果可能，它會嘗試相對於主機非同步地轉換/移動，例如將具有釘選記憶體的 CPU Tensor 移動到 CUDA 裝置。

請參閱以下範例。

注意

此方法會就地修改模組。

參數:

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

回傳值:

self

回傳型別:

Module

範例

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

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

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

將參數和緩衝區移動到指定的裝置，而不複製儲存空間。

參數:

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

回傳值:

self

回傳型別:

Module

train(mode: bool = True) → T¶

將模組設定為訓練模式。

這僅對某些模組產生影響。請參閱特定模組的文件，以了解它們在訓練/評估模式下的行為詳情（如果它們受到影響），例如 Dropout, BatchNorm 等。

參數:: mode (bool) – 是否設定為訓練模式 (True) 或評估模式 (False)。預設值：True。
回傳值:: self
回傳型別:: Module

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

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

注意

此方法會就地修改模組。

參數:: dst_type (type 或 string) – 目標型別
回傳值:: self
回傳型別:: Module

update_kwargs(kwargs: Union[dict, List[dict]]) → None¶

使用字典或字典列表更新每個環境的 kwargs。

參數:: kwargs (dict 或 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) – 不是設為零，而是將 grads 設為 None。詳情請參閱 torch.optim.Optimizer.zero_grad()。

ParallelEnv¶

文件

教學

資源