ChessEnv¶
- class torchrl.envs.ChessEnv(*args, **kwargs)[source]¶
遵循 TorchRL API 的國際象棋環境。
此環境使用 chess 庫模擬國際象棋遊戲。它支援多種狀態表示，並且可以配置為包含不同型別的觀察，例如 SAN、FEN、PGN 和合法移動。
需要：chess 庫。更多資訊請見此處。
- 引數:
stateful (bool) – 是否跟蹤棋盤的內部狀態。如果為 False，狀態將儲存在觀察中，並在每次呼叫時傳回環境。預設值：
True。include_san (bool) –
是否在觀察中包含 SAN（標準代數記譜法）。預設值：
False。注意
對應於 rollout[“action”] 的 “san” 條目將在 rollout[“next”, “san”] 中找到，而根目錄 rollout[“san”] 中的值將對應於同一索引操作之前的 san 值。
include_fen (bool) – 是否在觀察中包含 FEN（福賽斯-愛德華茲記譜法）。預設值：
False。include_pgn (bool) – 是否在觀察中包含 PGN（可移植遊戲記譜法）。預設值：
False。include_legal_moves (bool) – 是否在觀察中包含合法移動。預設值：
False。include_hash (bool) – 是否在環境中包含雜湊變換。預設值：
False。mask_actions (bool) – 如果為
True，則會將ActionMask變換附加到環境中，以確保動作被正確掩碼。預設值：True。pixels (bool) – 是否包含基於畫素的棋盤觀察。預設值：
False。
注意
動作規範是一個
Categorical，其動作數量等於所有可能的 SAN 移動數量。動作空間被構造為所有可能的 SAN 移動上的分類分佈，其中合法移動是此空間的子集。環境使用掩碼來確保只選擇合法移動。示例
>>> import torch >>> from torchrl.envs import ChessEnv >>> _ = torch.manual_seed(0) >>> env = ChessEnv(include_fen=True, include_san=True, include_pgn=True, include_legal_moves=True) >>> print(env) TransformedEnv( env=ChessEnv(), transform=ActionMask(keys=['action', 'action_mask'])) >>> r = env.reset() >>> print(env.rand_step(r)) TensorDict( fields={ action: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.int64, is_shared=False), action_mask: Tensor(shape=torch.Size([29275]), device=cpu, dtype=torch.bool, is_shared=False), done: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False), fen: NonTensorData(data=rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1, batch_size=torch.Size([]), device=None), legal_moves: Tensor(shape=torch.Size([219]), device=cpu, dtype=torch.int64, is_shared=False), next: TensorDict( fields={ action_mask: Tensor(shape=torch.Size([29275]), device=cpu, dtype=torch.bool, is_shared=False), done: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False), fen: NonTensorData(data=rnbqkbnr/pppppppp/8/8/5P2/8/PPPPP1PP/RNBQKBNR b KQkq - 0 1, batch_size=torch.Size([]), device=None), legal_moves: Tensor(shape=torch.Size([219]), device=cpu, dtype=torch.int64, is_shared=False), pgn: NonTensorData(data=[Event "?"] [Site "?"] [Date "????.??.??"] [Round "?"] [White "?"] [Black "?"] [Result "*"]
1. f4 *, batch_size=torch.Size([]), device=None), reward: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, is_shared=False), san: NonTensorData(data=f4, batch_size=torch.Size([]), device=None), terminated: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False), turn: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.bool, is_shared=False)},
batch_size=torch.Size([]), device=None, is_shared=False),
pgn: NonTensorData(data=[Event “?”] [Site “?”] [Date “????.??.??”] [Round “?”] [White “?”] [Black “?”] [Result “*”]
*, batch_size=torch.Size([]), device=None), san: NonTensorData(data=<start>, batch_size=torch.Size([]), device=None), terminated: Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.bool, is_shared=False), turn: Tensor(shape=torch.Size([]), device=cpu, dtype=torch.bool, is_shared=False)},
batch_size=torch.Size([]), device=None, is_shared=False)
>>> print(env.rollout(1000)) TensorDict( fields={ action: Tensor(shape=torch.Size([96]), device=cpu, dtype=torch.int64, is_shared=False), action_mask: Tensor(shape=torch.Size([96, 29275]), device=cpu, dtype=torch.bool, is_shared=False), done: Tensor(shape=torch.Size([96, 1]), device=cpu, dtype=torch.bool, is_shared=False), fen: NonTensorStack( ['rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQ..., batch_size=torch.Size([96]), device=None), legal_moves: Tensor(shape=torch.Size([96, 219]), device=cpu, dtype=torch.int64, is_shared=False), next: TensorDict( fields={ action_mask: Tensor(shape=torch.Size([96, 29275]), device=cpu, dtype=torch.bool, is_shared=False), done: Tensor(shape=torch.Size([96, 1]), device=cpu, dtype=torch.bool, is_shared=False), fen: NonTensorStack( ['rnbqkbnr/pppppppp/8/8/8/5N2/PPPPPPPP/RNBQKB1R b ..., batch_size=torch.Size([96]), device=None), legal_moves: Tensor(shape=torch.Size([96, 219]), device=cpu, dtype=torch.int64, is_shared=False), pgn: NonTensorStack( ['[Event "?"]\n[Site "?"]\n[Date "????.??.??"]\n[R..., batch_size=torch.Size([96]), device=None), reward: Tensor(shape=torch.Size([96, 1]), device=cpu, dtype=torch.float32, is_shared=False), san: NonTensorStack( ['Nf3', 'Na6', 'c4', 'f6', 'h4', 'Rb8', 'Na3', 'Ra..., batch_size=torch.Size([96]), device=None), terminated: Tensor(shape=torch.Size([96, 1]), device=cpu, dtype=torch.bool, is_shared=False), turn: Tensor(shape=torch.Size([96]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([96]), device=None, is_shared=False), pgn: NonTensorStack( ['[Event "?"]\n[Site "?"]\n[Date "????.??.??"]\n[R..., batch_size=torch.Size([96]), device=None), san: NonTensorStack( ['<start>', 'Nf3', 'Na6', 'c4', 'f6', 'h4', 'Rb8',..., batch_size=torch.Size([96]), device=None), terminated: Tensor(shape=torch.Size([96, 1]), device=cpu, dtype=torch.bool, is_shared=False), turn: Tensor(shape=torch.Size([96]), device=cpu, dtype=torch.bool, is_shared=False)}, batch_size=torch.Size([96]), device=None, is_shared=False)
- property action_key: NestedKey¶
環境的動作鍵。
預設情況下，這將是“action”。
如果環境中存在多個動作鍵，此函式將引發異常。
- property action_keys: list[tensordict._nestedkey.NestedKey]¶
環境的動作鍵列表。
預設情況下，只會有一個名為“action”的鍵。
鍵按資料樹中的深度排序。
- property action_spec: TensorSpec¶
動作規範。
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¶
從動作規範生成所有可能的動作。
這隻適用於具有完全離散動作的環境。
- 引數:
tensordict (TensorDictBase, optional) – 如果給定，則使用此 tensordict 呼叫
reset()。- 返回:
一個 tensordict 物件，其“action”條目已更新為一批所有可能的動作。這些動作在第一個維度上堆疊在一起。
- append_transform(transform: Transform | Callable[[TensorDictBase], TensorDictBase]) EnvBase¶
返回一個變換後的環境，其中應用了傳入的可呼叫物件/變換。
- 引數:
transform (Transform or Callable[[TensorDictBase], TensorDictBase]) – 要應用於環境的變換。
示例
>>> from torchrl.envs import GymEnv >>> import torch >>> env = GymEnv("CartPole-v1") >>> loc = 0.5 >>> scale = 1.0 >>> transform = lambda data: data.set("observation", (data.get("observation") - loc)/scale) >>> env = env.append_transform(transform=transform) >>> print(env) TransformedEnv( env=GymEnv(env=CartPole-v1, batch_size=torch.Size([]), device=cpu), transform=_CallableTransform(keys=[]))
- apply(fn: Callable[[Module], None]) T¶
將
fn遞迴應用於每個子模組（由.children()返回）以及自身。典型用法包括初始化模型的引數（另請參閱 torch.nn.init）。
- 引數:
fn (
Module-> None) – 要應用於每個子模組的函式- 返回:
self
- 返回型別:
Module
示例
>>> @torch.no_grad() >>> def init_weights(m): >>> print(m) >>> if type(m) == nn.Linear: >>> m.weight.fill_(1.0) >>> print(m.weight) >>> net = nn.Sequential(nn.Linear(2, 2), nn.Linear(2, 2)) >>> net.apply(init_weights) Linear(in_features=2, out_features=2, bias=True) Parameter containing: tensor([[1., 1.], [1., 1.]], requires_grad=True) Linear(in_features=2, out_features=2, bias=True) Parameter containing: tensor([[1., 1.], [1., 1.]], requires_grad=True) Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) )
- auto_specs_(policy: Callable[[TensorDictBase], TensorDictBase], *, tensordict: TensorDictBase | None = None, action_key: NestedKey | list[NestedKey] = 'action', done_key: NestedKey | list[NestedKey] | None = None, observation_key: NestedKey | list[NestedKey] = 'observation', reward_key: NestedKey | list[NestedKey] = 'reward')¶
根據使用給定策略進行的隨機 rollout 自動設定環境的規範 (specs)。
此方法使用提供的策略執行 rollout，以推斷環境的輸入和輸出規範。它根據 rollout 期間收集的資料更新環境關於動作、觀察、獎勵和完成訊號的規範。
- 引數:
policy (Callable[[TensorDictBase], TensorDictBase]) – 一個可呼叫策略，它接受 TensorDictBase 作為輸入，並返回 TensorDictBase 作為輸出。此策略用於執行 rollout 並確定規範。
- 關鍵字引數:
tensordict (TensorDictBase, optional) – 一個可選的 TensorDictBase 例項，用作 rollout 的初始狀態。如果未提供，將呼叫環境的 reset 方法來獲取初始狀態。
action_key (NestedKey or List[NestedKey], optional) – 用於在 TensorDictBase 中標識動作的鍵。預設為“action”。
done_key (NestedKey or List[NestedKey], optional) – 用於在 TensorDictBase 中標識完成訊號的鍵。預設為
None，此時將嘗試使用 [“done”, “terminated”, “truncated”] 作為潛在鍵。observation_key (NestedKey or List[NestedKey], optional) – 用於在 TensorDictBase 中標識觀察的鍵。預設為“observation”。
reward_key (NestedKey or List[NestedKey], optional) – 用於在 TensorDictBase 中標識獎勵的鍵。預設為“reward”。
- 返回:
具有更新規範的環境例項。
- 返回型別:
- 引發:
RuntimeError – 如果輸出規範中存在未在提供的鍵中考慮到的鍵。
- property batch_dims: int¶
環境的批處理維度數量。
- property batch_locked: bool¶
環境是否可以使用與初始化時不同的批處理大小。
如果為 True，環境需要與具有相同批處理大小的 tensordict 一起使用。batch_locked 是一個不可變屬性。
- property batch_size: Size¶
在此環境例項中打包的環境數量，組織為 torch.Size() 物件。
環境可能相似或不同，但假定它們之間很少（如果不是完全沒有）互動（例如，多工或並行批處理執行）。
- bfloat16() T¶
將所有浮點引數和緩衝區轉換為
bfloat16資料型別。注意
此方法就地修改模組。
- 返回:
self
- 返回型別:
Module
- buffers(recurse: bool = True) Iterator[Tensor]¶
返回模組緩衝區上的迭代器。
- 引數:
recurse (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, optional) – 一個包含計算基數所需資料的 tensordict。
- check_env_specs(return_contiguous: bool | None = None, check_dtype=True, seed: int | None = None, tensordict: TensorDictBase | None = None)¶
根據短時間 rollout 的結果測試環境規範。
此測試函式應用作對使用 torchrl 的 EnvBase 子類包裝的環境進行健全性檢查：預期資料與收集到的資料之間的任何差異都應引發斷言錯誤。
損壞的環境規範可能會導致無法使用並行環境。
- 引數:
env (EnvBase) – 需要根據資料檢查規範的環境。
return_contiguous (bool, optional) – 如果為
True，則隨機 rollout 將以 return_contiguous=True 呼叫。這在某些情況下（例如，輸入/輸出形狀異構）會失敗。預設為None（由動態規範的存在決定）。check_dtype (bool, optional) – 如果為 False，將跳過 dtype 檢查。預設為 True。
種子 (int, optional) – 為了重現性，可以設定一個種子。該種子將在 PyTorch 中臨時設定，然後隨機數生成器 (RNG) 狀態將恢復到之前的值。對於環境 (env)，我們會設定種子，但由於恢復隨機數生成器狀態並不是大多數環境的特性，我們將其留給使用者自行完成。預設為
None。tensordict (TensorDict, optional) – 用於重置的可選 tensordict 例項。
注意：此函式會重置環境種子。應將其“離線”使用，以檢查環境是否已充分構建，但它可能會影響實驗的種子設定，因此應避免在訓練指令碼中使用。
- compile(*args, **kwargs)¶
使用
torch.compile()編譯此模組的 forward 方法。此模組的 __call__ 方法被編譯，並且所有引數按原樣傳遞給
torch.compile()。有關此函式引數的詳細資訊，請參閱
torch.compile()。
- cpu() T¶
將所有模型引數和緩衝區移動到 CPU。
注意
此方法就地修改模組。
- 返回:
self
- 返回型別:
Module
- cuda(device: Optional[Union[int, device]] = None) T¶
將所有模型引數和緩衝區移動到 GPU。
這也會使相關的引數和緩衝區成為不同的物件。因此，如果模組將在 GPU 上進行最佳化，則應在構建最佳化器之前呼叫此方法。
注意
此方法就地修改模組。
- 引數:
device (int, optional) – 如果指定，所有引數將被複制到該裝置。
- 返回:
self
- 返回型別:
Module
- property done_key¶
環境的 done 鍵。
預設情況下，此鍵為“done”。
如果環境中存在多個 done 鍵，此函式將引發異常。
- property done_keys: list[tensordict._nestedkey.NestedKey]¶
環境的 done 鍵列表。
預設情況下，只會有一個名為“done”的鍵。
鍵按資料樹中的深度排序。
- property done_keys_groups¶
按 reset 鍵分組的 done 鍵列表。
這是一個列表的列表。外層列表的長度與 reset 鍵的數量相同，內層列表包含可以讀取的 done 鍵（例如 done 和 truncated），用於在 reset 鍵不存在時確定是否進行重置。
- property done_spec: TensorSpec¶
done規範。done_spec始終儲存為複合規範 (composite spec)。如果 done 規範提供的是簡單規範 (simple spec)，則返回此簡單規範。
>>> env.done_spec = Categorical(2, dtype=torch.bool) >>> env.done_spec Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
如果 done 規範提供的是複合規範 (composite spec) 且只包含一個葉節點 (leaf)，則此函式將只返回該葉節點。
>>> env.done_spec = Composite({"nested": {"done": Categorical(2, dtype=torch.bool)}}) >>> env.done_spec Categorical( shape=torch.Size([]), space=DiscreteBox(n=2), device=cpu, dtype=torch.bool, domain=discrete)
如果 done 規範提供的是複合規範 (composite spec) 且包含多個葉節點 (leaf)，則此函式將返回整個規範。
>>> 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資料型別。注意
此方法就地修改模組。
- 返回:
self
- 返回型別:
Module
- empty_cache()¶
清除所有快取值。
對於常規環境 (env)，鍵列表（如 reward, done 等）會被快取，但在某些情況下，它們可能在程式碼執行期間發生變化（例如，新增 transform 時）。
- eval() T¶
將模組設定為評估模式。
這僅對某些模組有影響。有關特定模組在訓練/評估模式下的行為詳情，即它們是否受影響，請參閱其文件，例如
Dropout、BatchNorm等。這等同於
self.train(False)。有關 .eval() 和幾個可能與之混淆的類似機制的比較，請參閱 本地停用梯度計算。
- 返回:
self
- 返回型別:
Module
- extra_repr() str¶
返回模組的額外表示。
要列印自定義的額外資訊，應在自己的模組中重新實現此方法。單行和多行字串均可接受。
- fake_tensordict() TensorDictBase¶
返回一個偽 (fake) tensordict，其鍵值對在形狀、裝置和資料型別上與環境 rollout 期間預期的結果一致。
- float() T¶
將所有浮點引數和緩衝區轉換為
float資料型別。注意
此方法就地修改模組。
- 返回:
self
- 返回型別:
Module
- forward(*args, **kwargs)¶
定義每次呼叫時執行的計算。
應被所有子類重寫。
注意
儘管前向傳播 (forward pass) 的邏輯需要在本函式中定義，但之後應該呼叫
Module例項而不是直接呼叫本函式，因為前者會處理已註冊的鉤子 (hooks)，而後者會默默忽略它們。
- property full_action_spec: Composite¶
完整的動作規範 (action spec)。
full_action_spec是一個Composite`例項，包含所有動作條目。示例
>>> from torchrl.envs import BraxEnv >>> for envname in BraxEnv.available_envs: ... break >>> env = BraxEnv(envname) >>> env.full_action_spec Composite( action: BoundedContinuous( shape=torch.Size([8]), space=ContinuousBox( low=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([8]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([]))
- property full_done_spec: Composite¶
完整的 done 規範 (done spec)。
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 spec)。
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¶
完整的狀態規範 (state spec)。
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 – 如果目標字串引用了無效路徑或解析到的物件不是緩衝區。
- get_extra_state() Any¶
返回要包含在模組 state_dict 中的任何額外狀態。
如果需要儲存額外狀態，請為您的模組實現此方法和相應的
set_extra_state()方法。構建模組的 state_dict() 時會呼叫此函式。請注意，額外狀態應該是可 pickle 化的，以確保 state_dict 的序列化正常工作。我們只提供對序列化 Tensor 的向後相容性保證；如果其他物件的 pickle 序列化形式發生變化，可能會破壞向後相容性。
- 返回:
要儲存在模組 state_dict 中的任何額外狀態
- 返回型別:
object
- get_legal_moves(tensordict=None, uci=False)[source]¶
列出當前局面 (position) 的合法移動。
要選擇其中一個動作，可以將“action”鍵設定為該移動在此列表中的索引。
- 引數:
tensordict (TensorDict, optional) – 包含局面 (position) 的 fen 字串的 Tensordict。如果不是 stateful (有狀態) 的，則必需。如果是 stateful (有狀態) 的，則忽略此引數，轉而使用環境的當前狀態。
uci (bool, optional) – 如果為
False，移動以 SAN 格式給出。如果為True，移動以 UCI 格式給出。預設為False。
- get_parameter(target: str) Parameter¶
如果存在由
target指定的引數，則返回該引數，否則丟擲錯誤。有關此方法的更詳細功能說明以及如何正確指定
target，請參閱get_submodule的文件字串。- 引數:
target – 要查詢的引數的完全限定字串名稱。（有關如何指定完全限定字串，請參閱
get_submodule。）- 返回:
由
target引用的引數- 返回型別:
torch.nn.Parameter
- 引發:
AttributeError – 如果目標字串引用了無效路徑或解析到的物件不是
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 – 如果目標字串引用了無效路徑或解析到的物件不是
nn.Module。
- half() T¶
將所有浮點引數和緩衝區轉換為
half資料型別。注意
此方法就地修改模組。
- 返回:
self
- 返回型別:
Module
- property input_spec: TensorSpec¶
輸入規範 (Input spec)。
包含所有輸入到環境的資料規範的複合規範。
它包含
“full_action_spec”：輸入動作的規範
“full_state_spec”：所有其他環境輸入的規範
此屬性被鎖定且應為只讀。相反，要設定其中包含的規範，請使用相應的屬性。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.input_spec Composite( full_state_spec: None, full_action_spec: Composite( action: BoundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([1]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
- ipu(device: Optional[Union[int, device]] = None) T¶
將所有模型引數和緩衝區移動到 IPU。
這也會使相關的引數和緩衝區成為不同的物件。因此，如果模組將在 IPU 上進行最佳化，則應在構建最佳化器之前呼叫此方法。
注意
此方法就地修改模組。
- 引數:
device (int, optional) – 如果指定，所有引數將被複制到該裝置。
- 返回:
self
- 返回型別:
Module
- 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 中張量的屬性。唯一的例外是的requires_grad欄位。預設值：``False`
- 返回:
- missing_keys 是一個包含所有預期鍵的字串列表。
但該模組需要而提供的
state_dict中缺失的鍵。
- unexpected_keys 是一個字串列表，包含不被
該模組需要但存在於提供的
state_dict中的鍵。
- 返回型別:
帶有
missing_keys和unexpected_keys欄位的NamedTuple
注意
如果引數或 buffer 被註冊為
None且其對應的鍵存在於state_dict中，則load_state_dict()將引發RuntimeError。
- maybe_reset(tensordict: TensorDictBase) TensorDictBase¶
檢查輸入 tensordict 的 done 鍵，並在必要時重置已完成的環境。
- 引數:
tensordict (TensorDictBase) – 來自
step_mdp()輸出的 tensordict。- 返回:
一個 tensordict 物件，對於未重置的環境部分與輸入相同，對於已重置的環境部分包含新的重置資料。
- modules() Iterator[Module]¶
返回網路中所有模組的迭代器。
- 生成:
Module – 網路中的一個模組
注意
重複的模組只返回一次。在下面的例子中，
l將只返回一次。示例
>>> l = nn.Linear(2, 2) >>> net = nn.Sequential(l, l) >>> for idx, m in enumerate(net.modules()): ... print(idx, '->', m) 0 -> Sequential( (0): Linear(in_features=2, out_features=2, bias=True) (1): Linear(in_features=2, out_features=2, bias=True) ) 1 -> Linear(in_features=2, out_features=2, bias=True)
- mtia(device: Optional[Union[int, device]] = None) T¶
將所有模型引數和 buffer 移動到 MTIA。
這也會使相關的引數和 buffer 成為不同的物件。因此，如果模組將在 MTIA 上最佳化，應在構建最佳化器之前呼叫此方法。
注意
此方法就地修改模組。
- 引數:
device (int, optional) – 如果指定，所有引數將被複制到該裝置。
- 返回:
self
- 返回型別:
Module
- named_buffers(prefix: str = '', recurse: bool =True, remove_duplicate: bool =True) Iterator[Tuple[str, Tensor]]¶
返回模組 buffer 的迭代器，同時產生 buffer 的名稱和 buffer 本身。
- 引數:
prefix (str) – 要新增到所有 buffer 名稱前面的字首。
recurse (bool, optional) – 如果為 True，則生成此模組及其所有子模組的 buffer。否則，僅生成此模組的直接成員的 buffer。預設為 True。
remove_duplicate (bool, optional) – 是否移除結果中的重複 buffer。預設為 True。
- 生成:
(str, torch.Tensor) – 包含名稱和 buffer 的元組
示例
>>> # 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¶
觀察 spec。
必須是
torchrl.data.Composite的例項。spec 中列出的鍵在 reset 和 step 後可以直接訪問。在 TorchRL 中，即使它們嚴格來說不是“觀察”，所有資訊 (info)、狀態 (states)、轉換結果 (results of transforms) 等來自環境的輸出都儲存在
observation_spec中。因此，
"observation_spec"應被視為一個通用資料容器，用於儲存非完成或獎勵資料的環境輸出。示例
>>> 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¶
輸出 spec。
包含環境輸出所有資料的複合 spec。
它包含
“full_reward_spec”：獎勵的 spec
“full_done_spec”：完成的 spec
“full_observation_spec”：所有其他環境輸出的 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 屬性在環境中執行隨機 step。
- 引數:
tensordict (TensorDictBase, optional) – 應該寫入結果資訊的 tensordict。
- 返回:
一個 tensordict 物件，其中包含在環境中隨機 step 後產生的新觀察。動作將儲存在“action”鍵下。
- register_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor], Union[None, Tuple[Tensor, ...], Tensor]]) RemovableHandle¶
在模組上註冊一個反向 hook。
此函式已棄用，建議使用
register_full_backward_hook()。此函式的行為將在未來版本中改變。- 返回:
一個控制代碼 (handle)，可以透過呼叫
handle.remove()來移除新增的 hook。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_buffer(name: str, tensor: Optional[Tensor], persistent: bool =True) None¶
向模組新增一個 buffer。
這通常用於註冊不應被視為模型引數的 buffer。例如，BatchNorm 的
running_mean不是引數，但它是模組狀態的一部分。預設情況下，buffer 是持久的，並且會與引數一起儲存。透過將persistent設定為False可以更改此行為。持久 buffer 和非持久 buffer 之間的唯一區別在於後者不會成為此模組的state_dict的一部分。Buffer 可以透過給定的名稱作為屬性訪問。
- 引數:
name (str) – buffer 的名稱。可以使用給定的名稱從該模組訪問 buffer。
tensor (Tensor or None) – 要註冊的 buffer。如果為
None，則在 buffer 上執行的操作（例如cuda）將被忽略。如果為None，則該 buffer 不會包含在模組的state_dict中。persistent (bool) – buffer 是否為此模組的
state_dict的一部分。
示例
>>> # xdoctest: +SKIP("undefined vars") >>> self.register_buffer('running_mean', torch.zeros(num_features))
- register_forward_hook(hook: Union[Callable[[T, Tuple[Any, ...], Any], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) RemovableHandle¶
在模組上註冊一個前向 hook。
每次
forward()計算出輸出後，都會呼叫該 hook。如果
with_kwargs為False或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hook，只會傳遞給forward。hook 可以修改輸出。它可以就地修改輸入，但不會影響 forward，因為 hook 是在forward()呼叫之後呼叫的。該 hook 應具有以下簽名：hook(module, args, output) -> None or modified output
如果
with_kwargs為True，則前向 hook 將會接收傳遞給 forward 函式的kwargs，並期望返回可能已被修改的輸出。該 hook 應具有以下簽名：hook(module, args, kwargs, output) -> None or modified output
- 引數:
hook (Callable) – 要註冊的使用者自定義 hook。
prepend (bool) – 如果為
True，則提供的hook將在此torch.nn.modules.Module上所有現有forwardhook 之前觸發。否則，提供的hook將在此torch.nn.modules.Module上所有現有forwardhook 之後觸發。請注意，使用register_module_forward_hook()註冊的全域性forwardhook 將在此方法註冊的所有 hook 之前觸發。預設為False。with_kwargs (bool) – 如果為
True，則hook將接收傳遞給 forward 函式的 kwargs。預設為False。always_call (bool) – 如果為
True，無論呼叫模組時是否發生異常，hook都將執行。預設為False。
- 返回:
一個控制代碼 (handle)，可以透過呼叫
handle.remove()來移除新增的 hook。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_forward_pre_hook(hook: Union[Callable[[T, Tuple[Any, ...]], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any]], Optional[Tuple[Any, Dict[str, Any]]]]], *, prepend: bool = False, with_kwargs: bool =False) RemovableHandle¶
在模組上註冊一個前向預處理 hook。
每次呼叫
forward()之前，都會呼叫該 hook。如果
with_kwargs為 false 或未指定，則輸入僅包含傳遞給模組的位置引數。關鍵字引數不會傳遞給 hook，只會傳遞給forward。hook 可以修改輸入。使用者可以在 hook 中返回一個元組或一個單獨的修改後的值。如果返回的是單個值（除非該值已經是元組），我們會將其包裝成一個元組。該 hook 應具有以下簽名：hook(module, args) -> None or modified input
如果
with_kwargs為 true，則前向預處理 hook 將會接收傳遞給 forward 函式的 kwargs。如果 hook 修改了輸入，則應返回 args 和 kwargs。該 hook 應具有以下簽名：hook(module, args, kwargs) -> None or a tuple of modified input and kwargs
- 引數:
hook (Callable) – 要註冊的使用者自定義 hook。
prepend (bool) – 如果為 true，則提供的
hook將在此torch.nn.modules.Module上所有現有forward_prehook 之前觸發。否則，提供的hook將在此torch.nn.modules.Module上所有現有forward_prehook 之後觸發。請注意，使用register_module_forward_pre_hook()註冊的全域性forward_prehook 將在此方法註冊的所有 hook 之前觸發。預設為False。with_kwargs (bool) – 如果為 true，則
hook將接收傳遞給 forward 函式的 kwargs。預設為False。
- 返回:
一個控制代碼 (handle)，可以透過呼叫
handle.remove()來移除新增的 hook。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_full_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) RemovableHandle¶
在模組上註冊一個反向 hook。
每次計算模組的梯度時都會呼叫此鉤子，即只有在計算模組輸出的梯度時，此鉤子才會執行。鉤子應具有以下簽名：
hook(module, grad_input, grad_output) -> tuple(Tensor) or None
grad_input和grad_output是元組，分別包含與輸入和輸出相關的梯度。鉤子不應修改其引數，但可以選擇返回與輸入相關的新梯度，該梯度將在後續計算中替代grad_input使用。grad_input只對應作為位置引數提供的輸入，所有關鍵字引數都會被忽略。grad_input和grad_output中的非 Tensor 引數對應項將為None。出於技術原因，當此鉤子應用於模組時，其 forward 函式將接收傳遞給該模組的每個 Tensor 的檢視。類似地，呼叫者也將接收該模組的 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)，可以透過呼叫
handle.remove()來移除新增的 hook。- 返回型別:
torch.utils.hooks.RemovableHandle
- register_full_backward_pre_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]], prepend: bool = False) RemovableHandle¶
在模組上註冊一個反向預鉤子。
每次計算模組的梯度時都會呼叫此鉤子。鉤子應具有以下簽名：
hook(module, grad_output) -> tuple[Tensor] or None
grad_output是一個元組。鉤子不應修改其引數，但可以選擇返回與輸出相關的新梯度，該梯度將在後續計算中替代grad_output使用。grad_output中的非 Tensor 引數對應項將為None。出於技術原因，當此鉤子應用於模組時，其 forward 函式將接收傳遞給該模組的每個 Tensor 的檢視。類似地，呼叫者也將接收該模組的 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)，可以透過呼叫
handle.remove()來移除新增的 hook。- 返回型別:
torch.utils.hooks.RemovableHandle
- classmethod register_gym(id: str, *, entry_point: Callable | None = None, transform: Transform | None = None, info_keys: list[NestedKey] | None = None, backend: str = None, to_numpy: bool = False, reward_threshold: float | None = None, nondeterministic: bool = False, max_episode_steps: int | None = None, order_enforce: bool = True, autoreset: bool = False, disable_env_checker: bool = False, apply_api_compatibility: bool = False, **kwargs)¶
在 gym(nasium) 中註冊一個環境。
此方法設計時考慮了以下應用場景：
將 TorchRL 優先的環境整合到使用 Gym 的框架中；
將其他環境（例如 DeepMind Control, Brax, Jumanji 等）整合到使用 Gym 的框架中。
- 引數:
id (str) – 環境的名稱。應遵循 gym 命名約定。
- 關鍵字引數:
entry_point (callable, optional) –
用於構建環境的入口點。如果未傳入，則父類將用作入口點。通常，這用於註冊一個不一定繼承自所使用基礎類的環境。
>>> from torchrl.envs import DMControlEnv >>> DMControlEnv.register_gym("DMC-cheetah-v0", env_name="cheetah", task="run") >>> # equivalently >>> EnvBase.register_gym("DMC-cheetah-v0", entry_point=DMControlEnv, env_name="cheetah", task="run")
transform (torchrl.envs.Transform) – 用於環境的變換（或在
torchrl.envs.Compose例項中的變換列表）。此引數可在呼叫make()期間傳遞（見下例）。info_keys (List[NestedKey], optional) –
如果提供，這些鍵將用於構建 info 字典，並從 observation 鍵中排除。此引數可在呼叫
make()期間傳遞（見下例）。警告
使用
info_keys可能會導致 spec 變為空，因為內容已移至 info 字典。Gym 不喜歡 specs 中的空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 關鍵字引數] 學習環境時考慮的獎勵閾值。nondeterministic (bool, optional) – [Gym 關鍵字引數] 如果環境是非確定性的（即使知道初始種子和所有動作）。預設為
False。max_episode_steps (int, optional) – [Gym 關鍵字引數] 截斷前的最大 episodes 步數。由 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引數來精細控制哪些被視為 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)¶
註冊一個後置鉤子，該鉤子將在模組的
load_state_dict()被呼叫後執行。- 它應具有以下簽名：
hook(module, incompatible_keys) -> None
module引數是註冊此鉤子的當前模組，而incompatible_keys引數是一個NamedTuple，包含missing_keys和unexpected_keys屬性。missing_keys是一個包含缺失鍵的strlist，而unexpected_keys是一個包含意外部索引鍵的strlist。如果需要，可以就地修改給定的 incompatible_keys。
請注意，如預期一樣，當呼叫
load_state_dict()並設定strict=True時執行的檢查會受到鉤子對missing_keys或unexpected_keys所做修改的影響。向任一鍵集中新增內容將在strict=True時引發錯誤，而清除缺失鍵和意外部索引鍵將避免錯誤。- 返回:
一個控制代碼 (handle)，可以透過呼叫
handle.remove()來移除新增的 hook。- 返回型別:
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) – 在載入 state dict 之前將被呼叫的 Callable 鉤子。
- register_module(name: str, module: Optional[Module]) None¶
add_module()的別名。
- register_parameter(name: str, param: Optional[Parameter]) None¶
向模組新增一個引數。
可以使用給定的名稱作為屬性來訪問該引數。
- 引數:
name (str) – 引數的名稱。可以使用此模組中的給定名稱訪問該引數
param (Parameter 或 None) – 要新增到模組的引數。如果為
None，則在引數上執行的操作（例如cuda）將被忽略。如果為None，則該引數將不會包含在模組的state_dict中。
- register_state_dict_post_hook(hook)¶
為
state_dict()方法註冊一個後置鉤子。- 它應具有以下簽名：
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_() 與可能與其混淆的幾種類似機制之間的比較，請參閱[本地停用梯度計算](https://pytorch.com.tw/docs/stable/notes/autograd.html#locally-disable-grad-doc)。
- 引數:
requires_grad (bool) – autograd 是否應記錄此模組中引數的操作。預設值：
True。- 返回:
self
- 返回型別:
Module
- reset(tensordict: TensorDictBase | None = None, **kwargs) TensorDictBase¶
重置環境。
與 step 和 _step 一樣，只有私有方法
_reset應由 EnvBase 子類重寫。- 引數:
tensordict (TensorDictBase, optional) – 用於包含結果新 observation 的 tensordict。在某些情況下，此輸入也可用於向 reset 函式傳遞引數。
kwargs (optional) – 要傳遞給原生 reset 函式的其他引數。
- 返回:
返回一個 tensordict（如果提供了輸入 tensordict，則為該輸入 tensordict），其中包含就地修改後的結果 observations。
注意
reset 不應被
EnvBase子類重寫。要修改的方法是_reset()。
- property reset_keys: list[tensordict._nestedkey.NestedKey]¶
返回 reset 鍵的列表。
Reset 鍵是在批次、多工或多代理設定中指示部分重置的鍵。它們的結構為
(*prefix, "_reset")，其中prefix是一個（可能為空的）字串元組，指向 tensordict 中可以找到完成狀態的位置。鍵按資料樹中的深度排序。
- property reward_key¶
環境的獎勵鍵。
預設情況下，這將是 “reward”。
如果環境中存在多個獎勵鍵，此函式將引發異常。
- property reward_keys: list[tensordict._nestedkey.NestedKey]¶
環境的獎勵鍵。
預設情況下，將只有一個名為 “reward” 的鍵。
鍵按資料樹中的深度排序。
- property reward_spec: TensorSpec¶
rewardspec。reward_spec總是以複合 spec 儲存。如果獎勵 spec 提供為簡單 spec，則將返回此 spec。
>>> env.reward_spec = Unbounded(1) >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果獎勵 spec 提供為複合 spec 且僅包含一個葉節點，此函式將僅返回該葉節點。
>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1)}}) >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous)
如果獎勵 spec 提供為複合 spec 且包含多個葉節點，此函式將返回整個 spec。
>>> env.reward_spec = Composite({"nested": {"reward": Unbounded(1), "another_reward": Categorical(1)}}) >>> env.reward_spec Composite( nested: Composite( reward: UnboundedContinuous( shape=torch.Size([1]), space=ContinuousBox( low=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True), high=Tensor(shape=torch.Size([]), device=cpu, dtype=torch.float32, contiguous=True)), device=cpu, dtype=torch.float32, domain=continuous), another_reward: Categorical( shape=torch.Size([]), space=DiscreteBox(n=1), device=cpu, dtype=torch.int64, domain=discrete), device=cpu, shape=torch.Size([])), device=cpu, shape=torch.Size([]))
要檢索傳入的完整規範，請使用
>>> env.output_spec["full_reward_spec"]
此屬性是可變的。
示例
>>> from torchrl.envs.libs.gym import GymEnv >>> env = GymEnv("Pendulum-v1") >>> env.reward_spec UnboundedContinuous( shape=torch.Size([1]), space=None, device=cpu, dtype=torch.float32, domain=continuous)
- property reward_spec_unbatched: TensorSpec¶
返回環境的獎勵規範 (reward spec)，就像它沒有批處理維度一樣。
- 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 之前達到完成狀態，實際步數可能會小於 max_steps。
policy (callable, 可選) – 用於計算期望動作的可呼叫物件。如果未提供策略，將使用
env.rand_step()呼叫動作。策略可以是任何可呼叫物件，它讀取張量字典（TensorDict）或觀察項的整個序列，__按照env.observation_spec.keys()的順序排序__。預設為 None。callback (Callable[[TensorDict], Any], 可選) – 在每次迭代時使用給定的張量字典（TensorDict）呼叫的函式。預設為
None。callback的輸出不會被收集，如果資料需要在rollout呼叫之外保留，則使用者有責任在 callback 呼叫內部儲存任何結果。
- 關鍵字引數:
auto_reset (bool, 可選) – 如果為
True，將在開始軌跡採集之前重置包含的環境。如果為False，則軌跡採集將從先前的狀態繼續，這要求傳入帶有先前軌跡採集結果的tensordict引數。預設為True。auto_cast_to_device (bool, 可選) – 如果為
True，在使用策略之前，張量字典的裝置型別會自動轉換為策略的裝置型別。預設為False。break_when_any_done (bool) – 如果為
True，當包含的任何環境達到任何完成狀態時中斷。如果為False，則已完成的環境會自動重置。預設為True。break_when_all_done (bool, 可選) – 如果為
True，如果所有包含的環境都達到任何完成狀態則中斷。如果為False，如果至少有一個環境達到任何完成狀態則中斷。預設為False。return_contiguous (bool) – 如果為 False，將返回一個 LazyStackedTensorDict。如果環境沒有動態規範（dynamic specs），預設為 True，否則預設為 False。
tensordict (TensorDict, 可選) – 如果
auto_reset為 False，則必須提供初始張量字典。Rollout 將檢查此張量字典是否包含完成標誌，並根據需要重置這些維度的環境。如果tensordict是重置操作的輸出，通常不會發生這種情況，但如果tensordict是先前軌跡採集的最後一步，則可能會發生。即使auto_reset=True，如果需要將元資料（如無狀態環境的批大小或裝置）傳遞給reset方法，也可以提供tensordict。set_truncated (bool, 可選) – 如果為
True，在軌跡採集完成後，"truncated"和"done"鍵將被設定為True。如果在done_spec中未找到"truncated"，則會引發異常。可以透過env.add_truncated_keys設定 truncated 鍵。預設為False。trust_policy (bool, 可選) – 如果為
True，非 TensorDictModule 策略將被假定為與收集器相容並受到信任。對於 CudaGraphModules，預設為True，否則為False。
- 返回:
包含結果軌跡的張量字典（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)
在某些情況下，由於無法堆疊，無法獲得連續的張量字典。這可能發生在每一步返回的資料形狀不同，或者同時執行不同的環境時。在這種情況下，
return_contiguous=False將導致返回的張量字典成為張量字典的惰性堆疊（lazy stack）。- 非連續軌跡採集示例
>>> 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']
Rollouts 可以用於迴圈中以模擬資料收集。為此，您需要將前一個 rollout 呼叫
step_mdp()後產生的最後一個張量字典作為輸入傳入。- 資料採集 Rollout 示例
>>> from torchrl.envs import GymEnv, step_mdp >>> env = GymEnv("CartPole-v1") >>> epochs = 10 >>> input_td = env.reset() >>> for i in range(epochs): ... rollout_td = env.rollout( ... max_steps=100, ... break_when_any_done=False, ... auto_reset=False, ... tensordict=input_td, ... ) ... input_td = step_mdp( ... rollout_td[..., -1], ... )
- set_extra_state(state: Any) None¶
設定載入的 state_dict 中包含的額外狀態。
此函式由
load_state_dict()呼叫，用於處理在 state_dict 中找到的任何額外狀態。如果您的模組需要在其 state_dict 中儲存額外狀態，請實現此函式和相應的get_extra_state()。- 引數:
state (dict) – 來自 state_dict 的額外狀態。
- set_seed(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) 規範。預設為 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 – 如果目標字串引用了無效路徑或解析到的物件不是
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, 可選) – 如果提供，模組的狀態將被更新到此字典中，並返回相同的物件。否則，將建立一個
OrderedDict並返回。預設值：None。prefix (str, 可選) – 新增到引數和緩衝區名稱前的字串，用於在 state_dict 中組成鍵。預設值：
''。keep_vars (bool, 可選) – 預設情況下，state dict 中返回的
Tensors 與 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 spec)，就像它沒有批處理維度一樣。
- step(tensordict: TensorDictBase) TensorDictBase¶
在環境中執行一步。
Step 接受一個引數 tensordict，其中通常包含一個“action”鍵，指示要採取的動作。Step 將呼叫一個非原地的私有方法 _step，這是 EnvBase 子類需要重寫的方法。
- 引數:
tensordict (TensorDictBase) – 包含要採取動作的張量字典。如果輸入的 tensordict 包含一個
"next"條目，則其中包含的值將優先於新計算的值。這提供了一種覆蓋底層計算的機制。- 返回:
輸入的 tensordict，在其原位被修改，包含結果觀察值、完成狀態和獎勵（+如果需要，還包含其他資訊）。
- step_and_maybe_reset(tensordict: TensorDictBase) tuple[tensordict.base.TensorDictBase, tensordict.base.TensorDictBase]¶
在環境中執行一步，並在需要時（部分）重置環境。
- 引數:
tensordict (TensorDictBase) –
step()方法的輸入資料結構。
此方法允許輕鬆編寫不停歇的軌跡採集函式。
示例
>>> 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 定義的下一狀態來更新環境的狀態。結果張量字典包含更新後的觀察值和任何其他相關的狀態資訊，其鍵按照環境的規範進行管理。
在內部，此方法利用預計算的
_StepMDP例項來高效處理狀態、觀察值、動作、獎勵和完成鍵的轉換。_StepMDP類透過預計算要包含和排除的鍵來最佳化過程，減少重複呼叫時的執行時開銷。_StepMDP例項使用 exclude_action=False 建立，這意味著動作鍵保留在根張量字典中。- 引數:
next_tensordict (TensorDictBase) – 包含環境在下一時間步狀態的張量字典。此張量字典應包含觀察值、動作、獎勵和完成標誌的鍵，這些鍵由環境的規範定義。
- 返回:
一個表示環境狀態推進一步後的新張量字典。
- 返回型別:
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¶
移動和/或轉換引數和緩衝區。
可以按以下方式呼叫：
- 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時，如果可能，它會嘗試相對於主機進行非同步轉換/移動，例如將具有固定記憶體 (pinned memory) 的 CPU Tensor 移動到 CUDA 裝置。示例如下。
注意
此方法就地修改模組。
- 引數:
device (
torch.device) – 此模組中引數和緩衝區的目標裝置dtype (
torch.dtype) – 此模組中引數和緩衝區的目標浮點或複數 dtypetensor (torch.Tensor) – 其 dtype 和 device 是此模組中所有引數和緩衝區的目標 dtype 和 device 的 Tensor
memory_format (
torch.memory_format) – 此模組中 4D 引數和緩衝區的目標記憶體格式（僅關鍵字引數）
- 返回:
self
- 返回型別:
Module
示例
>>> # xdoctest: +IGNORE_WANT("non-deterministic") >>> linear = nn.Linear(2, 2) >>> linear.weight Parameter containing: tensor([[ 0.1913, -0.3420], [-0.5113, -0.2325]]) >>> linear.to(torch.double) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1913, -0.3420], [-0.5113, -0.2325]], dtype=torch.float64) >>> # xdoctest: +REQUIRES(env:TORCH_DOCTEST_CUDA1) >>> gpu1 = torch.device("cuda:1") >>> linear.to(gpu1, dtype=torch.half, non_blocking=True) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1914, -0.3420], [-0.5112, -0.2324]], dtype=torch.float16, device='cuda:1') >>> cpu = torch.device("cpu") >>> linear.to(cpu) Linear(in_features=2, out_features=2, bias=True) >>> linear.weight Parameter containing: tensor([[ 0.1914, -0.3420], [-0.5112, -0.2324]], dtype=torch.float16) >>> linear = nn.Linear(2, 2, bias=None).to(torch.cdouble) >>> linear.weight Parameter containing: tensor([[ 0.3741+0.j, 0.2382+0.j], [ 0.5593+0.j, -0.4443+0.j]], dtype=torch.complex128) >>> linear(torch.ones(3, 2, dtype=torch.cdouble)) tensor([[0.6122+0.j, 0.1150+0.j], [0.6122+0.j, 0.1150+0.j], [0.6122+0.j, 0.1150+0.j]], dtype=torch.complex128)
- to_empty(*, device: Optional[Union[int, str, device]], recurse: bool = True) T¶
將引數和緩衝區移動到指定的裝置，而不復制儲存。
- 引數:
device (
torch.device) – 此模組中引數和緩衝區的目標裝置。recurse (bool) – 是否應遞迴地將子模組的引數和緩衝區移動到指定的裝置。
- 返回:
self
- 返回型別:
Module
- train(mode: bool = True) T¶
將模組設定為訓練模式。
這隻對某些模組生效。有關特定模組在訓練/評估模式下的行為詳情，即它們是否受影響，請參閱其文件，例如
Dropout、BatchNorm等。- 引數:
mode (bool) – 是否設定為訓練模式 (
True) 或評估模式 (False)。預設值：True。- 返回:
self
- 返回型別:
Module
- type(dst_type: Union[dtype, str]) T¶
將所有引數和緩衝區轉換為
dst_type。注意
此方法就地修改模組。
- 引數:
dst_type (type or string) – 目標型別
- 返回:
self
- 返回型別:
Module
- xpu(device: Optional[Union[int, device]] = None) T¶
將所有模型引數和緩衝區移動到 XPU。
這也會使相關的引數和緩衝區成為不同的物件。因此，如果模組在 XPU 上執行時需要被最佳化，應在構建最佳化器之前呼叫此方法。
注意
此方法就地修改模組。
- 引數:
device (int, optional) – 如果指定，所有引數將被複制到該裝置。
- 返回:
self
- 返回型別:
Module
- zero_grad(set_to_none: bool = True) None¶
重置所有模型引數的梯度。
更多上下文請參見
torch.optim.Optimizer下的類似函式。- 引數:
set_to_none (bool) – 將梯度設定為 None，而不是設定為零。詳情請參閱
torch.optim.Optimizer.zero_grad()。
