GymLikeEnv¶
- class torchrl.envs.GymLikeEnv(*args, **kwargs)[來源]¶
一個類 gym 的環境就是一個環境。
它的行為與 gym 環境類似，對於通用方法（特別是 reset 和 step）的預期行為是一致的。
一個
GymLikeEnv有一個step()方法，其簽名如下env.step(action: np.ndarray) -> Tuple[Union[np.ndarray, dict], double, bool, *info]其中輸出分別是 observation、reward 和 done 狀態。在此實現中，info 輸出被丟棄（但特定鍵可以透過更新 info_dict_reader 讀取，參見
set_info_dict_reader()方法）。預設情況下，第一個輸出會寫入輸出 tensordict 的 "observation" 鍵值對，除非第一個輸出是字典。在這種情況下，對於字典中的每個 "{key}"，相應的 observation 輸出會放在 "{key}" 位置。
同樣期望的是，env.reset() 返回的 observation 與 step 完成後觀察到的 observation 類似。
- property action_key: NestedKey¶
環境的 action 鍵。
預設情況下，這將是 “action”。
如果環境中有多個 action 鍵，此函式將丟擲異常。
- property action_keys: list[tensordict._nestedkey.NestedKey]¶
環境的 action 鍵。
預設情況下，只有一個名為 “action” 的鍵。
鍵按在資料樹中的深度排序。
- property action_spec: TensorSpec¶
actionspec。action_spec總是以複合 spec 儲存。如果 action spec 作為簡單 spec 提供，則返回該簡單 spec。
>>> env.action_spec = Unbounded(1) >>> env.action_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果 action spec 作為複合 spec 提供且只包含一個葉節點，此函式將僅返回該葉節點。
>>> env.action_spec = Composite({"nested": {"action": Unbounded(1)}}) >>> env.action_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果 action spec 作為複合 spec 提供且包含多個葉節點，此函式將返回整個 spec。
>>> env.action_spec = Composite({"nested": {"action": Unbounded(1), "another_action": Categorical(1)}}) >>> env.action_spec Composite( nested: Composite( action: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), another_action: Categorical( shape=torch.Size([]), space=DiscreteBox(n=1), device=cpu, dtype=torch.int64, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
要檢索傳遞的完整 spec，請使用
>>> env.input_spec["full_action_spec"]
此屬性是可變的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.action_spec BoundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
- property action_spec_unbatched: TensorSpec¶
返回環境的 action spec，就像它沒有批次維度一樣。
- add_module(name: str, module: Optional[Module]) None¶
向當前模組新增一個子模組。
可以使用給定名稱作為屬性訪問該模組。
- 引數:
name (str) – 子模組的名稱。可以使用給定名稱從此模組訪問子模組
module (Module) – 要新增到模組的子模組。
- all_actions(tensordict: TensorDictBase | None = None) TensorDictBase¶
從 action spec 生成所有可能的 actions。
這隻適用於具有完全離散 actions 的環境。
- 引數:
tensordict (TensorDictBase, 可選) – 如果給定，將使用此 tensordict 呼叫
reset()。- 返回:
一個 tensordict 物件，其中 “action” 條目已更新為所有可能 actions 的批次。actions 在前導維度中堆疊在一起。
- append_transform(transform: Transform | Callable[[TensorDictBase], TensorDictBase]) EnvBase¶
返回一個轉換後的環境，其中應用了傳遞的 callable/transform。
- 引數:
transform (Transform 或 Callable[[TensorDictBase], TensorDictBase]) – 要應用於環境的 transform。
示例
>>> from torchrl.envs import GymEnv >>> import torch >>> env = GymEnv("CartPole-v1") >>> loc = 0.5 >>> scale = 1.0 >>> transform = lambda data: data.set("observation", (data.get("observation") - loc)/scale) >>> env = env.append_transform(transform=transform) >>> print(env) TransformedEnv( env=GymEnv(env=CartPole-v1, batch_size=torch.Size([]), device=cpu), transform=_CallableTransform(keys=[]))
- apply(fn: Callable[[Module], None]) T¶
遞迴地將
fn應用於每個子模組（透過.children()返回）以及自身。典型用法包括初始化模型的引數（另請參見 torch.nn.init）。
- 引數:
fn (
Module-> None) – 要應用於每個子模組的函式- 返回:
自身
- 返回型別:
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_register_info_dict(ignore_private: bool | None = True, *, info_dict_reader: Optional[BaseInfoDictReader] = None) EnvBase[來源]¶
自動註冊 info 字典並在需要時新增
TensorDictPrimer例項。如果未提供 info_dict_reader，則假定 info 字典中包含的所有資訊都可以註冊為 tensordict 中的數值。
此方法返回一個（可能已轉換的）環境，在該環境中我們確保
torchrl.envs.utils.check_env_specs()能夠成功執行，無論 info 是否在重置時填充。注意
此方法需要在環境中執行幾次迭代以手動檢查行為是否符合預期。
- 引數:
ignore_private (bool, 可選) – 如果為
True，則會忽略私有資訊（以下劃線開頭）。預設為True。- 關鍵字引數:
info_dict_reader (BaseInfoDictReader, 可選) – 如果 info_dict_reader 預先已知，則為該 reader。與
set_info_dict_reader()不同，此方法將建立執行check_env_specs()所需的 primer。
示例
>>> from torchrl.envs import GymEnv >>> env = GymEnv("HalfCheetah-v4") >>> # registers the info dict reader >>> env.auto_register_info_dict() GymEnv(env=HalfCheetah-v4, batch_size=torch.Size([]), device=cpu) >>> env.rollout(3) TensorDict( fields={ action: Tensor(shape=torch.Size([3, 6]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([3, 17]), device=cpu, dtype=torch.float64, is_shared=False), reward: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.float32, is_shared=False), reward_ctrl: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False), reward_run: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False), x_position: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False), x_velocity: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([3]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([3, 17]), device=cpu, dtype=torch.float64, is_shared=False), reward_ctrl: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False), reward_run: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False), terminated: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([3, 1]), device=cpu, dtype=torch.bool, is_shared=False), x_position: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False), x_velocity: Tensor(shape=torch.Size([3]), device=cpu, dtype=torch.float64, is_shared=False)}, batch_size=torch.Size([3]), device=cpu, is_shared=False)
- auto_specs_(policy: Callable[[TensorDictBase], TensorDictBase], *, tensordict: TensorDictBase | None = None, action_key: NestedKey | list[NestedKey] = 'action', done_key: NestedKey | list[NestedKey] | None = None, observation_key: NestedKey | list[NestedKey] = 'observation', reward_key: NestedKey | list[NestedKey] = 'reward')¶
根據使用給定策略進行的隨機 rollout 自動設定環境的 specifications (specs)。
此方法使用提供的策略執行 rollout，以推斷環境的輸入和輸出 specifications。它根據 rollout 期間收集的資料更新環境的 action、observation、reward 和 done 訊號的 specs。
- 引數:
policy (Callable[[TensorDictBase], TensorDictBase]) – 一個可呼叫的策略，接受 TensorDictBase 作為輸入並返回 TensorDictBase 作為輸出。此策略用於執行 rollout 並確定 specs。
- 關鍵字引數:
tensordict (TensorDictBase, 可選) – 一個可選的 TensorDictBase 例項，用作 rollout 的初始狀態。如果未提供，將呼叫環境的 reset 方法以獲取初始狀態。
action_key (NestedKey 或 List[NestedKey], 可選) – 用於在 TensorDictBase 中標識 actions 的鍵。預設為 “action”。
done_key (NestedKey 或 List[NestedKey], 或 None, 可選) – 用於在 TensorDictBase 中標識 done 訊號的鍵。預設為
None，此時將嘗試使用 [“done”, “terminated”, “truncated”] 作為可能的鍵。observation_key (NestedKey 或 List[NestedKey], 可選) – 用於在 TensorDictBase 中標識 observations 的鍵。預設為 “observation”。
reward_key (NestedKey 或 List[NestedKey], 可選) – 用於在 TensorDictBase 中標識 rewards 的鍵。預設為 “reward”。
- 返回:
已更新 specs 的環境例項。
- 返回型別:
- 丟擲:
RuntimeError – 如果輸出 specs 中存在未在提供的鍵中考慮的鍵。
- 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¶
動作空間的基數。
預設情況下，這只是
env.action_space.cardinality的一個包裝。當 action spec 是變數時，此類很有用
動作數量可以未定義，例如
Categorical(n=-1)；動作基數可能取決於動作掩碼；
形狀可以是動態的，如
Unbound(shape=(-1))。
在這些情況下，
cardinality()應該被覆蓋，- 引數:
tensordict (TensorDictBase, 可選) – 包含計算基數所需資料的 tensordict。
- check_env_specs(return_contiguous: bool | None = None, check_dtype=True, seed: int | None = None, tensordict: TensorDictBase | None = None)¶
透過簡短的 rollout 結果測試環境 specs。
此測試函式應用作對使用 torchrl 的 EnvBase 子類包裝的環境進行健全性檢查：預期資料與收集到的資料之間的任何差異都應引發斷言錯誤。
損壞的環境 spec 很可能導致無法使用並行環境。
- 引數:
env (EnvBase) – 需要針對資料檢查 specs 的環境。
return_contiguous (bool, 可選) – 如果為
True，則會以 return_contiguous=True 呼叫隨機 rollout。這在某些情況下（例如，輸入/輸出形狀異構）會失敗。預設為None（由是否存在動態 specs 決定）。check_dtype (bool, 可選) – 如果為 False，將跳過 dtype 檢查。預設為 True。
seed (整型, 可選) – 為了可復現性，可以設定一個種子。該種子將在 pytorch 中臨時設定，然後隨機數生成器 (RNG) 狀態將被恢復到之前的值。對於環境，我們設定了種子，但由於將 RNG 狀態恢復到之前的值並非大多數環境的特性，我們將其留給使用者自行完成。預設為
None。tensordict (TensorDict, 可選) – 用於重置的可選 tensordict 例項。
注意: 此函式會重置環境種子。它應在“離線”狀態下使用，以檢查環境是否充分構建，但它可能會影響實驗的種子設定，因此應避免在訓練指令碼中使用。
- close() None¶
如果可能，關閉包含的環境。
- compile(*args, **kwargs)¶
使用
torch.compile()編譯此 Module 的 forward 方法。此 Module 的 __call__ 方法將被編譯，並且所有引數將原樣傳遞給
torch.compile()。有關此函式引數的詳細資訊，請參閱
torch.compile()。
- cpu() T¶
將所有模型引數和緩衝區移動到 CPU。
注意
此方法會就地修改模組。
- 返回:
自身
- 返回型別:
Module
- cuda(device: Optional[Union[int, device]] = None) T¶
將所有模型引數和緩衝區移動到 GPU。
這也會使相關的引數和緩衝區成為不同的物件。因此，如果模組在最佳化時將位於 GPU 上，應在構建最佳化器之前呼叫此方法。
注意
此方法會就地修改模組。
- 引數:
device (整型, 可選) – 如果指定，所有引數將被複制到該裝置
- 返回:
自身
- 返回型別:
Module
- property done_key¶
環境的 done 鍵。
預設情況下，這將是“done”。
如果環境中有多個 done 鍵，此函式將引發異常。
- property done_keys: list[tensordict._nestedkey.NestedKey]¶
環境的 done 鍵列表。
預設情況下，只會有一個名為“done”的鍵。
鍵按在資料樹中的深度排序。
- property done_keys_groups¶
done 鍵的列表，按重置鍵分組。
這是一個列表的列表。外層列表的長度與重置鍵的數量相同，內層列表包含可用於在重置鍵不存在時確定重置的 done 鍵（例如，done 和 truncated）。
- property done_spec: TensorSpec¶
done規範。done_spec總是作為組合規範儲存。如果 done 規範作為簡單規範提供，則返回此簡單規範。
>>> 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 規範作為組合規範提供且只包含一個葉子，此函式將只返回該葉子。
>>> 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 規範作為組合規範提供且包含多個葉子，此函式將返回整個規範。
>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool), "another_done": Categorical(2, dtype=torch.bool)}}) >>> env.done_spec Composite( nested: Composite( done: Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), another_done: Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
要總是檢索傳遞的完整規範，請使用
>>> env.output_spec["full_done_spec"]
此屬性是可變的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.done_spec Categorical( shape=torch.Size([1]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
- property done_spec_unbatched: TensorSpec¶
返回環境的 done 規範，就像它沒有批處理維度一樣。
- double() T¶
將所有浮點引數和緩衝區轉換為
double資料型別。注意
此方法會就地修改模組。
- 返回:
自身
- 返回型別:
Module
- empty_cache()¶
清除所有快取值。
對於常規環境，鍵列表（獎勵、done 等）會被快取，但在某些情況下（例如，新增變換時）它們可能在程式碼執行期間發生改變。
- eval() T¶
將模組設定為評估模式。
這隻對某些模組有效。有關特定模組在訓練/評估模式下行為的詳細資訊，即它們是否受影響（例如
Dropout、BatchNorm等），請參閱其文件。這等同於呼叫
self.train(False)。有關 .eval() 與幾種可能與之混淆的類似機制的比較，請參閱 區域性停用梯度計算。
- 返回:
自身
- 返回型別:
Module
- extra_repr() str¶
返回模組的額外表示。
要列印自定義的額外資訊，您應該在自己的模組中重新實現此方法。單行和多行字串均可接受。
- fake_tensordict() TensorDictBase¶
返回一個 fake tensordict，其鍵值對的形狀、裝置和 dtype 與環境 rollout 期間可以預期的相匹配。
- float() T¶
將所有浮點引數和緩衝區轉換為
float資料型別。注意
此方法會就地修改模組。
- 返回:
自身
- 返回型別:
Module
- forward(*args, **kwargs)¶
定義每次呼叫時執行的計算。
應由所有子類覆蓋。
注意
儘管 forward 傳遞的實現需要在函式內部定義，但之後應呼叫
Module例項而不是直接呼叫此函式，因為前者會處理執行已註冊的鉤子，而後者會靜默忽略它們。
- property full_action_spec: Composite¶
完整的 action 規範。
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 規範。
full_done_spec是一個Composite`例項，包含所有 done 條目。它可用於生成結構模仿執行時獲得的結構的 fake 資料。示例
>>> 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 規範。
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 規範。
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指定的緩衝區（如果存在），否則丟擲錯誤。有關此方法功能的更詳細說明以及如何正確指定
target，請參閱get_submodule的文件字串。- 引數:
target – 要查詢的緩衝區的完全限定字串名稱。（關於如何指定完全限定字串，請參閱
get_submodule。）- 返回:
由
target引用的緩衝區- 返回型別:
- 丟擲:
AttributeError – 如果 target 字串引用了無效路徑或解析結果不是緩衝區
- get_extra_state() Any¶
返回要包含在模組 state_dict 中的任何額外狀態。
如果需要儲存額外狀態，請為您的模組實現此函式以及相應的
set_extra_state()函式。構建模組的 state_dict() 時會呼叫此函式。請注意，額外狀態應是可 picklable 的，以確保 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¶
輸入規範 (Input spec)。
包含所有環境輸入資料規範的組合規範。
它包含
“full_action_spec”: 輸入 action 的規範
“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 (整型, 可選) – 如果指定，所有引數將被複制到該裝置
- 返回:
自身
- 返回型別:
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 (字典) – 一個包含引數和持久緩衝區的字典。
strict (布林型, 可選) – 是否嚴格要求
state_dict中的鍵與此模組的state_dict()函式返回的鍵匹配。預設值:Trueassign (bool, optional) – 設定為
False時，保留當前模組中張量的屬性，而設定為True時，保留 state dict 中的張量屬性。唯一的例外是requires_grad欄位。(預設值:False)
- 返回:
- missing_keys 是一個 str 列表，包含此模組預期
但提供的
state_dict中缺失的所有鍵。
- unexpected_keys 是一個 str 列表，包含此模組不預期
但提供的
state_dict中存在的所有鍵。
- 返回型別:
NamedTuple，包含missing_keys和unexpected_keys欄位
注意
如果某個引數或緩衝區註冊為
None，並且其對應的鍵存在於state_dict中，則load_state_dict()將引發RuntimeError。
- maybe_reset(tensordict: TensorDictBase) TensorDictBase¶
檢查輸入 tensordict 的 done 鍵，並在環境已結束（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 (整型, 可選) – 如果指定，所有引數將被複制到該裝置
- 返回:
自身
- 返回型別:
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¶
觀察規範（Observation spec）。
必須是
torchrl.data.Composite例項。規範中列出的鍵在 reset 和 step 後可直接訪問。在 TorchRL 中，即使它們嚴格來說不是“觀察”，來自環境的所有 info、state、轉換結果等輸出都儲存在
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: TensorDictBase | None = None)¶
根據 action\_spec 屬性執行隨機動作。
- 引數:
tensordict (TensorDictBase, optional) – 應寫入結果動作的 tensordict。
- 返回:
一個 tensordict 物件，其 “action” 條目已使用 action-spec 中的隨機樣本更新。
- rand_step(tensordict: TensorDictBase | None = None) TensorDictBase¶
根據 action\_spec 屬性在環境中執行隨機步進。
- 引數:
tensordict (TensorDictBase, optional) – 應寫入結果資訊的 tensordict。
- 返回:
一個 tensordict 物件，包含在環境中隨機步進後的新觀察。動作將儲存在 “action” 鍵下。
- read_action(action)[source]¶
讀取從輸入 TensorDict 獲取的動作，並將其轉換為內部環境期望的格式。
- 引數:
action (Tensor or TensorDict) – 要在環境中執行的動作。
Returns: 與內部環境相容的動作格式。
- read_done(terminated: bool | None = None, truncated: bool | None = None, done: bool | None = None) Tuple[bool | np.ndarray, bool | np.ndarray, bool | np.ndarray, bool][source]¶
Done 狀態讀取器。
在 torchrl 中，“done” 訊號意味著軌跡已到達終點，可能是因為中斷或終止。Truncated 意味著回合提前被中斷。Terminated 意味著任務完成，回合結束。
- 引數:
terminated (np.ndarray, boolean or other format) – 從環境獲取的完成狀態。
"terminated"等同於 gymnasium 中的"termination"：表示環境已到達回合終點，此後任何資料應視為無意義。預設為None。truncated (bool or None) – 提前截斷訊號。預設為
None。done (bool or None) – 軌跡結束訊號。對於未明確指定
"done"條目是指"terminated"還是"truncated"的 envs，此值應作為備選值。預設為None。
Returns: 包含 4 個布林值/張量值的元組，
一個 terminated 狀態，
一個 truncated 狀態，
一個 done 狀態，
一個布林值，指示是否應中斷 frame\_skip 迴圈。
- read_obs(observations: Union[Dict[str, Any], Tensor, ndarray]]) Dict[str, Any][source]¶
讀取環境中的觀察結果，並返回與輸出 TensorDict 相容的觀察結果。
- 引數:
observations (observation under a format dictated by the inner env) – 要讀取的觀察結果。
- read_reward(reward)[source]¶
讀取 reward 並將其對映到 reward 空間。
- 引數:
reward (torch.Tensor or TensorDict) – 要對映的 reward。
- register_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor], Union[None, Tuple[Tensor, ...],Tensor]]) RemovableHandle¶
在模組上註冊一個反向鉤子（backward hook）。
此函式已被棄用，請優先使用
register_full_backward_hook()。此函式的行為將在未來版本中改變。- 返回:
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子。- 返回型別:
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 or 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 hook）。
每次
forward()計算輸出後，都會呼叫此鉤子。如果
with_kwargs為False或未指定，輸入僅包含提供給模組的位置引數。關鍵字引數不會傳遞給鉤子，只會傳遞給forward。鉤子可以修改輸出。它可以原地修改輸入，但由於它在forward()呼叫後被呼叫，因此不會影響 forward。鉤子應具有以下簽名hook(module, args, output) -> None or modified output
如果
with_kwargs為True，前向鉤子將接收傳遞給 forward 函式的kwargs，並應返回可能已修改的輸出。鉤子應具有以下簽名hook(module, args, kwargs, output) -> None or modified output
- 引數:
hook (Callable) – 要註冊的使用者自定義鉤子。
prepend (bool) – 如果為
True，則提供的hook將在此torch.nn.modules.Module上所有現有forward鉤子之前觸發。否則，提供的hook將在此torch.nn.modules.Module上所有現有forward鉤子之後觸發。請注意，使用register_module_forward_hook()註冊的全域性forward鉤子將在所有透過此方法註冊的鉤子之前觸發。預設值:False。with_kwargs (bool) – 如果
True，則hook將接收傳遞給 forward 函式的 kwargs。預設值：Falsealways_call (bool) – 如果
True，則無論在呼叫 Module 時是否引發異常，都會執行hook。預設值：False
- 返回:
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_forward_pre_hook(hook: Union[Callable[[T, Tuple[Any, ...]], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any]], Optional[Tuple[Any, Dict[str, Any]]]]], *, prepend: bool = False, with_kwargs: bool = False) RemovableHandle¶
在模組上註冊一個前向預鉤子。
每次呼叫
forward()之前，都會呼叫該鉤子。如果
with_kwargs為 false 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給鉤子，僅傳遞給forward函式。鉤子可以修改輸入。使用者可以在鉤子中返回一個元組或一個修改後的單一值。如果返回單一值（除非該值本身已經是一個元組），我們會將其包裝到一個元組中。鉤子的簽名應如下所示：hook(module, args) -> None or modified input
如果
with_kwargs為 true，前向預鉤子將接收傳遞給 forward 函式的 kwargs。如果鉤子修改了輸入，則應同時返回 args 和 kwargs。鉤子的簽名應如下所示：hook(module, args, kwargs) -> None or a tuple of modified input and kwargs
- 引數:
hook (Callable) – 要註冊的使用者自定義鉤子。
prepend (bool) – 如果為 true，則提供的
hook將在此torch.nn.modules.Module上所有現有forward_pre鉤子之前觸發。否則，提供的hook將在此torch.nn.modules.Module上所有現有forward_pre鉤子之後觸發。請注意，使用register_module_forward_pre_hook()註冊的全域性forward_pre鉤子將在透過此方法註冊的所有鉤子之前觸發。預設值：Falsewith_kwargs (bool) – 如果為 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¶
在模組上註冊一個反向鉤子（backward hook）。
每次計算相對於模組的梯度時，都會呼叫該鉤子，也就是說，僅當計算相對於模組輸出的梯度時，該鉤子才會執行。鉤子的簽名應如下所示：
hook(module, grad_input, grad_output) -> tuple(Tensor) or None
grad_input和grad_output是分別包含相對於輸入和輸出的梯度的元組。鉤子不應修改其引數，但可以選擇返回一個新的相對於輸入的梯度，該梯度將在後續計算中用於替換grad_input。grad_input僅對應於作為位置引數給出的輸入，所有 kwarg 引數都被忽略。對於所有非 Tensor 引數，grad_input和grad_output中的條目將為None。出於技術原因，將此鉤子應用於 Module 時，傳遞給 Module 的每個 Tensor 的 forward 函式將接收一個檢視。同樣，呼叫方將接收 Module 的 forward 函式返回的每個 Tensor 的檢視。
警告
使用反向鉤子時，不允許就地修改輸入或輸出，否則將引發錯誤。
- 引數:
hook (Callable) – 要註冊的使用者自定義鉤子。
prepend (bool) – 如果為 true，則提供的
hook將在此torch.nn.modules.Module上所有現有backward鉤子之前觸發。否則，提供的hook將在此torch.nn.modules.Module上所有現有backward鉤子之後觸發。請注意，使用register_module_full_backward_hook()註冊的全域性backward鉤子將在透過此方法註冊的所有鉤子之前觸發。
- 返回:
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_full_backward_pre_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) RemovableHandle¶
在模組上註冊一個反向預鉤子。
每次計算模組的梯度時，都會呼叫該鉤子。鉤子的簽名應如下所示：
hook(module, grad_output) -> tuple[Tensor] or None
grad_output是一個元組。鉤子不應修改其引數，但可以選擇返回一個新的相對於輸出的梯度，該梯度將在後續計算中用於替換grad_output。對於所有非 Tensor 引數，grad_output中的條目將為None。出於技術原因，將此鉤子應用於 Module 時，傳遞給 Module 的每個 Tensor 的 forward 函式將接收一個檢視。同樣，呼叫方將接收 Module 的 forward 函式返回的每個 Tensor 的檢視。
警告
使用反向鉤子時，不允許就地修改輸入，否則將引發錯誤。
- 引數:
hook (Callable) – 要註冊的使用者自定義鉤子。
prepend (bool) – 如果為 true，則提供的
hook將在此torch.nn.modules.Module上所有現有backward_pre鉤子之前觸發。否則，提供的hook將在此torch.nn.modules.Module上所有現有backward_pre鉤子之後觸發。請注意，使用register_module_full_backward_pre_hook()註冊的全域性backward_pre鉤子將在透過此方法註冊的所有鉤子之前觸發。
- 返回:
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子。- 返回型別:
torch.utils.hooks.RemovableHandle
- classmethod register_gym(id: str, *, entry_point: Callable | None = None, transform: Transform | None = None, info_keys: list[NestedKey] | None = None, backend: str = None, to_numpy: bool = False, reward_threshold: float | None = None, nondeterministic: bool = False, max_episode_steps: int | None = None, order_enforce: bool = True, autoreset: bool = False, disable_env_checker: bool = False, apply_api_compatibility: bool = False, **kwargs)¶
在 gym(nasium) 中註冊環境。
此方法設計考慮了以下目標：
在使用 Gym 的框架中整合 TorchRL-first 環境；
在使用 Gym 的框架中整合其他環境（例如，DeepMind Control、Brax、Jumanji 等）。
- 引數:
id (str) – 環境的名稱。應遵循 gym 命名約定。
- 關鍵字引數:
entry_point (callable, optional) –
構建環境的入口點。如果未傳入，將使用父類作為入口點。通常，這用於註冊不一定繼承自所用基類的環境。
>>> from torchrl.envs import DMControlEnv >>> DMControlEnv.register_gym("DMC-cheetah-v0", env_name="cheetah", task="run") >>> # equivalently >>> EnvBase.register_gym("DMC-cheetah-v0", entry_point=DMControlEnv, env_name="cheetah", task="run")
transform (torchrl.envs.Transform) – 用於環境的變換（或
torchrl.envs.Compose例項中的變換列表）。此引數可在呼叫make()時傳遞（參見下面的示例）。info_keys (List[NestedKey], optional) –
如果提供，這些鍵將用於構建 info 字典，並從觀察鍵中排除。此引數可在呼叫
make()時傳遞（參見下面的示例）。警告
在使用
info_keys時，可能會導致 spec 為空，因為內容已移至 info 字典。Gym 不喜歡 spec 中的空Dict，因此應使用RemoveEmptySpecs刪除此空內容。backend (str, optional) – 後端。可以是 “gym” 或 “gymnasium”，或任何其他與
set_gym_backend相容的後端。to_numpy (bool, optional) – 如果為
True，則對 step 和 reset 的呼叫結果將被對映到 numpy 陣列。預設為False（結果為 tensors）。此引數可在呼叫make()時傳遞（參見下面的示例）。reward_threshold (
float, optional) – [Gym kwarg] 達到已學習環境所需的獎勵閾值。nondeterministic (bool, optional) – [Gym kwarg] 如果環境是非確定性的（即使知道初始種子和所有動作）。預設為
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引數對哪些內容應被視為觀察，哪些內容應被視為 info 進行精細控制。示例
>>> # Register the "cheetah" env from DMControl with the "run" task >>> from torchrl.envs import DMControlEnv >>> import torch >>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gym", env_name="cheetah", task_name="run") >>> import gym >>> envgym = gym.make("DMC-cheetah-v0") >>> envgym.seed(0) >>> torch.manual_seed(0) >>> envgym.reset() ({'position': tensor([-0.0855, 0.0215, -0.0881, -0.0412, -0.1101, 0.0080, 0.0254, 0.0424], dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03, 3.3842e-02, 2.5338e-02, 3.3064e-02, 1.0381e-04, 7.6656e-05, 1.0204e-02], dtype=torch.float64)}, {}) >>> envgym.step(envgym.action_space.sample()) ({'position': tensor([-0.0833, 0.0275, -0.0612, -0.0770, -0.1256, 0.0082, 0.0186, 0.0476], dtype=torch.float64), 'velocity': tensor([ 0.2221, 0.2256, 0.5930, 2.6937, -3.5865, -1.5479, 0.0187, -0.6825, 0.5224], dtype=torch.float64)}, tensor([0.0018], dtype=torch.float64), tensor([False]), tensor([False]), {}) >>> # same environment with observation stacked >>> from torchrl.envs import CatTensors >>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation")) >>> envgym.reset() ({'observation': tensor([-0.1005, 0.0335, -0.0268, 0.0133, -0.0627, 0.0074, -0.0488, -0.0353, -0.0075, -0.0069, 0.0098, -0.0058, 0.0033, -0.0157, -0.0004, -0.0381, -0.0452], dtype=torch.float64)}, {}) >>> # same environment with numpy observations >>> envgym = gym.make("DMC-cheetah-v0", transform=CatTensors(in_keys=["position", "velocity"], out_key="observation"), to_numpy=True) >>> envgym.reset() ({'observation': array([-0.11355747, 0.04257728, 0.00408397, 0.04155852, -0.0389733 , -0.01409826, -0.0978704 , -0.08808327, 0.03970837, 0.00535434, -0.02353762, 0.05116226, 0.02788907, 0.06848346, 0.05154399, 0.0371798 , 0.05128025])}, {}) >>> # If gymnasium is installed, we can register the environment there too. >>> DMControlEnv.register_gym("DMC-cheetah-v0", to_numpy=False, backend="gymnasium", env_name="cheetah", task_name="run") >>> import gymnasium >>> envgym = gymnasium.make("DMC-cheetah-v0") >>> envgym.seed(0) >>> torch.manual_seed(0) >>> envgym.reset() ({'position': tensor([-0.0855, 0.0215, -0.0881, -0.0412, -0.1101, 0.0080, 0.0254, 0.0424], dtype=torch.float64), 'velocity': tensor([ 1.9609e-02, -1.9776e-04, -1.6347e-03, 3.3842e-02, 2.5338e-02, 3.3064e-02, 1.0381e-04, 7.6656e-05, 1.0204e-02], dtype=torch.float64)}, {})
注意
此功能也適用於無狀態環境（例如，
BraxEnv）。>>> import gymnasium >>> import torch >>> from tensordict import TensorDict >>> from torchrl.envs import BraxEnv, SelectTransform >>> >>> # get action for dydactic purposes >>> env = BraxEnv("ant", batch_size=[2]) >>> env.set_seed(0) >>> torch.manual_seed(0) >>> td = env.rollout(10) >>> >>> actions = td.get("action") >>> >>> # register env >>> env.register_gym("Brax-Ant-v0", env_name="ant", batch_size=[2], info_keys=["state"]) >>> gym_env = gymnasium.make("Brax-Ant-v0") >>> gym_env.seed(0) >>> torch.manual_seed(0) >>> >>> gym_env.reset() >>> obs = [] >>> for i in range(10): ... obs, reward, terminated, truncated, info = gym_env.step(td[..., i].get("action"))
- register_load_state_dict_post_hook(hook)¶
註冊一個在模組的
load_state_dict()呼叫後執行的後鉤子。- 其簽名應如下所示：
hook(module, incompatible_keys) -> None
module引數是註冊此鉤子的當前模組，incompatible_keys引數是一個NamedTuple，包含missing_keys和unexpected_keys屬性。missing_keys是一個包含缺失鍵的list，unexpected_keys是一個包含未預期鍵的list。如果需要，可以就地修改給定的 incompatible_keys。
請注意，呼叫
load_state_dict()並設定strict=True時執行的檢查會受到鉤子對missing_keys或unexpected_keys所做修改的影響，這是預期的行為。向任意一組鍵新增內容都會在strict=True時導致丟擲錯誤，而清除缺失鍵和未預期鍵則可以避免錯誤。- 返回:
一個控制代碼，可以透過呼叫
handle.remove()來移除新增的鉤子。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_load_state_dict_pre_hook(hook)¶
註冊一個在模組的
load_state_dict()呼叫前執行的預鉤子。- 其簽名應如下所示：
hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950
- 引數:
hook (Callable) – 在載入狀態字典之前將呼叫的可呼叫鉤子。
- 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()方法註冊一個後鉤子。- 其簽名應如下所示：
hook(module, state_dict, prefix, local_metadata) -> None
註冊的鉤子可以就地修改
state_dict。
- register_state_dict_pre_hook(hook)¶
為
state_dict()方法註冊一個預鉤子。- 其簽名應如下所示：
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。- 返回:
自身
- 返回型別:
Module
- reset(tensordict: TensorDictBase | None = None, **kwargs) TensorDictBase¶
重置環境。
與 step 和 _step 一樣，只有私有方法
_reset應由 EnvBase 子類覆蓋。- 引數:
tensordict (TensorDictBase, optional) – 用於包含生成的新觀察的 tensordict。在某些情況下，此輸入也可用於向 reset 函式傳遞引數。
kwargs (optional) – 要傳遞給原生 reset 函式的其他引數。
- 返回:
一個tensordict（如果提供了輸入tensordict，則為輸入tensordict），會被原地修改幷包含結果觀測。
注意
reset 不應被
EnvBase子類覆寫。要修改的方法是_reset()。
- property reset_keys: list[tensordict._nestedkey.NestedKey]¶
返回一個重置鍵列表。
重置鍵是指示部分重置的鍵，用於批次、多工或多智慧體設定。它們的結構為
(*prefix, "_reset")，其中prefix是一個（可能為空的）字串元組，指向 tensordict 中可以找到“完成”狀態的某個位置。鍵按在資料樹中的深度排序。
- property reward_key¶
環境的獎勵鍵。
預設情況下，這將是“reward”。
如果環境中存在多個獎勵鍵，此函式將引發異常。
- property reward_keys: list[tensordict._nestedkey.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([]))
要檢索傳遞的完整 spec，請使用
>>> env.output_spec["full_reward_spec"]
此屬性是可變的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous)
- property reward_spec_unbatched: TensorSpec¶
返回環境的 reward 規範，就像它沒有批處理維度一樣。
- rollout(max_steps: int, policy: Callable[[TensorDictBase], TensorDictBase] | None = None, callback: Callable[[TensorDictBase, ...], Any] | None = None, *, auto_reset: bool = True, auto_cast_to_device: bool =False, break_when_any_done: bool | None =None, break_when_all_done: bool | None =None, return_contiguous: bool | None =False, tensordict: TensorDictBase | None = None, set_truncated: bool =False, out=None, trust_policy: bool =False) TensorDictBase¶
在環境中執行一次 Rollout。
當任何包含的環境到達任一“完成”狀態時，函式將立即返回。
- 引數:
max_steps (int) – 要執行的最大步數。如果在執行 max_steps 之前環境達到“完成”狀態，實際步數可能更少。
policy (可呼叫物件, 可選) – 用於計算期望動作的可呼叫物件。如果未提供策略，將使用
env.rand_step()計算動作。策略可以是任何可呼叫物件，它可以讀取 tensordict 或按照env.observation_spec.keys()**排序**的完整觀測條目序列。 預設為 None。callback (Callable[[TensorDict], Any], 可選) – 在每次迭代時使用給定的 TensorDict 呼叫的函式。預設為
None。callback的輸出不會被收集，如果資料需要在rollout呼叫之外保留，使用者有責任在 callback 呼叫內部儲存任何結果。
- 關鍵字引數:
auto_reset (bool, 可選) – 如果為
True，包含的環境將在開始 Rollout 前重置。如果為False，則 Rollout 將從之前的狀態繼續，這需要將帶有之前 Rollout 結果的tensordict引數傳入。預設為True。auto_cast_to_device (bool, 可選) – 如果為
True，在使用策略之前，tensordict 的裝置將自動轉換為策略的裝置。預設為False。break_when_any_done (bool) – 如果為
True，當任何包含的環境到達任一“完成”狀態時中斷。如果為False，則已完成的環境將自動重置。預設為True。break_when_all_done (bool, 可選) – 如果為
True，如果所有包含的環境都到達任一“完成”狀態時中斷。如果為False，如果至少一個環境到達任一“完成”狀態時中斷。預設為False。return_contiguous (bool) – 如果為 False，將返回一個 LazyStackedTensorDict。如果環境沒有動態規範，預設為 True，否則為 False。
tensordict (TensorDict, 可選) – 如果
auto_reset為 False，必須提供一個初始 tensordict。Rollout 將檢查此 tensordict 是否帶有“完成”標誌，並在需要時在相應維度上重置環境。如果tensordict是 reset 的輸出，通常不會發生這種情況，但如果tensordict是之前 Rollout 的最後一步，則可能發生。即使auto_reset=True，也可以提供tensordict，如果需要將元資料傳遞給reset方法，例如無狀態環境的批次大小或裝置。set_truncated (bool, 可選) – 如果為
True，在 Rollout 完成後，"truncated"和"done"鍵將被設定為True。如果在done_spec中找不到"truncated"鍵，將引發異常。可以透過env.add_truncated_keys設定截斷鍵。預設為False。trust_policy (bool, 可選) – 如果為
True，非 TensorDictModule 策略將被信任並被視為與收集器相容。對於 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)
在某些情況下，無法獲得 contiguous tensordict，因為它們無法堆疊。這可能發生在每一步返回的資料具有不同形狀時，或當不同的環境一起執行時。在這種情況下，設定
return_contiguous=False將使返回的 tensordict 成為 tensordict 的一個懶載入堆疊（lazy stack）。- 非 contiguous Rollout 的示例
>>> rollout = env.rollout(4, return_contiguous=False) >>> print(rollout) LazyStackedTensorDict( fields={ action: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False), done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: LazyStackedTensorDict( fields={ done: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 4]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([3, 4, 3]), device=cpu, dtype=torch.float32, is_shared=False), step_count: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.int64, is_shared=False), truncated: Tensor(shape=torch.Size([3, 4, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([3, 4]), device=cpu, is_shared=False) >>> print(rollout.names) [None, 'time']
Rollout 可以在迴圈中使用以模擬資料收集。為此，你需要在對之前 Rollout 的最後一個 tensordict 呼叫
step_mdp()之後，將其作為輸入傳遞。- 資料收集 Rollout 的示例
>>> from torchrl.envs import GymEnv, step_mdp >>> env = GymEnv("CartPole-v1") >>> epochs = 10 >>> input_td = env.reset() >>> for i in range(epochs): ... rollout_td = env.rollout( ... max_steps=100, ... break_when_any_done=False, ... auto_reset=False, ... tensordict=input_td, ... ) ... input_td = step_mdp( ... rollout_td[..., -1], ... )
- set_extra_state(state: Any) None¶
設定載入的 state_dict 中包含的額外狀態。
此函式由
load_state_dict()呼叫，用於處理在 state_dict 中找到的任何額外狀態。如果你的模組需要在 state_dict 中儲存額外狀態，請實現此函式和相應的get_extra_state()函式。- 引數:
state (dict) – 來自 state_dict 的額外狀態
- set_info_dict_reader(info_dict_reader: BaseInfoDictReader | None = None, ignore_private: bool =True) GymLikeEnv[source]¶
設定一個 info_dict_reader 函式。
此函式應將一個 info_dict 字典以及 step 函式返回的 tensordict 作為輸入，並以特定方式將值從一個寫入另一個。
- 引數:
info_dict_reader (Callable[[Dict], TensorDict], 可選) – 一個可呼叫物件，接收輸入字典和輸出 tensordict 作為引數。此函式應原地修改 tensordict。如果未提供，將使用
default_info_dict_reader。ignore_private (bool, 可選) – 如果為
True，則會忽略私有資訊（以下劃線開頭）。預設為True。
返回值：已註冊 dict_reader 的同一個環境例項。
注意
自動註冊 info_dict reader 應透過
auto_register_info_dict()完成，這將確保環境規範（env specs）得到正確構建。示例
>>> from torchrl.envs import default_info_dict_reader >>> from torchrl.envs.libs.gym import GymWrapper >>> reader = default_info_dict_reader(["my_info_key"]) >>> # assuming "some_env-v0" returns a dict with a key "my_info_key" >>> env = GymWrapper(gym.make("some_env-v0")).set_info_dict_reader(info_dict_reader=reader) >>> tensordict = env.reset() >>> tensordict = env.rand_step(tensordict) >>> assert "my_info_key" in tensordict.keys()
- set_seed(seed: int | None = None, static_seed: bool =False) int | None¶
設定環境的隨機種子，並返回下一個要使用的種子（如果只有一個環境存在，則為輸入的種子）。
- 引數:
seed (int) – 要設定的隨機種子。種子只在環境內部區域性設定。要處理全域性種子，請參閱
manual_seed()。static_seed (bool, 可選) – 如果為
True，種子不會遞增。預設為 False。
- 返回:
即如果與此環境同時建立，應為另一個環境使用的種子。
- 返回型別:
表示“下一個種子”的整數。
- set_spec_lock_(mode: bool =True) EnvBase¶
鎖定或解鎖環境的規範（specs）。
- 引數:
mode (bool) – 是否鎖定（True）或解鎖（False）規範（specs）。預設為 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 – 如果目標字串為空。
AttributeError – 如果 target 字串引用了無效路徑或解析結果不是
nn.Module
- property shape¶
等同於
batch_size。
- property specs: Composite¶
返回一個 Composite 容器，其中包含環境的所有規範。
此功能允許使用者建立一個環境，在單個數據容器中檢索所有規範，然後從工作空間中移除該環境。
- state_dict(*args, destination=None, prefix='', keep_vars=False)¶
返回一個包含指向模組整個狀態的引用的字典。
引數和持久緩衝區（例如，執行平均值）都包含在內。鍵是對應的引數名和緩衝區名。設定為
None的引數和緩衝區不包含在內。注意
返回的物件是一個淺複製。它包含指向模組引數和緩衝區的引用。
警告
當前
state_dict()也接受位置引數，用於destination、prefix和keep_vars，按順序排列。但是，這正在被棄用，並且在未來的版本中將強制使用關鍵字引數。警告
請避免使用引數
destination，因為它並非為終端使用者設計。- 引數:
destination (dict, 可選) – 如果提供，模組的狀態將更新到該字典中並返回該字典物件。否則，將建立一個
OrderedDict並返回。預設值：None。prefix (str, 可選) – 新增到引數名和緩衝區名的字首，用於組成 state_dict 中的鍵。預設值：
''。keep_vars (bool, 可選) – 預設情況下，state_dict 中返回的
Tensor會從 autograd 分離。如果設定為True，則不會執行分離。預設值：False。
- 返回:
一個包含模組完整狀態的字典
- 返回型別:
dict
示例
>>> # xdoctest: +SKIP("undefined vars") >>> module.state_dict().keys() ['bias', 'weight']
- property state_keys: list[tensordict._nestedkey.NestedKey]¶
環境的狀態鍵。
預設情況下，只有一個名為“state”的鍵。
鍵按在資料樹中的深度排序。
- property state_spec: Composite¶
狀態規範（State spec）。
必須是
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¶
返回環境的 state 規範，就像它沒有批處理維度一樣。
- step(tensordict: TensorDictBase) TensorDictBase¶
在環境中執行一步。
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]¶
在環境中執行一個步驟，並在需要時（部分地）重置環境。
- 引數:
tensordict (TensorDictBase) – 用於
step()方法的輸入資料結構。
此方法可以輕鬆編寫不停止的 rollout 函式。
示例
>>> from torchrl.envs import ParallelEnv, GymEnv >>> def rollout(env, n): ... data_ = env.reset() ... result = [] ... for i in range(n): ... data, data_ = env.step_and_maybe_reset(data_) ... result.append(data) ... return torch.stack(result) >>> env = ParallelEnv(2, lambda: GymEnv("CartPole-v1")) >>> print(rollout(env, 2)) TensorDict( fields={ done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), next: TensorDict( fields={ done: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False), reward: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([2, 2]), device=cpu, is_shared=False), observation: Tensor(shape=torch.Size([2, 2, 4]), device=cpu, dtype=torch.float32, is_shared=False), terminated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False), truncated: Tensor(shape=torch.Size([2, 2, 1]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([2, 2]), device=cpu, is_shared=False)
- step_mdp(next_tensordict: TensorDictBase) TensorDictBase¶
使用提供的 next_tensordict 將環境狀態向前推進一步。
此方法透過從當前狀態遷移到由 next_tensordict 定義的下一個狀態來更新環境的狀態。結果的tensordict包含更新的觀測以及任何其他相關的狀態資訊，其鍵根據環境的規範進行管理。
在內部，此方法利用預計算的
_StepMDP例項來高效地處理狀態、觀測、動作、獎勵和完成鍵的轉換。_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¶
移動和/或轉換（cast）引數和緩衝區。
可以按如下方式呼叫：
- 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。此外，此方法只會將浮點或複數引數和緩衝區轉換（cast）為dtype（如果給定）。整數引數和緩衝區如果給定device，則會被移動到該裝置，但 dtype 不變。當設定non_blocking時，如果可能，它會嘗試相對於主機非同步地進行轉換/移動，例如，將具有 pinned memory 的 CPU Tensor 移動到 CUDA 裝置。請參閱下面的示例。
注意
此方法會就地修改模組。
- 引數:
device (
torch.device) – 此模組中引數和緩衝區的目標裝置dtype (
torch.dtype) – 此模組中引數和緩衝區的目標浮點或複數 dtypetensor (torch.Tensor) – 一個 Tensor，其 dtype 和 device 是此模組中所有引數和緩衝區的目標 dtype 和 device
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¶
將引數和緩衝區移動到指定裝置，而不復制儲存（storage）。
- 引數:
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¶
將所有引數和緩衝區轉換（cast）為
dst_type。注意
此方法會就地修改模組。
- 引數:
dst_type (type 或 string) – 目標型別
- 返回:
自身
- 返回型別:
Module
- xpu(device: Optional[Union[int, device]] = None) T¶
將所有模型引數和緩衝區移動到 XPU。
這也會使相關的引數和緩衝區成為不同的物件。因此，如果模組在 XPU 上執行並進行最佳化，應在構造最佳化器之前呼叫此方法。
注意
此方法會就地修改模組。
- 引數:
device (整型, 可選) – 如果指定，所有引數將被複制到該裝置
- 返回:
自身
- 返回型別:
Module
- zero_grad(set_to_none: bool = True) None¶
重置所有模型引數的梯度。
有關更多上下文，請參閱
torch.optim.Optimizer下的類似函式。- 引數:
set_to_none (bool) – 不設定為零，而是將梯度設定為 None。有關詳細資訊，請參閱
torch.optim.Optimizer.zero_grad()。
