EnvBase¶
- class torchrl.envs.EnvBase(*args, **kwargs)[source]¶
抽象環境父類。
- 關鍵字引數:
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()後立即完成 (done)。預設為False。spec_locked (bool, 可選的) –
如果
True，則規範被鎖定，只有在呼叫set_spec_lock_()後才能修改。注意
鎖定是透過 EnvBase 元類實現的。它沒有出現在 __init__ 方法中，而是嚴格出於型別提示目的包含在關鍵字引數中。
另請參閱
預設為
True。auto_reset (bool, 可選的) –
如果
True，則假定環境在完成後會自動重置。預設為False。注意
自動重置是透過 EnvBase 元類實現的。它沒有出現在 __init__ 方法中，而是嚴格出於型別提示目的包含在關鍵字引數中。
另請參閱
API 文件中關於自動重置環境 API 的部分。
- 變數:
done_spec (Composite) – 等同於
full_done_spec，因為所有done_specs都至少包含 `"done"` 和 `"terminated"` 條目action_spec (TensorSpec) – 動作的規範。如果預期只有一個動作張量，則連結到葉子動作的規範。否則連結到
full_action_spec。observation_spec (Composite) – 等同於
full_observation_spec。reward_spec (TensorSpec) – 獎勵的規範。如果預期只有一個獎勵張量，則連結到葉子獎勵的規範。否則連結到
full_reward_spec。state_spec (Composite) – 等同於
full_state_spec。full_done_spec (Composite) – 一個複合規範，使得
full_done_spec.zero()返回一個 tensordict，僅包含編碼環境完成狀態的葉子。full_action_spec (Composite) – 一個複合規範，使得
full_action_spec.zero()返回一個 tensordict，僅包含編碼環境動作的葉子。full_observation_spec (Composite) – 一個複合規範，使得
full_observation_spec.zero()返回一個 tensordict，僅包含編碼環境觀測的葉子。full_reward_spec (Composite) – 一個複合規範，使得
full_reward_spec.zero()返回一個 tensordict，僅包含編碼環境獎勵的葉子。full_state_spec (Composite) – 一個複合規範，使得
full_state_spec.zero()返回一個 tensordict，僅包含編碼環境輸入（不包括動作）的葉子。batch_size (torch.Size) – 環境的批次大小。
device (torch.device) – 環境輸入/輸出預期所在的裝置。可以是
None。is_spec_locked (bool) – 如果規範被鎖定，則返回
True。參見上文的spec_locked引數。
示例
>>> 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-envs。
- property action_key: NestedKey¶
環境的動作鍵。
預設情況下，這將是“action”。
如果環境中有一個以上的動作鍵，此函式將丟擲異常。
- property action_keys: list[tensordict._nestedkey.NestedKey]¶
環境的動作鍵。
預設情況下，只會有一個名為“action”的鍵。
鍵按資料樹中的深度排序。
- property action_spec: TensorSpec¶
`action` 規範。
`action_spec` 始終作為複合規範儲存。
如果動作規範作為簡單規範提供，將返回此簡單規範。
>>> env.action_spec = Unbounded(1) >>> env.action_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果動作規範作為複合規範提供且僅包含一個葉子，此函式將只返回該葉子。
>>> env.action_spec = Composite({"nested": {"action": Unbounded(1)}}) >>> env.action_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果動作規範作為複合規範提供且有多個葉子，此函式將返回整個規範。
>>> env.action_spec = Composite({"nested": {"action": Unbounded(1), "another_action": Categorical(1)}}) >>> env.action_spec Composite( nested: Composite( action: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), another_action: Categorical( shape=torch.Size([]), space=DiscreteBox(n=1), device=cpu, dtype=torch.int64, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
要檢索傳遞的完整規範，請使用
>>> env.input_spec["full_action_spec"]
此屬性是可變的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.action_spec BoundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
- property action_spec_unbatched: TensorSpec¶
返回環境的動作規範，就像它沒有批維度一樣。
- add_module(name: str, module: Optional[Module]) None¶
向當前模組新增一個子模組。
可以使用給定的名稱作為屬性訪問該模組。
- 引數:
name (str) – 子模組的名稱。可以使用給定的名稱從該模組訪問子模組
module (Module) – 要新增到模組的子模組。
- all_actions(tensordict: TensorDictBase | None = None) TensorDictBase[source]¶
根據動作規範生成所有可能的動作。
這僅適用於具有完全離散動作的環境。
- 引數:
tensordict (TensorDictBase, 可選的) – 如果給定，則會使用此 tensordict 呼叫
reset()。- 返回值:
一個 tensordict 物件，其中“action”條目已更新為一批所有可能的動作。動作在首個維度中堆疊在一起。
- append_transform(transform: Transform | Callable[[TensorDictBase], TensorDictBase]) EnvBase[source]¶
返回一個變換後的環境，其中應用的傳遞的 callable/變換。
- 引數:
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) – 要應用於每個子模組的函式- 返回值:
自身
- 返回型別:
Module
示例
>>> @torch.no_grad() >>> def init_weights(m): >>> print(m) >>> if type(m) == nn.Linear: >>> m.weight.fill_(1.0) >>> print(m.weight) >>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2)) >>> net.apply(init_weights) Linear(in_features=2, out_features=2, bias=True) Parameter containing: tensor([[1., 1.], [1., 1.]], requires_grad=True) Linear(in_features=2, out_features=2, bias=True) Parameter containing: tensor([[1., 1.], [1., 1.]], requires_grad=True) Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) )
- auto_specs_(policy: Callable[[TensorDictBase], TensorDictBase], *, tensordict: TensorDictBase | None = None, action_key: NestedKey | list[NestedKey] = 'action', done_key: NestedKey | list[NestedKey] | None = None, observation_key: NestedKey | list[NestedKey] = 'observation', reward_key: NestedKey | list[NestedKey] = 'reward')[source]¶
根據使用給定策略的隨機軌跡收集，自動設定環境的規範 (specs)。
此方法使用提供的策略執行軌跡收集，以推斷環境的輸入和輸出規範。它根據在軌跡收集期間收集的資料，更新環境的動作、觀測、獎勵和完成訊號的規範。
- 引數:
policy (Callable[[TensorDictBase], TensorDictBase]) – 一個可呼叫的策略，它將 TensorDictBase 作為輸入，並返回 TensorDictBase 作為輸出。此策略用於執行軌跡收集並確定規範。
- 關鍵字引數:
tensordict (TensorDictBase, 可選的) – 一個可選的 TensorDictBase 例項，用作軌跡收集的初始狀態。如果未提供，將呼叫環境的 reset 方法獲取初始狀態。
action_key (NestedKey 或 List[NestedKey], 可選的) – 用於在 TensorDictBase 中標識動作的鍵。預設為“action”。
done_key (NestedKey 或 List[NestedKey], 可選的) – 用於在 TensorDictBase 中標識完成訊號的鍵。預設為
None，這將嘗試使用 [“done”, “terminated”, “truncated”] 作為潛在鍵。observation_key (NestedKey 或 List[NestedKey], 可選的) – 用於在 TensorDictBase 中標識觀測的鍵。預設為“observation”。
reward_key (NestedKey 或 List[NestedKey], 可選的) – 用於在 TensorDictBase 中標識獎勵的鍵。預設為“reward”。
- 返回值:
規範已更新的環境例項。
- 返回型別:
- 丟擲:
RuntimeError – 如果輸出規範中有鍵未在提供的鍵中考慮到。
- property batch_dims: int¶
環境的批維度數量。
- property batch_locked: bool¶
環境是否可以使用與初始化時不同的批次大小。
如果為 True，則需要與一個具有與環境相同批次大小的 tensordict 一起使用。batch_locked 是一個不可變屬性。
- property batch_size: Size¶
此環境例項中批次處理的環境數量，組織在一個 torch.Size() 物件中。
環境可能相似也可能不同，但假定它們之間幾乎沒有或完全沒有互動（例如，多工或並行批次執行）。
- bfloat16() T¶
將所有浮點引數和緩衝區轉換為
bfloat16資料型別。注意
此方法會原地修改模組。
- 返回值:
自身
- 返回型別:
Module
- buffers(recurse: bool = True) Iterator[Tensor]¶
返回模組緩衝區的迭代器。
- 引數:
recurse (bool) – 如果為 True，則生成此模組及所有子模組的緩衝區。否則，僅生成此模組的直接成員緩衝區。
- 生成值:
torch.Tensor – 模組緩衝區
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for buf in model.buffers(): >>> print(type(buf), buf.size()) <class 'torch.Tensor'> (20L,) <class 'torch.Tensor'> (20L, 1L, 5L, 5L)
- cardinality(tensordict: TensorDictBase | None = None) int[source]¶
動作空間的基數。
預設情況下，這只是
env.action_space.cardinality的包裝器。當動作規範可變時，此方法很有用
動作數量可以是未定義的，例如，
Categorical(n=-1)；動作基數可能取決於動作掩碼；
形狀可以是動態的，如在
Unbound(shape=(-1))中。
在這些情況下，應該覆蓋
cardinality()方法，- 引數:
tensordict (TensorDictBase, 可選的) – 包含計算基數所需資料的 tensordict。
- check_env_specs(return_contiguous: bool | None = None, check_dtype=True, seed: int | None = None, tensordict: TensorDictBase | None = None)¶
根據短期軌跡收集的結果測試環境規範。
此測試函式應作為對包裝有 torchrl 的 EnvBase 子類的環境進行健全性檢查：預期資料與收集到的資料之間的任何差異都應丟擲斷言錯誤。
損壞的環境規範可能導致無法使用並行環境。
- 引數:
env (EnvBase) – 需要對照資料檢查規範的環境。
return_contiguous (bool, 可選的) – 如果
True，則會呼叫隨機軌跡收集，並設定 return_contiguous=True。這在某些情況下會失敗（例如，輸入/輸出的形狀異構）。預設為None（由動態規範的存在決定）。check_dtype (bool, 可選的) – 如果為 False，則跳過 dtype 檢查。預設為 True。
seed (int, optional) – 為了可復現性，可以設定一個種子。此種子將臨時設定在 PyTorch 中，然後將隨機數生成器（RNG）狀態恢復到之前的狀態。對於環境，我們設定了種子，但由於大多數環境不具備恢復 RNG 狀態的功能，因此這部分由使用者自行完成。預設為
None。tensordict (TensorDict, optional) – 用於重置的可選 TensorDict 例項。
注意：此函式會重置環境種子。它應該在“離線”模式下使用，以檢查環境是否妥善構建，但它可能會影響實驗的種子設定，因此不應放在訓練指令碼中。
- compile(*args, **kwargs)¶
使用
torch.compile()編譯此模組的 forward 方法。此模組的 __call__ 方法被編譯，所有引數按原樣傳遞給
torch.compile()。有關此函式引數的詳情，請參見
torch.compile()。
- cpu() T¶
將所有模型引數和緩衝區移至 CPU。
注意
此方法會原地修改模組。
- 返回值:
自身
- 返回型別:
Module
- cuda(device: Optional[Union[int, device]] = None) T¶
將所有模型引數和緩衝區移至 GPU。
這也會使相關的引數和緩衝區成為不同的物件。因此，如果模組在最佳化時位於 GPU 上，應在構建最佳化器之前呼叫此方法。
注意
此方法會原地修改模組。
- 引數:
device (int, optional) – 如果指定，所有引數將被複制到該裝置
- 返回值:
自身
- 返回型別:
Module
- property done_key¶
環境的完成鍵。
預設情況下，這將是 “done”。
如果環境中有多個完成鍵，此函式將引發異常。
- property done_keys: list[tensordict._nestedkey.NestedKey]¶
環境的完成鍵列表。
預設情況下，只有一個名為 “done” 的鍵。
鍵按資料樹中的深度排序。
- property done_keys_groups¶
完成鍵的列表，按重置鍵分組。
這是一個列表的列表。外層列表的長度與重置鍵的數量一致，內層列表包含完成鍵（例如 done 和 truncated），當重置鍵不存在時，可以透過這些鍵來確定是否需要重置。
- property done_spec: TensorSpec¶
done規範。done_spec始終儲存為複合規範。如果完成規範以簡單規範形式提供，則返回該規範。
>>> env.done_spec = Categorical(2, dtype=torch.bool) >>> env.done_spec Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
如果完成規範以複合規範形式提供並僅包含一個葉子節點，則此函式將僅返回該葉子節點。
>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool)}}) >>> env.done_spec Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
如果完成規範以複合規範形式提供幷包含多個葉子節點，則此函式將返回整個規範。
>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool), "another_done": Categorical(2, dtype=torch.bool)}}) >>> env.done_spec Composite( nested: Composite( done: Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), another_done: Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
若要始終檢索傳遞的完整規範，請使用
>>> env.output_spec["full_done_spec"]
此屬性是可變的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.done_spec Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
- property done_spec_unbatched: TensorSpec¶
返回環境的完成規範，如同它沒有批次維度一樣。
- double() T¶
將所有浮點引數和緩衝區轉換為
double資料型別。注意
此方法會原地修改模組。
- 返回值:
自身
- 返回型別:
Module
- eval() T¶
將模組設定為評估模式。
這僅對某些模組有效。有關特定模組在訓練/評估模式下行為的詳情（即它們是否受影響），請參閱其文件，例如
Dropout、BatchNorm等。這等同於
self.train(False)。有關 .eval() 與可能與之混淆的幾種類似機制的比較，請參見 本地停用梯度計算。
- 返回值:
自身
- 返回型別:
Module
- extra_repr() str¶
返回模組的額外表示。
要列印自定義的額外資訊，應在您自己的模組中重新實現此方法。單行和多行字串均可接受。
- float() T¶
將所有浮點引數和緩衝區轉換為
float資料型別。注意
此方法會原地修改模組。
- 返回值:
自身
- 返回型別:
Module
- forward(*args, **kwargs)[原始碼]¶
定義每次呼叫時執行的計算。
應被所有子類重寫。
注意
儘管 forward pass 的實現需要在函式內定義，但之後應呼叫 Module 例項而不是直接呼叫此函式，因為前者會負責執行已註冊的 hook，而後者會靜默忽略它們。
- property full_action_spec: Composite¶
完整動作規範。
full_action_spec是一個Composite`例項，包含所有動作條目。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.full_action_spec Composite( action: BoundedContinuous( shape=torch.Size([8]), space=ContinuousBox( low=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([]))
- property full_done_spec: Composite¶
完整完成規範。
full_done_spec是一個Composite`例項，包含所有完成條目。可用於生成偽造資料，其結構模擬了執行時獲得的資料結構。示例
>>> import gymnasium >>> from torchrl.envs import GymWrapper >>> env = GymWrapper(gymnasium.make("Pendulum-v1")) >>> env.full_done_spec Composite( done: Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), truncated: Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([]))
- property full_reward_spec: Composite¶
完整獎勵規範。
full_reward_spec是一個Composite`例項，包含所有獎勵條目。示例
>>> import gymnasium >>> from torchrl.envs import GymWrapper, TransformedEnv, RenameTransform >>> base_env = GymWrapper(gymnasium.make("Pendulum-v1")) >>> env = TransformedEnv(base_env, RenameTransform("reward", ("nested", "reward"))) >>> env.full_reward_spec Composite( nested: Composite( reward: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=None, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- property full_state_spec: Composite¶
完整狀態規範。
full_state_spec是一個Composite`例項，包含所有狀態條目（即非動作的輸入資料）。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.full_state_spec Composite( state: Composite( pipeline_state: Composite( q: UnboundedContinuous( shape=torch.Size([15]), space=None, device=cpu, dtype=torch.float32, domain=continuous), [...], device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- get_buffer(target: str) Tensor¶
如果存在由
target指定的緩衝區，則返回它，否則丟擲錯誤。有關此方法功能的更詳細解釋以及如何正確指定
target，請參閱get_submodule的文件字串。- 引數:
target – 要查詢的緩衝區的完全限定字串名稱。（有關如何指定完全限定字串，請參見
get_submodule。）- 返回值:
target 引用的緩衝區
- 返回型別:
- 丟擲:
AttributeError – 如果 target 字串引用了無效路徑或解析到的不是緩衝區
- get_extra_state() Any¶
返回要包含在模組 state_dict 中的任何額外狀態。
如果需要儲存額外狀態，請實現此方法以及相應的
set_extra_state()。構建模組的 state_dict() 時會呼叫此函式。請注意，額外狀態應是可 pickle 的，以確保 state_dict 的序列化正常工作。我們僅為 Tensor 的序列化提供向後相容性保證；其他物件如果其序列化 pickle 形式發生變化，可能會破壞向後相容性。
- 返回值:
要儲存在模組 state_dict 中的任何額外狀態
- 返回型別:
object
- get_parameter(target: str) Parameter¶
如果存在由
target指定的引數，則返回它，否則丟擲錯誤。有關此方法功能的更詳細解釋以及如何正確指定
target，請參閱get_submodule的文件字串。- 引數:
target – 要查詢的 Parameter 的完全限定字串名稱。（有關如何指定完全限定字串，請參見
get_submodule。）- 返回值:
target 引用的 Parameter
- 返回型別:
torch.nn.Parameter
- 丟擲:
AttributeError – 如果 target 字串引用了無效路徑或解析到的不是
nn.Parameter
- get_submodule(target: str) Module¶
如果存在由
target指定的子模組，則返回它，否則丟擲錯誤。例如，假設您有一個
nn.ModuleA，其結構如下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.ModuleA。A包含巢狀子模組net_b，net_b本身包含兩個子模組net_c和linear。net_c接著包含子模組conv。)要檢查是否存在
linear子模組，我們會呼叫get_submodule("net_b.linear")。要檢查是否存在conv子模組，我們會呼叫get_submodule("net_b.net_c.conv")。get_submodule的執行時開銷受target中模組巢狀深度的限制。對named_modules的查詢可以達到相同的結果，但其複雜度相對於傳遞子模組的數量是 O(N)。因此，對於簡單的檢查某個子模組是否存在的情況，應始終使用get_submodule。- 引數:
target – 要查詢的子模組的完全限定字串名稱。（有關如何指定完全限定字串，請參見上面的示例。）
- 返回值:
target 引用的子模組
- 返回型別:
- 丟擲:
AttributeError – 如果 target 字串引用了無效路徑或解析到的不是
nn.Module
- half() T¶
將所有浮點引數和緩衝區轉換為
half資料型別。注意
此方法會原地修改模組。
- 返回值:
自身
- 返回型別:
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) – 如果指定，所有引數將被複制到該裝置
- 返回值:
自身
- 返回型別:
Module
- property is_spec_locked¶
獲取環境規範是否被鎖定。
此屬性可以直接修改。
- 返回值:
如果規範已鎖定則為 True，否則為 False。
- 返回型別:
bool
另請參閱
- load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)¶
將
state_dict中的引數和緩衝區複製到此模組及其後代。如果
strict為True，則state_dict中的鍵必須與此模組state_dict()函式返回的鍵完全匹配。警告
如果
assign為True，則最佳化器必須在呼叫load_state_dict之後建立，除非get_swap_module_params_on_conversion()為True。- 引數:
state_dict (dict) – 包含引數和持久緩衝區的字典。
strict (bool, optional) – 是否嚴格強制
state_dict中的鍵與此模組state_dict()函式返回的鍵匹配。預設值：Trueassign (bool, optional) – 當設定為
False時，保留當前模組中張量的屬性，而設定為True時，保留 state dict 中張量的屬性。唯一的例外是Parameters的requires_grad欄位。預設值: ``False`
- 返回值:
- missing_keys 是一個字串列表，包含此模組期望但提供的
state_dict中缺失的所有鍵。
- missing_keys 是一個字串列表，包含此模組期望但提供的
- unexpected_keys 是一個字串列表，包含此模組不期望但提供的
state_dict中存在的鍵。
- unexpected_keys 是一個字串列表，包含此模組不期望但提供的
- 返回型別:
NamedTuple，包含missing_keys和unexpected_keys欄位
注意
如果引數或緩衝區註冊為
None且其對應的鍵存在於state_dict中，load_state_dict()將引發RuntimeError。
- maybe_reset(tensordict: TensorDictBase) TensorDictBase[原始碼]¶
檢查輸入 tensordict 的完成鍵，並在需要時重置已完成的環境。
- 引數:
tensordict (TensorDictBase) – 一個來自
step_mdp()輸出的 tensordict。- 返回值:
一個 tensordict，在環境未重置的地方與輸入相同，在環境已重置的地方包含新的重置資料。
- modules() Iterator[Module]¶
返回一個遍歷網路中所有模組的迭代器。
- 生成值:
Module – 網路中的一個模組
注意
重複模組僅返回一次。在以下示例中，
l只返回一次。示例
>>> l = nn.Linear(2, 2) >>> net = nn.Sequential(l, l) >>> for idx, m in enumerate(net.modules()): ... print(idx, '->', m) 0 -> Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) ) 1 -> Linear(in_features=2, out_features=2, bias=True)
- mtia(device: Optional[Union[int, device]] = None) T¶
將所有模型引數和緩衝區移至 MTIA。
這也會使相關的引數和緩衝區成為不同的物件。因此，如果模組在最佳化時位於 MTIA 上，應在構建最佳化器之前呼叫此方法。
注意
此方法會原地修改模組。
- 引數:
device (int, optional) – 如果指定，所有引數將被複制到該裝置
- 返回值:
自身
- 返回型別:
Module
- named_buffers(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) Iterator[Tuple[str, Tensor]]¶
返回一個模組緩衝區上的迭代器，每次產出緩衝區的名稱及其自身。
- 引數:
prefix (str) – 要新增到所有緩衝區名稱前的字串。
recurse (bool, optional) – 如果為 True，則產出當前模組及其所有子模組的緩衝區。否則，只產出當前模組的直接成員緩衝區。預設為 True。
remove_duplicate (bool, optional) – 是否移除結果中的重複緩衝區。預設為 True。
- 生成值:
(str, torch.Tensor) – 包含名稱和緩衝區的元組。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for name, buf in self.named_buffers(): >>> if name in ['running_var']: >>> print(buf.size())
- named_children() Iterator[Tuple[str, Module]]¶
返回一個直接子模組上的迭代器，每次產出模組的名稱及其自身。
- 生成值:
(str, Module) – 包含名稱和子模組的元組。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for name, module in model.named_children(): >>> if name in ['conv4', 'conv5']: >>> print(module)
- named_modules(memo: Optional[Set[Module]] = None, prefix: str = '', remove_duplicate: bool = True)¶
返回網路中所有模組上的迭代器，每次產出模組的名稱及其自身。
- 引數:
memo – 一個備忘錄，用於儲存已新增到結果中的模組集合。
prefix – 將新增到模組名稱前的字串。
remove_duplicate – 是否移除結果中的重複模組例項。
- 生成值:
(str, Module) – 包含名稱和模組的元組。
注意
重複模組僅返回一次。在以下示例中，
l只返回一次。示例
>>> l = nn.Linear(2, 2) >>> net = nn.Sequential(l, l) >>> for idx, m in enumerate(net.named_modules()): ... print(idx, '->', m) 0 -> ('', Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) )) 1 -> ('0', Linear(in_features=2, out_features=2, bias=True))
- named_parameters(prefix: str = '', recurse: bool = True, remove_duplicate: bool = True) Iterator[Tuple[str, Parameter]]¶
返回一個模組引數上的迭代器，每次產出引數的名稱及其自身。
- 引數:
prefix (str) – 要新增到所有引數名稱前的字串。
recurse (bool) – 如果為 True，則產出當前模組及其所有子模組的引數。否則，只產出當前模組的直接成員引數。
remove_duplicate (bool, optional) – 是否移除結果中的重複引數。預設為 True。
- 生成值:
(str, Parameter) – 包含名稱和引數的元組。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> for name, param in self.named_parameters(): >>> if name in ['bias']: >>> print(param.size())
- property observation_keys: list[tensordict._nestedkey.NestedKey]¶
環境的觀測鍵。
預設情況下，只有一個名為“observation”的鍵。
鍵按資料樹中的深度排序。
- property observation_spec: Composite¶
觀測規範。
必須是
torchrl.data.Composite例項。規範中列出的鍵在 reset 和 step 後可直接訪問。在 TorchRL 中，即使它們嚴格來說不是“觀測”，環境輸出的所有 info、state、transform 結果等都儲存在
observation_spec中。因此，
"observation_spec"應被視為環境輸出的通用資料容器，不包括 done 或 reward 資料。示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.observation_spec Composite( observation: BoundedContinuous( shape=torch.Size([3]), space=ContinuousBox( low=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([]))
- property output_spec: TensorSpec¶
輸出規範。
包含環境輸出的所有資料規範的組合規範。
它包含
“full_reward_spec”: 獎勵的規範
“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: TensorDictBase | None = None)[source]¶
根據 action_spec 屬性執行一個隨機動作。
- 引數:
tensordict (TensorDictBase, optional) – 結果動作應寫入的 tensordict。
- 返回值:
一個 tensordict 物件，其“action”條目已使用 action-spec 的隨機取樣進行更新。
- rand_step(tensordict: TensorDictBase | None = None) TensorDictBase[source]¶
根據 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¶
在模組上註冊一個反向鉤子。
此函式已棄用，推薦使用
register_full_backward_hook()。此函式的行為將在未來版本中更改。- 返回值:
一個可用於透過呼叫
handle.remove()移除所新增鉤子的控制代碼。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_buffer(name: str, tensor: Optional[Tensor], persistent: bool = True) None¶
向模組新增一個緩衝區。
這通常用於註冊不應被視為模型引數的緩衝區。例如，BatchNorm 的
running_mean不是引數，但它是模組狀態的一部分。緩衝區預設是持久的，並將與引數一起儲存。透過將persistent設定為False可以改變此行為。持久緩衝區和非持久緩衝區之間的唯一區別在於，後者不會是當前模組的state_dict的一部分。緩衝區可以使用給定的名稱作為屬性進行訪問。
- 引數:
name (str) – 緩衝區的名稱。可以使用給定的名稱從該模組訪問緩衝區。
tensor (Tensor 或 None) – 要註冊的緩衝區。如果為
None，則對緩衝區執行的操作（如cuda）將被忽略。如果為None，則緩衝區將**不**包含在模組的state_dict中。persistent (bool) – 緩衝區是否是當前模組的
state_dict的一部分。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> self.register_buffer('running_mean', torch.zeros(num_features))
- register_forward_hook(hook: Union[Callable[[T, Tuple[Any, ...], Any], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) RemovableHandle¶
在模組上註冊一個前向鉤子。
在
forward()計算出輸出後，每次都會呼叫該鉤子。如果
with_kwargs為False或未指定，輸入只包含傳遞給模組的位置引數。關鍵字引數不會傳遞給鉤子，只會傳遞給forward。鉤子可以修改輸出。它可以就地修改輸入，但由於此鉤子是在forward()呼叫後呼叫的，因此對 forward 沒有影響。鉤子應具有以下簽名：hook(module, args, output) -> None or modified output
如果
with_kwargs為True，前向鉤子將接收傳遞給 forward 函式的kwargs，並應返回可能修改後的輸出。鉤子應具有以下簽名：hook(module, args, kwargs, output) -> None or modified output
- 引數:
hook (Callable) – 要註冊的使用者定義鉤子。
prepend (bool) – 如果為
True，則提供的hook將在此torch.nn.modules.Module上所有現有forward鉤子之前被觸發。否則，提供的hook將在所有現有forward鉤子之後被觸發。注意，透過register_module_forward_hook()註冊的全域性forward鉤子將在透過此方法註冊的所有鉤子之前被觸發。預設值：Falsewith_kwargs (bool) – 如果為
True，鉤子將接收傳遞給 forward 函式的 kwargs。預設值：Falsealways_call (bool) – 如果為
True，無論呼叫模組時是否引發異常，都會執行鉤子。預設值：False
- 返回值:
一個可用於透過呼叫
handle.remove()移除所新增鉤子的控制代碼。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_forward_pre_hook(hook: Union[Callable[[T, Tuple[Any, ...]], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any]], Optional[Tuple[Any, Dict[str, Any]]]]], *, prepend: bool = False, with_kwargs: bool = False) RemovableHandle¶
在模組上註冊一個前向預鉤子。
在
forward()呼叫前，每次都會呼叫該鉤子。如果
with_kwargs為 false 或未指定，輸入只包含傳遞給模組的位置引數。關鍵字引數不會傳遞給鉤子，只會傳遞給forward。鉤子可以修改輸入。使用者可以在鉤子中返回一個元組或一個修改後的單一值。如果返回單一值（除非該值本身就是一個元組），我們會將其包裝成一個元組。鉤子應具有以下簽名：hook(module, args) -> None or modified input
如果
with_kwargs為 true，前向預鉤子將接收傳遞給 forward 函式的 kwargs。如果鉤子修改了輸入，則應同時返回 args 和 kwargs。鉤子應具有以下簽名：hook(module, args, kwargs) -> None or a tuple of modified input and kwargs
- 引數:
hook (Callable) – 要註冊的使用者定義鉤子。
prepend (布林值) – 如果為 True，提供的
hook將在該torch.nn.modules.Module上所有現有的forward_prehook 之前觸發。否則，提供的hook將在該torch.nn.modules.Module上所有現有的forward_prehook 之後觸發。注意，使用register_module_forward_pre_hook()註冊的全域性forward_prehook 將在此方法註冊的所有 hook 之前觸發。預設值:Falsewith_kwargs (布林值) – 如果為 True，提供的
hook將會收到傳遞給 forward 函式的關鍵字引數 (kwargs)。預設值:False
- 返回值:
一個可用於透過呼叫
handle.remove()移除所新增鉤子的控制代碼。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_full_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) RemovableHandle¶
在模組上註冊一個反向鉤子。
每當計算模組的梯度時，就會呼叫該 hook，也就是說，僅當計算模組輸出的梯度時，該 hook 才會執行。hook 應具有以下簽名
hook(module, grad_input, grad_output) -> tuple(Tensor) or None
grad_input和grad_output是元組，分別包含相對於輸入和輸出的梯度。hook 不應修改其引數，但它可以選擇性地返回一個相對於輸入的新梯度，該梯度將在後續計算中用來替代grad_input。grad_input將僅對應於作為位置引數給定的輸入，所有關鍵字引數 (kwarg arguments) 都將被忽略。grad_input和grad_output中的非 Tensor 引數條目將為None。出於技術原因，當此 hook 應用於模組時，其 forward 函式將接收傳遞給該模組的每個 Tensor 的檢視 (view)。同樣，呼叫方將接收該模組 forward 函式返回的每個 Tensor 的檢視 (view)。
警告
使用 backward hook 時不允許原地修改輸入或輸出，否則會引發錯誤。
- 引數:
hook (可呼叫物件) – 要註冊的使用者定義 hook。
prepend (布林值) – 如果為 True，提供的
hook將在該torch.nn.modules.Module上所有現有的backwardhook 之前觸發。否則，提供的hook將在該torch.nn.modules.Module上所有現有的backwardhook 之後觸發。注意，使用register_module_full_backward_hook()註冊的全域性backwardhook 將在此方法註冊的所有 hook 之前觸發。
- 返回值:
一個可用於透過呼叫
handle.remove()移除所新增鉤子的控制代碼。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_full_backward_pre_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) RemovableHandle¶
在模組上註冊一個 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 的檢視 (view)。同樣，呼叫方將接收該模組 forward 函式返回的每個 Tensor 的檢視 (view)。
警告
使用 backward hook 時不允許原地修改輸入，否則會引發錯誤。
- 引數:
hook (可呼叫物件) – 要註冊的使用者定義 hook。
prepend (布林值) – 如果為 True，提供的
hook將在該torch.nn.modules.Module上所有現有的backward_prehook 之前觸發。否則，提供的hook將在該torch.nn.modules.Module上所有現有的backward_prehook 之後觸發。注意，使用register_module_full_backward_pre_hook()註冊的全域性backward_prehook 將在此方法註冊的所有 hook 之前觸發。
- 返回值:
一個可用於透過呼叫
handle.remove()移除所新增鉤子的控制代碼。- 返回型別:
torch.utils.hooks.RemovableHandle
- classmethod register_gym(id: str, *, entry_point: Callable | None = None, transform: Transform | None = None, info_keys: list[NestedKey] | None = None, backend: str = None, to_numpy: bool = False, reward_threshold: float | None = None, nondeterministic: bool = False, max_episode_steps: int | None = None, order_enforce: bool = True, autoreset: bool = False, disable_env_checker: bool = False, apply_api_compatibility: bool = False, **kwargs)[原始碼]¶
在 gym(nasium) 中註冊一個環境。
此方法的設計考慮了以下目的：
將一個 TorchRL 優先的環境整合到使用 Gym 的框架中；
將其他環境（例如 DeepMind Control, Brax, Jumanji 等）整合到使用 Gym 的框架中。
- 引數:
id (字串) – 環境的名稱。應遵循 gym 命名規範。
- 關鍵字引數:
entry_point (可呼叫物件, 可選) –
用於構建環境的入口點。如果未傳遞，則使用父類作為入口點。通常用於註冊一個不一定繼承自當前所用基類的環境
>>> from torchrl.envs import DMControlEnv >>> DMControlEnv.register_gym("DMC-cheetah-v0", env_name="cheetah", task="run") >>> # equivalently >>> EnvBase.register_gym("DMC-cheetah-v0", entry_point=DMControlEnv, env_name="cheetah", task="run")
transform (torchrl.envs.Transform) – 與環境一起使用的變換（或
torchrl.envs.Compose例項中的變換列表）。此引數可在呼叫make()時傳遞（參見下方示例）。info_keys (NestedKey 列表, 可選) –
如果提供，這些鍵將用於構建 info 字典，並將從觀察鍵 (observation keys) 中排除。此引數可在呼叫
make()時傳遞（參見下方示例）。警告
使用
info_keys可能會導致規範 (spec) 變為空，因為內容已移至 info 字典。Gym 不喜歡規範中的空 Dict，因此應使用RemoveEmptySpecs移除此空內容。backend (字串, 可選) – 後端。可以是 “gym” 或 “gymnasium”，或任何其他與
set_gym_backend相容的後端。to_numpy (布林值, 可選) – 如果為
True，呼叫 step 和 reset 的結果將對映到 numpy 陣列。預設值:False(結果是 Tensor)。此引數可在呼叫make()時傳遞（參見下方示例）。reward_threshold (
浮點數, optional) – [Gym 關鍵字引數] 被認為是學到某個環境的獎勵閾值。nondeterministic (布林值, 可選) – [Gym 關鍵字引數] 如果環境是非確定性的（即使已知初始種子和所有動作）。預設值:
False。max_episode_steps (整數, 可選) – [Gym 關鍵字引數] 截斷前的最大回合步數。由 Time Limit 包裝器使用。
order_enforce (布林值, 可選) – [Gym >= 0.14] 是否應應用 order enforcer 包裝器以確保使用者按正確順序執行函式。預設值:
True。autoreset (布林值, 可選) – [Gym >= 0.14] 是否應新增 autoreset 包裝器，以便無需呼叫 reset。預設值:
False。disable_env_checker – [Gym >= 0.14] 是否應為環境停用環境檢查器。預設值:
False。apply_api_compatibility – [Gym >= 0.26] 是否應用 StepAPICompatibility 包裝器。預設值:
False。**kwargs – 傳遞給環境建構函式的任意關鍵字引數。
注意
TorchRL 的環境沒有“info”字典的概念，因為 TensorDict 在大多數訓練設定中提供了所有必要的儲存需求。但是，您可以使用
info_keys引數來精細控制哪些內容應被視為觀察 (observation)，哪些內容應被視為資訊 (info)。示例
>>> # Register the "cheetah" env from DMControl with the "run" task >>> from torchrl.envs import DMControlEnv >>> import torch >>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gym", env_name="cheetah", task_name="run") >>> import gym >>> envgym = gym.make("DMC-cheetah-v0") >>> envgym.seed(0) >>> torch.manual_seed(0) >>> envgym.reset() ({'position': tensor([-0.0855, 0.0215, -0.0881, -0.0412, -0.1101, 0.0080, 0.0254, 0.0424], dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03, 3.3842e-02, 2.5338e-02, 3.3064e-02, 1.0381e-04, 7.6656e-05, 1.0204e-02], dtype=torch.float64)}, {}) >>> envgym.step(envgym.action_space.sample()) ({'position': tensor([-0.0833, 0.0275, -0.0612, -0.0770, -0.1256, 0.0082, 0.0186, 0.0476], dtype=torch.float64), 'velocity': tensor([ 0.2221, 0.2256, 0.5930, 2.6937, -3.5865, -1.5479, 0.0187, -0.6825, 0.5224], dtype=torch.float64)}, tensor([0.0018], dtype=torch.float64), tensor([False]), tensor([False]), {}) >>> # same environment with observation stacked >>> from torchrl.envs import CatTensors >>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation")) >>> envgym.reset() ({'observation': tensor([-0.1005, 0.0335, -0.0268, 0.0133, -0.0627, 0.0074, -0.0488, -0.0353, -0.0075, -0.0069, 0.0098, -0.0058, 0.0033, -0.0157, -0.0004, -0.0381, -0.0452], dtype=torch.float64)}, {}) >>> # same environment with numpy observations >>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation"), to_numpy=True) >>> envgym.reset() ({'observation': array([-0.11355747, 0.04257728, 0.00408397, 0.04155852, -0.0389733 , -0.01409826, -0.0978704 , -0.08808327, 0.03970837, 0.00535434, -0.02353762, 0.05116226, 0.02788907, 0.06848346, 0.05154399, 0.0371798 , 0.05128025])}, {}) >>> # If gymnasium is installed, we can register the environment there too. >>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gymnasium", env_name="cheetah", task_name="run") >>> import gymnasium >>> envgym = gymnasium.make("DMC-cheetah-v0") >>> envgym.seed(0) >>> torch.manual_seed(0) >>> envgym.reset() ({'position': tensor([-0.0855, 0.0215, -0.0881, -0.0412, -0.1101, 0.0080, 0.0254, 0.0424], dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03, 3.3842e-02, 2.5338e-02, 3.3064e-02, 1.0381e-04, 7.6656e-05, 1.0204e-02], dtype=torch.float64)}, {})
注意
此功能也適用於無狀態環境（例如，
BraxEnv）。>>> import gymnasium >>> import torch >>> from tensordict import TensorDict >>> from torchrl.envs import BraxEnv, SelectTransform >>> >>> # get action for dydactic purposes >>> env = BraxEnv("ant", batch_size=[2]) >>> env.set_seed(0) >>> torch.manual_seed(0) >>> td = env.rollout(10) >>> >>> actions = td.get("action") >>> >>> # register env >>> env.register_gym("Brax-Ant-v0", env_name="ant", batch_size=[2], info_keys=["state"]) >>> gym_env = gymnasium.make("Brax-Ant-v0") >>> gym_env.seed(0) >>> torch.manual_seed(0) >>> >>> gym_env.reset() >>> obs = [] >>> for i in range(10): ... obs, reward, terminated, truncated, info = gym_env.step(td[..., i].get("action"))
- register_load_state_dict_post_hook(hook)¶
註冊一個 post-hook，在呼叫模組的
load_state_dict()後執行。- 它應具有以下簽名：
hook(module, incompatible_keys) -> None
module引數是註冊此 hook 的當前模組，而incompatible_keys引數是一個NamedTuple，包含missing_keys和unexpected_keys屬性。missing_keys是一個包含缺失鍵的list（字串列表），而unexpected_keys是一個包含意外部索引鍵的list（字串列表）。如果需要，可以原地修改給定的 incompatible_keys。
注意，在呼叫
load_state_dict()時設定strict=True所執行的檢查會受到 hook 對missing_keys或unexpected_keys所做修改的影響，這符合預期。向任何一組鍵中新增內容都將在strict=True時引發錯誤，清除所有缺失和意外部索引鍵將避免錯誤。- 返回值:
一個可用於透過呼叫
handle.remove()移除所新增鉤子的控制代碼。- 返回型別:
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 (可呼叫物件) – 在載入狀態字典之前將被呼叫的可呼叫 hook。
- register_module(name: str, module: Optional[Module]) None¶
是
add_module()的別名。
- register_parameter(name: str, param: Optional[Parameter]) None¶
向模組新增一個引數。
可以使用給定名稱作為屬性來訪問該引數。
- 引數:
name (字串) – 引數的名稱。可以使用給定名稱從該模組訪問該引數
param (Parameter 或 None) – 要新增到模組的引數。如果為
None，則對引數執行的操作（例如cuda）將被忽略。如果為None，該引數將不包含在模組的state_dict中。
- register_state_dict_post_hook(hook)¶
為
state_dict()方法註冊一個 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 (布林值) – Autograd 是否應對該模組中的引數記錄操作。預設值:
True。- 返回值:
自身
- 返回型別:
Module
- reset(tensordict: TensorDictBase | None = None, **kwargs) TensorDictBase[原始碼]¶
重置環境。
與 step 和 _step 類似，只有私有方法
_reset應由 EnvBase 子類覆蓋。- 引數:
tensordict (TensorDictBase, 可選) – 用於包含重置後新觀察結果的 tensordict。在某些情況下，此輸入也可用於向 reset 函式傳遞引數。
kwargs (可選) – 傳遞給原生 reset 函式的其他引數。
- 返回值:
一個 tensordict（如果提供了輸入 tensordict，則為該 tensordict），在原地用重置後的觀察結果進行修改。
注意
reset不應被EnvBase子類覆蓋。應修改的方法是_reset()。
- property reset_keys: list[tensordict._nestedkey.NestedKey]¶
返回 reset 鍵的列表。
Reset 鍵是表示部分重置的鍵，在批處理、多工或多智慧體設定中。它們的結構是
(*prefix, "_reset")，其中prefix是一個（可能為空的）字串元組，指向 tensordict 中可以找到 done 狀態的位置。鍵按資料樹中的深度排序。
- property reward_key¶
環境的獎勵鍵。
預設情況下，這將是 “reward”。
如果環境中存在多個獎勵鍵，此函式將引發異常。
- property reward_keys: list[tensordict._nestedkey.NestedKey]¶
環境的獎勵鍵列表。
預設情況下，只有一個名為 “reward” 的鍵。
鍵按資料樹中的深度排序。
- property reward_spec: TensorSpec¶
reward規範。reward_spec總是儲存為一個複合規範 (composite spec)。如果獎勵規範以簡單規範 (simple 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)
如果獎勵規範以複合規範 (composite spec) 的形式提供且只包含一個葉子 (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)
如果獎勵規範以複合規範 (composite spec) 的形式提供且包含多個葉子 (leaf)，此函式將返回整個規範。
>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1), "another_reward": Categorical(1)}}) >>> env.reward_spec Composite( nested: Composite( reward: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), another_reward: Categorical( shape=torch.Size([]), space=DiscreteBox(n=1), device=cpu, dtype=torch.int64, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
要檢索傳遞的完整規範，請使用
>>> env.output_spec["full_reward_spec"]
此屬性是可變的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous)
- property reward_spec_unbatched: TensorSpec¶
返回環境的獎勵規範，如同它沒有批次維度一樣。
- rollout(max_steps: int, policy: Callable[[TensorDictBase], TensorDictBase] | None = None, callback: Callable[[TensorDictBase, ...], Any] | None = None, *, auto_reset: bool = True, auto_cast_to_device: bool = False, break_when_any_done: bool | None = None, break_when_all_done: bool | None = None, return_contiguous: bool | None = False, tensordict: TensorDictBase | None = None, set_truncated: bool = False, out=None, trust_policy: bool = False) TensorDictBase[source]¶
在環境中執行一次 Rollout。
一旦任何包含的環境達到任何終止狀態，該函式將立即返回。
- 引數:
max_steps (int) – 要執行的最大步數。如果在達到 max_steps 之前環境達到終止狀態，則實際步數可能更少。
policy (callable, optional) – 用於計算所需動作的可呼叫物件。如果未提供策略，則使用
env.rand_step()呼叫動作。策略可以是任何讀取 tensordict 或整個觀測條目序列的可呼叫物件，這些條目按__env.observation_spec.keys()排序。預設為 None。callback (Callable[[TensorDict], Any], optional) – 在每次迭代中與給定 TensorDict 一起呼叫的函式。預設為
None。callback的輸出將不會被收集，使用者有責任在 callback 呼叫中儲存任何結果，如果資料需要在rollout呼叫之後繼續使用的話。
- 關鍵字引數:
auto_reset (bool, optional) – 如果為
True，則在開始 Rollout 之前將重置包含的環境。如果為False，則 Rollout 將從之前的狀態繼續，這需要傳遞帶有之前 Rollout 結果的tensordict引數。預設值為True。auto_cast_to_device (bool, optional) – 如果為
True，則在使用策略之前，tensordict 的裝置會自動轉換為策略裝置。預設值為False。break_when_any_done (bool) – 如果為
True，則當任何包含的環境達到任何終止狀態時中斷。如果為False，則終止的環境會自動重置。預設值為True。break_when_all_done (bool, optional) – 如果為
True，則當所有包含的環境都達到任何終止狀態時中斷。如果為False，則當至少一個環境達到任何終止狀態時中斷。預設值為False。return_contiguous (bool) – 如果為 False，則返回一個 LazyStackedTensorDict。如果環境沒有動態規範，則預設值為 True，否則為 False。
tensordict (TensorDict, optional) – 如果
auto_reset為 False，必須提供一個初始 tensordict。Rollout 將檢查此 tensordict 是否包含終止標誌，並在這些維度（如果需要）重置環境。如果tensordict是重置的輸出，這通常不會發生，但如果tensordict是先前 Rollout 的最後一步，則可能發生。如果需要向reset方法傳遞元資料（例如無狀態環境的批次大小或裝置），則在auto_reset=True時也可以提供一個tensordict。set_truncated (bool, optional) – 如果為
True，Rollout 完成後，"truncated"和"done"鍵將設定為True。如果在done_spec中找不到"truncated"，則會引發異常。可以透過env.add_truncated_keys設定截斷鍵。預設值為False。trust_policy (bool, optional) – 如果為
True，則信任非 TensorDictModule 策略與收集器相容。CudaGraphModules 預設為True，否則預設為False。
- 返回值:
包含結果軌跡的 TensorDict 物件。
返回的資料將在 tensordict 的最後一個維度（在
env.ndim索引處）標記一個 “time” 維度名稱。rollout對於顯示環境的資料結構是什麼樣子非常方便。示例
>>> # Using rollout without a policy >>> from torchrl.envs.libs.gym import GymEnv >>> from torchrl.envs.transforms import TransformedEnv, StepCounter >>> env = TransformedEnv(GymEnv("Pendulum-v1"), StepCounter(max_steps=20)) >>> rollout = env.rollout(max_steps=1000) >>> print(rollout) TensorDict( fields={ action: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([20, 3]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([20]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([20, 3]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([20]), device=cpu, is_shared=False) >>> print(rollout.names) ['time'] >>> # with envs that contain more dimensions >>> from torchrl.envs import SerialEnv >>> env = SerialEnv(3, lambda: TransformedEnv(GymEnv("Pendulum-v1"), StepCounter(max_steps=20))) >>> rollout = env.rollout(max_steps=1000) >>> print(rollout) TensorDict( fields={ action: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([3, 20, 3]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 20]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([3, 20, 3]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 20, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 20]), device=cpu, is_shared=False) >>> print(rollout.names) [None, 'time']
使用策略（可以是常規的
Module或TensorDictModule）也很容易示例
>>> from torch import nn >>> env = GymEnv("CartPole-v1", categorical_action_encoding=True) >>> class ArgMaxModule(nn.Module): ... def forward(self, values): ... return values.argmax(-1) >>> n_obs = env.observation_spec["observation"].shape[-1] >>> n_act = env.action_spec.n >>> # A deterministic policy >>> policy = nn.Sequential( ... nn.Linear(n_obs, n_act), ... ArgMaxModule()) >>> env.rollout(max_steps=10, policy=policy) TensorDict( fields={ action: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.int64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False) >>> # Under the hood, rollout will wrap the policy in a TensorDictModule >>> # To speed things up we can do that ourselves >>> from tensordict.nn import TensorDictModule >>> policy = TensorDictModule(policy, in_keys=list(env.observation_spec.keys()), out_keys=["action"]) >>> env.rollout(max_steps=10, policy=policy) TensorDict( fields={ action: Tensor(shape=torch.Size([10]), device=cpu, dtype=torch.int64, is_shared=False), done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([10, 4]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([10, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([10]), device=cpu, is_shared=False)
在某些情況下，無法獲得連續的 tensordict，因為它們無法堆疊。當每一步返回的資料形狀可能不同，或者同時執行不同的環境時，可能會發生這種情況。在這種情況下，
return_contiguous=False將導致返回的 tensordict 是一個 tensordict 的惰性堆疊 (lazy stack)。- 非連續 Rollout 的示例
>>> rollout = env.rollout(4, return_contiguous=False) >>> print(rollout) LazyStackedTensorDict( fields={ action: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: LazyStackedTensorDict( fields={ done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 4]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 4]), device=cpu, is_shared=False) >>> print(rollout.names) [None, 'time']
Rollout 可以在迴圈中使用，以模擬資料收集。為此，您需要將上一次 Rollout 呼叫
step_mdp()後得到的最後一個 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: int | None = None, static_seed: bool =False) int | None[source]¶
設定環境的種子，並返回下一個要使用的種子（如果只存在一個環境，則為輸入的種子）。
- 引數:
seed (int) – 要設定的種子。種子只在環境本地設定。要處理全域性種子，請參見
manual_seed()。static_seed (bool, optional) – 如果為
True，則種子不會遞增。預設為 False
- 返回值:
即，如果同時建立另一個環境，應該使用該種子。
- 返回型別:
表示“下一個種子”的整數
- set_spec_lock_(mode: bool = True) EnvBase[source]¶
鎖定或解鎖環境的規範。
- 引數:
mode (bool) – 是否鎖定 (True) 或解鎖 (False) 規範。預設為 True。
- 返回值:
環境例項本身。
- 返回型別:
另請參閱
- set_submodule(target: str, module: Module) None¶
設定由
target指定的子模組（如果存在），否則丟擲錯誤。例如，假設您有一個
nn.ModuleA，其結構如下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.ModuleA。A有一個巢狀子模組net_b，其本身又有兩個子模組net_c和linear。net_c然後有一個子模組conv。)要用一個新的子模組
Linear替換Conv2d，您可以呼叫set_submodule("net_b.net_c.conv", nn.Linear(33, 16))。- 引數:
target – 要查詢的子模組的完全限定字串名稱。（有關如何指定完全限定字串，請參見上面的示例。）
module – 要設定子模組的模組。
- 丟擲:
ValueError – 如果 target 字串為空
AttributeError – 如果 target 字串引用了無效路徑或解析到的不是
nn.Module
- property shape¶
等價於
batch_size。
- state_dict(*args, destination=None, prefix='', keep_vars=False)¶
返回一個字典，其中包含對模組整個狀態的引用。
引數和持久緩衝區（例如移動平均）都包含在內。鍵是相應的引數和緩衝區名稱。設定為
None的引數和緩衝區不包含在內。注意
返回的物件是一個淺複製。它包含對模組引數和緩衝區的引用。
警告
當前
state_dict()也按順序接受用於destination、prefix和keep_vars的位置引數。但是，這正在被棄用，未來版本將強制使用關鍵字引數。警告
請避免使用引數
destination，因為它不是為終端使用者設計的。- 引數:
destination (dict, optional) – 如果提供，模組的狀態將更新到此字典中並返回同一物件。否則，將建立一個
OrderedDict並返回。預設值：None。prefix (str, optional) – 新增到引數和緩衝區名稱的字首，用於組成 state_dict 中的鍵。預設值：
''。keep_vars (bool, optional) – 預設情況下，在 state dict 中返回的
Tensor從 autograd 分離。如果設定為True，則不執行分離。預設值：False。
- 返回值:
包含模組整個狀態的字典
- 返回型別:
dict
示例
>>> # xdoctest: +SKIP("undefined vars") >>> module.state_dict().keys() ['bias', 'weight']
- property state_keys: list[tensordict._nestedkey.NestedKey]¶
環境的狀態鍵列表。
預設情況下，只有一個名為 “state” 的鍵。
鍵按資料樹中的深度排序。
- property state_spec: Composite¶
狀態規範。
必須是
torchrl.data.Composite例項。此處列出的鍵應與動作一起作為輸入提供給環境。在 TorchRL 中，即使它們並非嚴格意義上的“狀態”，所有不屬於動作的環境輸入都儲存在
state_spec中。因此，
"state_spec"應被視為一個通用的資料容器，用於儲存不屬於動作資料的環境輸入。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.state_spec Composite( state: Composite( pipeline_state: Composite( q: UnboundedContinuous( shape=torch.Size([15]), space=None, device=cpu, dtype=torch.float32, domain=continuous), [...], device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- property state_spec_unbatched: TensorSpec¶
返回環境的狀態規範，如同它沒有批次維度一樣。
- step(tensordict: TensorDictBase) TensorDictBase[source]¶
在環境中執行一步。
Step 方法接受一個引數 tensordict，它通常包含一個 ‘action’ 鍵，指示要執行的動作。Step 將呼叫一個非原地 (out-place) 私有方法 _step，這是 EnvBase 子類需要重寫的方法。
- 引數:
tensordict (TensorDictBase) – 包含要執行的動作的 Tensordict。如果輸入的 tensordict 包含一個
"next"條目，則其中包含的值將優先於新計算的值。這提供了一種覆蓋底層計算的機制。- 返回值:
輸入的 tensordict，原地修改以包含結果觀測、終止狀態和獎勵（+如果需要則包含其他資訊）。
- step_and_maybe_reset(tensordict: TensorDictBase) tuple[tensordict.base.TensorDictBase, tensordict.base.TensorDictBase][source]¶
在環境中執行一步，並（部分）重置環境（如果需要）。
- 引數:
tensordict (TensorDictBase) –
step()方法的輸入資料結構。
此方法允許輕鬆編寫非停止的 Rollout 函式。
示例
>>> from torchrl.envs import ParallelEnv, GymEnv >>> def rollout(env, n): ... data_ = env.reset() ... result = [] ... for i in range(n): ... data, data_ = env.step_and_maybe_reset(data_) ... result.append(data) ... return torch.stack(result) >>> env = ParallelEnv(2, lambda: GymEnv("CartPole-v1")) >>> print(rollout(env, 2)) TensorDict( fields={ done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([2, 2]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([2, 2]), device=cpu, is_shared=False)
- step_mdp(next_tensordict: TensorDictBase) TensorDictBase[source]¶
使用提供的 next_tensordict 將環境狀態向前推進一步。
此方法透過從當前狀態轉換為下一個狀態來更新環境的狀態，如 next_tensordict 所定義。結果 tensordict 包含更新後的觀測以及任何其他相關狀態資訊，鍵根據環境規範進行管理。
在內部，此方法利用預計算的
_StepMDP例項來高效處理狀態、觀測、動作、獎勵和終止鍵的轉換。_StepMDP類透過預計算要包含和排除的鍵來最佳化過程，減少重複呼叫期間的執行時開銷。_StepMDP例項使用 `exclude_action=False` 建立，這意味著動作鍵保留在根 tensordict 中。- 引數:
next_tensordict (TensorDictBase) – 包含環境在下一個時間步的狀態的 tensordict。此 tensordict 應包含觀測、動作、獎勵和終止標誌的鍵，如環境規範所定義。
- 返回值:
表示環境狀態向前推進一步後的新 tensordict。
- 返回型別:
TensorDictBase
注意
此方法確保環境的鍵規範對照提供的 next_tensordict 進行驗證，如果發現差異則發出警告。
注意
此方法旨在與具有一致鍵規範的環境高效協作，利用 _StepMDP 類最小化開銷。
示例
>>> from torchrl.envs import GymEnv >>> env = GymEnv("Pendulum-1") >>> data = env.reset() >>> for i in range(10): ... # compute action ... env.rand_action(data) ... # Perform action ... next_data = env.step(reset_data) ... data = env.step_mdp(next_data)
- to(device: Union[device, str, int]) EnvBase[source]¶
移動和/或轉換引數和緩衝區。
可以按如下方式呼叫：
- 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時，如果可能，它會嘗試相對於主機（host）進行非同步轉換/移動，例如，將帶有鎖頁記憶體（pinned memory）的 CPU 張量移動到 CUDA 裝置。參見下方示例。
注意
此方法會原地修改模組。
- 引數:
device (
torch.device) – 此模組中引數和緩衝區的目標裝置dtype (
torch.dtype) – 此模組中引數和緩衝區的目標浮點型或複數型資料型別tensor (torch.Tensor) – 其資料型別和裝置是此模組中所有引數和緩衝區目標資料型別和裝置的張量
memory_format (
torch.memory_format) – 此模組中 4D 引數和緩衝區的目標記憶體格式 (僅關鍵字引數)
- 返回值:
自身
- 返回型別:
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) – 子模組的引數和緩衝區是否應遞迴移動到指定的裝置。
- 返回值:
自身
- 返回型別:
Module
- train(mode: bool = True) T¶
將模組設定為訓練模式。
這僅對某些模組有效。有關特定模組在訓練/評估模式下的行為詳情（即它們是否受到影響，例如
Dropout、BatchNorm等），請參閱其文件。- 引數:
mode (bool) – 是否設定為訓練模式 (
True) 或評估模式 (False)。預設值:True。- 返回值:
自身
- 返回型別:
Module
- type(dst_type: Union[dtype, str]) T¶
將所有引數和緩衝區轉換為
dst_type。注意
此方法會原地修改模組。
- 引數:
dst_type (type or string) – 目標型別
- 返回值:
自身
- 返回型別:
Module
- xpu(device: Optional[Union[int, device]] = None) T¶
將所有模型引數和緩衝區移動到 XPU。
這也會使相關的引數和緩衝區成為不同的物件。因此，如果模組在最佳化時將駐留在 XPU 上，應在構建最佳化器之前呼叫此方法。
注意
此方法會原地修改模組。
- 引數:
device (int, optional) – 如果指定，所有引數將被複制到該裝置
- 返回值:
自身
- 返回型別:
Module
- zero_grad(set_to_none: bool = True) None¶
重置所有模型引數的梯度。
有關更多背景資訊，請參閱
torch.optim.Optimizer下的類似函式。- 引數:
set_to_none (bool) – 不是設定為零，而是將梯度設定為 `None`。詳情請參閱
torch.optim.Optimizer.zero_grad()。
