EnvBase¶

class torchrl.envs.EnvBase(*args, **kwargs)[來源]¶

抽象環境父類別。

關鍵字引數:

device (torch.device) – 環境的裝置。允許無裝置環境 (device=None)。如果不是 None，所有規格都將投射到該裝置上，並且預期所有輸入和輸出都將位於該裝置上。預設為 None。
batch_size (torch.Size 或 等效值, 選用) – 環境的批次大小。對應於環境讀取和寫入的所有輸入和輸出 tensordict 的前導維度。預設為空的批次大小。
run_type_checks (bool, 選用) – 如果 True，則每次重設和每次步驟都會進行類型檢查。預設為 False。
allow_done_after_reset (bool, 選用) – 如果 True，則在呼叫 reset() 後，環境可以完成。預設為 False。

變數:

done_spec (Composite) – 等同於 full_done_spec，因為所有 done_specs 至少包含一個 "done" 和一個 "terminated" 條目
action_spec (TensorSpec) – action 的規格。如果只需要一個 action 張量，則連結到 leaf action 的規格。否則，連結到 full_action_spec。
observation_spec (Composite) – 等同於 full_observation_spec。
reward_spec (TensorSpec) – reward 的規格。如果只需要一個 reward 張量，則連結到 leaf reward 的規格。否則，連結到 full_reward_spec。
state_spec (Composite) – 等同於 full_state_spec。
full_done_spec (Composite) – 一個複合規格（composite spec），使得 full_done_spec.zero() 回傳一個 tensordict，其中僅包含編碼環境完成狀態的葉節點（leaves）。
full_action_spec (Composite) – 一個複合規格（composite spec），使得 full_action_spec.zero() 回傳一個 tensordict，其中僅包含編碼環境動作（action）的葉節點（leaves）。
full_observation_spec (Composite) – 一個複合規格（composite spec），使得 full_observation_spec.zero() 回傳一個 tensordict，其中僅包含編碼環境觀測（observation）的葉節點（leaves）。
full_reward_spec (Composite) – 一個複合規格（composite spec），使得 full_reward_spec.zero() 回傳一個 tensordict，其中僅包含編碼環境獎勵（reward）的葉節點（leaves）。
full_state_spec (Composite) – 一個複合規格（composite spec），使得 full_state_spec.zero() 回傳一個 tensordict，其中僅包含編碼環境輸入（不包含動作）的葉節點（leaves）。
batch_size (torch.Size) – 環境的批次大小（batch-size）。
device (torch.device) – 環境的輸入/輸出預期所在的裝置（device）。可以是 None。

step(TensorDictBase -> TensorDictBase)[source]¶: 在環境中執行一步（step）。

reset(TensorDictBase, optional -> TensorDictBase)[source]¶: 重置環境（reset the environment）。

set_seed(int -> int)[source]¶: 設定環境的種子（seed）。

rand_step(TensorDictBase, optional -> TensorDictBase)[source]¶: 根據動作規格（action spec）隨機執行一步（random step）。

rollout(Callable, ... -> TensorDictBase)[source]¶: 使用給定的策略（policy）在環境中執行 rollout（如果沒有提供策略，則執行隨機步驟）。

範例

>>> from torchrl.envs import EnvBase
>>> class CounterEnv(EnvBase):
...     def __init__(self, batch_size=(), device=None, **kwargs):
...         self.observation_spec = Composite(
...             count=Unbounded(batch_size, device=device, dtype=torch.int64))
...         self.action_spec = Unbounded(batch_size, device=device, dtype=torch.int8)
...         # done spec and reward spec are set automatically
...     def _step(self, tensordict):
...
>>> from torchrl.envs.libs.gym import GymEnv
>>> env = GymEnv("Pendulum-v1")
>>> env.batch_size  # how many envs are run at once
torch.Size([])
>>> 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([]))
>>> 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)
>>> 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([]))
>>> env.reward_spec
UnboundedContinuous(
    shape=torch.Size([1]),
    space=None,
    device=cpu,
    dtype=torch.float32,
    domain=continuous)
>>> env.done_spec
Categorical(
    shape=torch.Size([1]),
    space=DiscreteBox(n=2),
    device=cpu,
    dtype=torch.bool,
    domain=discrete)
>>> # the output_spec contains all the expected outputs
>>> 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([]))

注意

在此處瞭解更多關於動態規格（dynamic specs）和環境的資訊。

property action_key: NestedKey¶

環境的動作鍵（action key）。

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

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

property action_keys: List[NestedKey]¶

環境的動作鍵（action keys）。

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

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

property action_spec: TensorSpec¶

action 規格。

action_spec 始終儲存為複合規格（composite spec）。

如果動作規格（action spec）作為簡單規格（simple 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）作為複合規格（composite spec）提供，且僅包含一個葉節點（leaf），則此函數將僅回傳該葉節點。

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

如果動作規格（action spec）作為複合規格（composite spec）提供，且有多個葉節點（leaves），則此函數將回傳完整的規格。

>>> 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() → EnvBase[source]¶: 將 truncated 鍵新增到環境。

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

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

參數:: 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”。

如果環境中有多個 done key，此函數將引發異常。

property done_keys: List[NestedKey]¶

環境的 done keys。

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

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

property done_keys_groups¶

done keys 的列表，如同 reset keys 一樣分組。

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

property done_spec: TensorSpec¶

done 的 spec。

done_spec 總是儲存為 composite spec。

如果 done spec 作為一個簡單的 spec 提供，這將被返回。

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

如果 done spec 作為一個 composite spec 提供，並且只包含一個 leaf，這個函數將只返回這個 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)

如果 done spec 作為一個 composite spec 提供，並且有多個 leaf，這個函數將返回整個 spec。

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

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

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

清除所有快取的值。

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

eval() → T¶

將模組設定為評估模式。

這僅對某些模組產生影響。有關它們在訓練/評估模式下的行為的詳細信息，請參閱特定模組的文檔，如果它們受到影響，例如 Dropout、BatchNorm 等。

這等效於 self.train(False)。

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

回傳值:: self
回傳類型:: Module

extra_repr() → str¶

設定模組的額外表示。

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

fake_tensordict() → TensorDictBase[source]¶: 返回一個虛假的 tensordict，其鍵值對在形狀、裝置和 dtype 上與環境 rollout 期間預期的相符。

float() → T¶

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

注意

此方法會就地修改模組。

回傳值:: self
回傳類型:: Module

forward(tensordict: TensorDictBase) → TensorDictBase[source]¶

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

應該被所有子類別覆寫。

注意

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

property full_action_spec: Composite¶

完整的 action spec。

full_action_spec 是一個 Composite` 實例，包含所有 action 條目。

範例

>>> 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，否則拋出錯誤。

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

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

get_extra_state() → Any¶

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

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

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

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

get_parameter(target: str) → Parameter¶

如果存在，則傳回由 target 給定的 parameter，否則拋出錯誤。

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

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

get_submodule(target: str) → Module¶

如果存在，則傳回由 target 給定的 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，它本身有兩個 submodules net_c 和 linear。net_c 然後有一個 submodule conv。)

要檢查我們是否有 linear submodule，我們將呼叫 get_submodule("net_b.linear")。要檢查我們是否有 conv submodule，我們將呼叫 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(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)¶

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

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

警告

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

參數:

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

回傳值:

missing_keys 是一個字串列表，包含此模組預期的，但在提供的 state_dict 中遺失的任何鍵。
by this module but missing from the provided state_dict.
unexpected_keys 是一個字串列表，包含此模組未預期，但在提供的 state_dict 中存在的鍵。
expected by this module but present in the provided 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) – 包含名稱和緩衝區的元組

範例

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

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

傳回立即子模組的迭代器，同時產生模組的名稱和模組本身。

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

範例

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

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

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

參數:

memo – 用於儲存已添加到結果中的模組集合的備忘錄
prefix – 將添加到模組名稱的前綴
remove_duplicate – 是否移除結果中重複的模組實例

產生:

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

注意

重複的模組只會傳回一次。在以下範例中，l 只會傳回一次。

範例

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

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

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

返回一個迭代器，遍歷模組參數，產生參數名稱以及參數本身。

參數:

prefix (str) – 要附加到所有參數名稱的前綴。
recurse (bool) – 如果為 True，則產生此模組和所有子模組的參數。否則，僅產生作為此模組直接成員的參數。
remove_duplicate (bool, optional) – 是否移除結果中重複的參數。預設為 True。

產生:

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

範例

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

property observation_spec: Composite¶

Observation spec (觀測規格)。

必須是 torchrl.data.Composite 實例。重置和 step 後可以直接訪問 spec 中列出的鍵。

在 TorchRL 中，即使它們嚴格來說不是「觀測 (observations)」，環境的所有資訊、狀態、轉換結果等輸出都儲存在 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 (輸出規格)。

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

它包含：

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

返回一個遍歷模組參數的迭代器。

這通常會傳遞給優化器。

參數:: 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¶

在模組上註冊一個 backward 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 產生影響。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 hook 之前觸發。否則，提供的 hook 將在這個 torch.nn.modules.Module 上的所有現有 forward_pre hook 之後觸發。請注意，使用 register_module_forward_pre_hook() 註冊的全域 forward_pre hook 將在所有由此方法註冊的 hook 之前觸發。預設值：False
with_kwargs (bool) – 如果為 true，hook 將被傳遞給 forward 函數的 kwargs。預設值：False

回傳值:

一個 handle，可用於透過呼叫 handle.remove() 來移除新增的 hook

回傳類型:

torch.utils.hooks.RemovableHandle

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

在模組上註冊一個 backward hook。

每次計算相對於模組的梯度時，都會呼叫此 hook，也就是說，當且僅當計算相對於模組輸出的梯度時，hook 才會執行。此 hook 應具有以下簽名：

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

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

由於技術原因，當此 hook 應用於 Module 時，其 forward 函式將接收傳遞給 Module 的每個 Tensor 的檢視。同樣，呼叫者將接收 Module 的 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。對於所有非 Tensor 引數，grad_output 中的條目將為 None。

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

警告

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

參數:

hook (Callable) – 要註冊的使用者定義 hook。
prepend (bool) – 如果為 true，提供的 hook 將會在所有現有的 backward_pre hook 於此 torch.nn.modules.Module 上觸發之前觸發。否則，提供的 hook 將會在所有現有的 backward_pre 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)[source]¶

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

此方法的設計考慮了以下範圍：

將 TorchRL 優先的環境整合到使用 Gym 的框架中；

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

參數:

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

關鍵字引數:

entry_point (callable, optional) –

構建環境的進入點。如果未傳遞任何值，則父類別將用作進入點。通常，這用於註冊不一定繼承自所用基底的環境

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

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

警告

可能發生的情況是，使用 info_keys 會使規格為空，因為內容已移至資訊字典。 Gym 不喜歡規格中的空 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] 環境是否為非確定性的（即使知道初始種子和所有動作）。預設為 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] 是否應為環境停用環境檢查器。預設為 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

module 引數是註冊此 hook 的當前模組，而 incompatible_keys 引數是一個 NamedTuple，由屬性 missing_keys 和 unexpected_keys 組成。missing_keys 是一個 list 的 str，其中包含缺少的鍵，而 unexpected_keys 是一個 list 的 str，其中包含意外的鍵。

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

請注意，在使用 strict=True 呼叫 load_state_dict() 時執行的檢查會受到 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，將在載入 state dict 之前被呼叫。

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

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

將參數新增至模組。

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

參數:

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

register_state_dict_post_hook(hook)¶

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

它應該具有以下簽章：: 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: Optional[TensorDictBase] = None, **kwargs) → TensorDictBase[原始碼]¶

重設環境。

如同 step 和 _step，只有私有方法 _reset 應由 EnvBase 子類別覆寫。

參數:

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

回傳值:

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 規格。

reward_spec 總是儲存為複合規格。

如果獎勵規格是以簡單規格提供的，則會傳回此規格。

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

如果獎勵規格是以複合規格提供的，且只包含一個葉節點，此函式將只會傳回該葉節點。

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

如果獎勵規格是以複合規格提供的，且有多個葉節點，此函式將會傳回整個規格。

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

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

>>> env.output_spec["full_reward_spec"]

此屬性是可變的。

範例

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

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)[source]¶

在環境中執行 rollout。

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

參數:

max_steps (int) – 要執行的最大步數。如果環境在執行 max_steps 之前達到 done 狀態，則實際步數可能較小。
policy (callable, optional) – 用於計算所需動作的可呼叫物件。如果未提供 policy，則將使用 env.rand_step() 呼叫動作。policy 可以是任何可讀取 tensordict 或觀察條目（observation entries）的整個序列的可呼叫物件，__按照 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 的裝置（device）將在 policy 使用前自動轉換為 policy 的裝置（device）。預設值為 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 方法，例如無狀態環境的 batch-size 或裝置（device），則也可以在 auto_reset=True 時提供 tensordict。
set_truncated (bool, optional) – 如果 True，則在 rollout 完成後，"truncated" 和 "done" 鍵將設定為 True。如果在 done_spec 中找不到 "truncated"，則會引發異常。可以通過 env.add_truncated_keys 設置截斷鍵（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']

使用策略（一個常規的 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 可以在迴圈中使用，以模擬資料收集。為此，您需要在呼叫 step_mdp() 之後，將來自先前 rollout 的最後一個 tensordict 作為輸入傳遞。

資料收集 rollout 的範例

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

set_extra_state(state: Any) → None¶

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

此函式從 load_state_dict() 呼叫，以處理在 state_dict 中找到的任何額外狀態。如果您需要在模組的 state_dict 中儲存額外狀態，請實作此函式和對應的 get_extra_state()。

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

set_seed(seed: Optional[int] = None, static_seed: bool = False) → Optional[int][原始碼]¶

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

參數:

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，它本身有兩個 submodules 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, destination=None, prefix='', keep_vars=False)¶

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

包括參數和持久緩衝區（例如，運行平均值）。鍵是相應的參數和緩衝區名稱。設定為 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¶

狀態規格 (State spec)。

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

在 TorchRL 中，即使它們不完全算是“狀態”，所有環境的輸入（除了 actions）都會儲存在 state_spec 中。

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

範例

>>> 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 將呼叫一個異地 (out-place) 私有方法 _step，該方法將由 EnvBase 子類別重新編寫。

參數:: tensordict (TensorDictBase) – 包含要採取的 action 的 Tensordict。如果輸入的 tensordict 包含一個 "next" 條目，則其中包含的值將優先於新計算的值。這提供了一種覆寫底層計算的機制。
回傳值:: 輸入的 tensordict，就地修改為產生的觀測值、done 狀態和 reward (+ 如果需要，還有其他)。

step_and_maybe_reset(tensordict: TensorDictBase) → Tuple[TensorDictBase, TensorDictBase][原始碼]¶

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

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

此方法可以輕鬆編寫非停止的 rollout 函數。

範例

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

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

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

可以這樣呼叫

to(device=None, dtype=None, non_blocking=False)[原始碼]

to(dtype, non_blocking=False)[原始碼]

to(tensor, non_blocking=False)[原始碼]

to(memory_format=torch.channels_last)[原始碼]

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

請參閱以下範例。

注意

此方法會就地修改模組。

參數:

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

回傳值:

self

回傳類型:

Module

範例

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

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

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

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

參數:

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

回傳值:

self

回傳類型:

Module

train(mode: bool = True) → T¶

將模組設定為訓練模式。

這僅對某些模組產生影響。有關它們在訓練/評估模式下的行為的詳細信息，請參閱特定模組的文檔，如果它們受到影響，例如 Dropout、BatchNorm 等。

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

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

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

注意

此方法會就地修改模組。

參數:: dst_type (type or string) – 想要的類型
回傳值:: self
回傳類型:: Module

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

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

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

注意

此方法會就地修改模組。

參數:: device (int, 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() 以取得詳細資訊。

EnvBase¶

文件

教學

資源