MultiStepTransform

類 torchrl.envs.transforms.rb_transforms.MultiStepTransform(n_steps, gamma, *, reward_keys: List[NestedKey] | None = None, done_key: NestedKey | None = None, done_keys: List[NestedKey] | None = None, mask_key: NestedKey | None = None)

ReplayBuffer 的 MultiStep 轉換。

此轉換在本地緩衝區中保留前 n_steps 個觀測。逆轉換（在 extend() 期間呼叫）輸出轉換後的前 n_steps 個幀以及當前的 T-n_steps 個幀。

"next" tensordict 中所有不屬於 done_keys 或 reward_keys 的條目將被對映到其對應的 t + n_steps - 1 條目。

此轉換是 MultiStep 的一個對超引數更魯棒的版本：回放緩衝區轉換將使多步轉換對收集器的超引數不敏感，而後處理版本則會輸出對這些引數敏感的結果（因為收集器沒有先前輸出的記憶）。

引數:

• n_steps (int) – 多步中的步數。可以透過改變此轉換的 n_steps 屬性來動態改變步數。

• gamma (float) – 折扣因子。

關鍵字引數:

• reward_keys (list of NestedKey, 可選) – 輸入 tensordict 中的獎勵鍵。由這些鍵指示的獎勵條目將在未來 n_steps 步驟中累積和折扣。輸出 tensordict 的 "next" 條目中將寫入相應的 <reward_key>_orig 條目，以跟蹤獎勵的原始值。預設為 ["reward"]。

• done_key (NestedKey, 可選) – 輸入 tensordict 中的完成鍵，用於指示軌跡的結束。預設為 "done"。

• done_keys (list of NestedKey, 可選) – 輸入 tensordict 中的結束鍵列表。由這些鍵指示的所有條目將不會被轉換觸動。預設為 ["done", "truncated", "terminated"]。

• mask_key (NestedKey, 可選) – 輸入 tensordict 中的掩碼鍵。掩碼錶示輸入 tensordict 中的有效幀，其形狀應允許對輸入 tensordict 進行掩碼操作。預設為 "mask"。

示例

>>> from torchrl.envs import GymEnv, TransformedEnv, StepCounter, MultiStepTransform, SerialEnv
>>> from torchrl.data import ReplayBuffer, LazyTensorStorage
>>> rb = ReplayBuffer(
...     storage=LazyTensorStorage(100, ndim=2),
...     transform=MultiStepTransform(n_steps=3, gamma=0.95)
... )
>>> base_env = SerialEnv(2, lambda: GymEnv("CartPole"))
>>> env = TransformedEnv(base_env, StepCounter())
>>> _ = env.set_seed(0)
>>> _ = torch.manual_seed(0)
>>> tdreset = env.reset()
>>> for _ in range(100):
...     rollout = env.rollout(max_steps=50, break_when_any_done=False,
...         tensordict=tdreset, auto_reset=False)
...     indices = rb.extend(rollout)
...     tdreset = rollout[..., -1]["next"]
>>> print("step_count", rb[:]["step_count"][:, :5])
step_count tensor([[[ 9],
         [10],
         [11],
         [12],
         [13]],

        [[12],
         [13],
         [14],
         [15],
         [16]]])
>>> # The next step_count is 3 steps in the future
>>> print("next step_count", rb[:]["next", "step_count"][:, :5])
next step_count tensor([[[13],
         [14],
         [15],
         [16],
         [17]],

        [[16],
         [17],
         [18],
         [19],
         [20]]])

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

向當前模組新增一個子模組。

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

引數:

• name (str) – 子模組的名稱。可以使用給定的名稱從該模組訪問子模組。

• module (Module) – 要新增到模組的子模組。

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

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)

children() → Iterator[Module]

返回直接子模組的迭代器。

生成:

Module – 一個子模組

compile(*args, **kwargs)

使用 torch.compile() 編譯此模組的 forward 方法。

此模組的 __call__ 方法被編譯，所有引數原樣傳遞給 torch.compile()。

有關此函式的引數詳情，請參閱 torch.compile()。

property container

返回包含此轉換的環境。

示例

>>> from torchrl.envs import TransformedEnv, Compose, RewardSum, StepCounter
>>> from torchrl.envs.libs.gym import GymEnv
>>> env = TransformedEnv(GymEnv("Pendulum-v1"), Compose(RewardSum(), StepCounter()))
>>> env.transform[0].container is env
True

cpu() → T

將所有模型引數和緩衝區移動到 CPU。

注意

此方法會就地修改模組。

返回值:

自身

返回型別:

Module

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

將所有模型引數和緩衝區移動到 GPU。

這也會使相關的引數和緩衝區成為不同的物件。因此，如果在最佳化過程中模組將位於 GPU 上，則應在構建最佳化器之前呼叫此方法。

注意

此方法會就地修改模組。

引數:

device (int, 可選) – 如果指定，所有引數將被複制到該裝置。

返回值:

自身

返回型別:

Module

double() → T

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

注意

此方法會就地修改模組。

返回值:

自身

返回型別:

Module

eval() → T

將模組設定為評估模式。

這隻對某些模組有影響。有關特定模組在訓練/評估模式下的行為詳情，即它們是否受影響，例如 Dropout、BatchNorm 等，請參閱其文件。

這等同於呼叫 self.train(False)。

有關 .eval() 與可能與其混淆的幾種類似機制的比較，請參閱 區域性停用梯度計算。

返回值:

自身

返回型別:

Module

extra_repr() → str

返回模組的額外表示。

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

float() → T

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

注意

此方法會就地修改模組。

返回值:

自身

返回型別:

Module

forward(tensordict: TensorDictBase = None) → TensorDictBase

讀取輸入的 tensordict，並對選定的鍵應用轉換。

get_buffer(target: str) → Tensor

返回由 target 給定的緩衝區（如果存在），否則丟擲錯誤。

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

引數:

target – 要查詢的緩衝區的完全限定字串名稱。（有關如何指定完全限定字串，請參閱 get_submodule。）

返回值:

由 target 引用的緩衝區。

返回型別:

torch.Tensor

丟擲:

AttributeError – 如果目標字串引用了無效路徑或解析為非緩衝區的內容。

get_extra_state() → Any

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

如果您需要儲存額外狀態，請為您的模組實現此方法和相應的 set_extra_state()。此函式在構建模組的 state_dict() 時呼叫。

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

返回值:

要儲存在模組 state_dict 中的任何額外狀態。

返回型別:

object

get_parameter(target: str) → Parameter

返回由 target 給定的引數（如果存在），否則丟擲錯誤。

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

引數:

target – 要查詢的 Parameter 的完全限定字串名稱。（有關如何指定完全限定字串，請參閱 get_submodule。）

返回值:

由 target 引用的 Parameter。

返回型別:

torch.nn.Parameter

丟擲:

AttributeError – 如果目標字串引用了無效路徑或解析為非 nn.Parameter 的內容。

get_submodule(target: str) → Module

返回由 target 給定的子模組（如果存在），否則丟擲錯誤。

例如，假設您有一個 nn.Module A，它看起來像這樣

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

（圖示顯示了一個 nn.Module A。A 有一個巢狀子模組 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 引用的子模組。

返回型別:

torch.nn.Module

丟擲:

AttributeError – 如果目標字串引用了無效路徑或解析為非 nn.Module 的內容。

half() → T

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

注意

此方法會就地修改模組。

返回值:

自身

返回型別:

Module

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

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

這也會使相關的引數和緩衝區成為不同的物件。因此，如果在最佳化過程中模組將位於 IPU 上，則應在構建最佳化器之前呼叫此方法。

注意

此方法會就地修改模組。

引數:

device (int, 可選) – 如果指定，所有引數將被複制到該裝置。

返回值:

自身

返回型別:

Module

load_state_dict(state_dict: Mapping[str, Any], strict: bool = True, assign: bool = False)

將引數和緩衝區從 state_dict 複製到此模組及其後代。

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

警告

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

引數:

• state_dict (dict) – 一個包含引數和持久化緩衝區的字典。

• strict (bool, optional) – 是否嚴格強制要求 state_dict 中的鍵與此模組的 state_dict() 函式返回的鍵匹配。預設值： True

• assign (bool, optional) – 當設定為 False 時，將保留當前模組中張量的屬性，而將其設定為 True 時將保留 state dict 中張量的屬性。唯一的例外是 requires_grad 欄位 預設值： ``False``

返回值:

• missing_keys 是一個字串列表，包含此模組預期但

  提供的 state_dict 中缺少的任何鍵。

• unexpected_keys 是一個字串列表，包含此模組不

  預期但在提供的 state_dict 中存在的鍵。

返回型別:

NamedTuple，具有 missing_keys 和 unexpected_keys 欄位

注意

如果引數或緩衝區註冊為 None 並且其對應的鍵存在於 state_dict 中，load_state_dict() 將引發 RuntimeError。

modules() → Iterator[Module]

返回網路中所有模組的迭代器。

生成:

Module – 網路中的一個模組

注意

重複的模組只返回一次。在以下示例中，l 將只返回一次。

示例

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

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

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

將所有模型引數和緩衝區移動到 MTIA。

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

注意

此方法會就地修改模組。

引數:

device (int, 可選) – 如果指定，所有引數將被複制到該裝置。

返回值:

自身

返回型別:

Module

property n_steps

轉換的前瞻視窗。

這個值可以在訓練期間動態修改。

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

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)

property parent: Optional[EnvBase]

返回轉換的父環境（env）。

父環境是包含從開始直到當前轉換的所有轉換的環境。

示例

>>> from torchrl.envs import TransformedEnv, Compose, RewardSum, StepCounter
>>> from torchrl.envs.libs.gym import GymEnv
>>> env = TransformedEnv(GymEnv("Pendulum-v1"), Compose(RewardSum(), StepCounter()))
>>> env.transform[1].parent
TransformedEnv(
    env=GymEnv(env=Pendulum-v1, batch_size=torch.Size([]), device=cpu),
    transform=Compose(
            RewardSum(keys=['reward'])))

register_backward_hook(hook: Callable[[Module, Union[Tuple[Tensor, ...], Tensor], Union[Tuple[Tensor, ...], Tensor]], Union[None, Tuple[Tensor, ...], Tensor]]) → RemovableHandle

在模組上註冊一個反向傳播鉤子。

此函式已棄用，推薦使用 register_full_backward_hook()，並且此函式的行為將在未來版本中改變。

返回值:

一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子

返回型別:

torch.utils.hooks.RemovableHandle

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

為模組新增一個緩衝區。

這通常用於註冊不應被視為模型引數的緩衝區。例如，BatchNorm 的 running_mean 不是引數，而是模組狀態的一部分。緩衝區預設是持久化的，並將與引數一起儲存。透過將 persistent 設定為 False 可以改變此行為。持久化緩衝區和非持久化緩衝區之間唯一的區別在於後者不會成為此模組 state_dict 的一部分。

可以使用給定的名稱作為屬性來訪問緩衝區。

引數:

• name (str) – 緩衝區的名稱。可以使用給定的名稱從此模組訪問緩衝區

• tensor (Tensor 或 None) – 要註冊的緩衝區。如果為 None，則忽略在緩衝區上執行的操作，例如 cuda。如果為 None，緩衝區將不包含在模組的 state_dict 中。

• persistent (bool) – 緩衝區是否是此模組 state_dict 的一部分。

示例

>>> # xdoctest: +SKIP("undefined vars")
>>> self.register_buffer('running_mean', torch.zeros(num_features))

register_forward_hook(hook: Union[Callable[[T, Tuple[Any, ...], Any], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any], Any], Optional[Any]]], *, prepend: bool = False, with_kwargs: bool = False, always_call: bool = False) → RemovableHandle

在模組上註冊一個前向傳播鉤子。

每次 forward() 計算出輸出後都會呼叫此鉤子。

如果 with_kwargs 為 False 或未指定，輸入只包含傳遞給模組的位置引數。關鍵字引數不會傳遞給鉤子，只會傳遞給 forward。鉤子可以修改輸出。它可以就地修改輸入，但不會影響 forward，因為此鉤子是在 forward() 呼叫之後呼叫的。鉤子應具有以下簽名

hook(module, args, output) -> None or modified output

如果 with_kwargs 為 True，前向鉤子將接收傳遞給 forward 函式的 kwargs，並期望返回可能已修改的輸出。鉤子應具有以下簽名

hook(module, args, kwargs, output) -> None or modified output

引數:

• hook (Callable) – 要註冊的使用者定義鉤子。

• prepend (bool) – 如果為 True，提供的 hook 將在 torch.nn.modules.Module 上的所有現有 forward 鉤子之前觸發。否則，提供的 hook 將在 torch.nn.modules.Module 上的所有現有 forward 鉤子之後觸發。請注意，使用 register_module_forward_hook() 註冊的全域性 forward 鉤子將在透過此方法註冊的所有鉤子之前觸發。預設值： False

• with_kwargs (bool) – 如果為 True，鉤子將接收傳遞給 forward 函式的 kwargs。預設值： False

• always_call (bool) – 如果為 True，無論呼叫模組時是否丟擲異常，鉤子都將執行。預設值： False

返回值:

一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子

返回型別:

torch.utils.hooks.RemovableHandle

register_forward_pre_hook(hook: Union[Callable[[T, Tuple[Any, ...]], Optional[Any]], Callable[[T, Tuple[Any, ...], Dict[str, Any]], Optional[Tuple[Any, Dict[str, Any]]]]], *, prepend: bool = False, with_kwargs: bool = False) → RemovableHandle

在模組上註冊一個前向傳播預鉤子。

每次 forward() 被呼叫之前都會呼叫此鉤子。

如果 with_kwargs 為 False 或未指定，輸入只包含傳遞給模組的位置引數。關鍵字引數不會傳遞給鉤子，只會傳遞給 forward。鉤子可以修改輸入。使用者可以在鉤子中返回一個元組或一個修改後的單個值。如果返回單個值（除非該值本身就是一個元組），我們將把該值包裝成一個元組。鉤子應具有以下簽名

hook(module, args) -> None or modified input

如果 with_kwargs 為 True，前向預鉤子將接收傳遞給 forward 函式的 kwargs。如果鉤子修改了輸入，則應同時返回 args 和 kwargs。鉤子應具有以下簽名

hook(module, args, kwargs) -> None or a tuple of modified input and kwargs

引數:

• hook (Callable) – 要註冊的使用者定義鉤子。

• prepend (bool) – 如果為 True，提供的 hook 將在 torch.nn.modules.Module 上的所有現有 forward_pre 鉤子之前觸發。否則，提供的 hook 將在 torch.nn.modules.Module 上的所有現有 forward_pre 鉤子之後觸發。請注意，使用 register_module_forward_pre_hook() 註冊的全域性 forward_pre 鉤子將在透過此方法註冊的所有 forward_pre 鉤子之前觸發。預設值： False

• with_kwargs (bool) – 如果為 True，鉤子將接收傳遞給 forward 函式的 kwargs。預設值： False

返回值:

一個控制代碼，可以透過呼叫 handle.remove() 來移除新增的鉤子

返回型別:

torch.utils.hooks.RemovableHandle

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

在模組上註冊一個反向傳播鉤子。

每當計算模組的梯度時，就會呼叫該鉤子，即僅當計算模組輸出的梯度時，該鉤子才會執行。該鉤子應具有以下簽名：

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

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

出於技術原因，當此鉤子應用於 Module 時，其 forward 函式將接收傳遞給該 Module 的每個 Tensor 的檢視。類似地，呼叫方將接收該 Module 的 forward 函式返回的每個 Tensor 的檢視。

警告

使用 backward 鉤子時，不允許原位修改輸入或輸出，否則會引發錯誤。

引數:

• hook (Callable) – 要註冊的使用者定義鉤子。

• prepend (bool) – 如果為 true，則提供的 hook 將在該 torch.nn.modules.Module 上所有現有 backward 鉤子之前觸發。否則，提供的 hook 將在該 torch.nn.modules.Module 上所有現有 backward 鉤子之後觸發。請注意，使用 register_module_full_backward_pre_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

在模組上註冊一個 backward pre-hook。

每當計算模組的梯度時，就會呼叫該鉤子。該鉤子應具有以下簽名：

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

grad_output 是一個元組。鉤子不應修改其引數，但可以選擇性地返回一個新的輸出梯度，該梯度將用於後續計算中代替 grad_output。grad_output 中的非 Tensor 引數對應的條目將是 None。

出於技術原因，當此鉤子應用於 Module 時，其 forward 函式將接收傳遞給該 Module 的每個 Tensor 的檢視。類似地，呼叫方將接收該 Module 的 forward 函式返回的每個 Tensor 的檢視。

警告

使用 backward 鉤子時，不允許原位修改輸入，否則會引發錯誤。

引數:

• 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

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 是一個包含缺失鍵的 str list，unexpected_keys 是一個包含意外部索引鍵的 str 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 或 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 訓練）。

請參閱 `Locally disabling gradient computation` 以比較 `.requires_grad_()` 與可能與之混淆的幾種類似機制。

引數:

requires_grad (bool) – autograd 是否應記錄此模組中引數上的操作。預設值：True。

返回值:

自身

返回型別:

Module

set_extra_state(state: Any) → None

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

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

引數:

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

set_submodule(target: str, module: Module) → None

如果存在，設定由 target 給定的子模組；否則丟擲錯誤。

例如，假設您有一個 nn.Module A，它看起來像這樣

A(
    (net_b): Module(
        (net_c): Module(
            (conv): Conv2d(16, 33, kernel_size=(3, 3), stride=(2, 2))
        )
        (linear): Linear(in_features=100, out_features=200, bias=True)
    )
)

（該圖顯示一個 nn.Module A。A 有一個巢狀子模組 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 – 如果目標字串引用了無效路徑或解析為非 nn.Module 的內容。

share_memory() → T

請參閱 torch.Tensor.share_memory_()。

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']

to(*args, **kwargs)

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

可以按以下方式呼叫：

to(device=None, dtype=None, non_blocking=False)

to(dtype, non_blocking=False)

to(tensor, non_blocking=False)

to(memory_format=torch.channels_last)

其簽名類似於 torch.Tensor.to()，但只接受浮點或複數 dtype。此外，此方法只會將浮點或複數引數和緩衝區轉換為 dtype（如果給定）。整數引數和緩衝區將被移動到 device（如果給定），但 dtype 不變。設定 non_blocking 時，它會嘗試在可能的情況下非同步進行轉換/移動，例如，將具有固定記憶體的 CPU Tensor 移動到 CUDA 裝置。

參見下面的示例。

注意

此方法會就地修改模組。

引數:

• device (torch.device) – 此模組中引數和緩衝區的目標裝置

• dtype (torch.dtype) – 此模組中引數和緩衝區的目標浮點或複數 dtype

• tensor (torch.Tensor) – Tensor，其 dtype 和 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

將引數和緩衝區移動到指定裝置，而不復制儲存。

引數:

• device (torch.device) – 此模組中引數和緩衝區的目標裝置。

• recurse (bool) – 子模組的引數和緩衝區是否應遞迴移動到指定裝置。

返回值:

自身

返回型別:

Module

train(mode: bool = True) → T

將模組設定為訓練模式。

這僅對某些模組有效。有關它們在訓練/評估模式下的行為詳情（即它們是否受到影響），請參閱特定模組的文件，例如 Dropout、BatchNorm 等。

引數:

mode (bool) – 是否設定為訓練模式 (True) 或評估模式 (False)。預設值：True。

返回值:

自身

返回型別:

Module

transform_action_spec(action_spec: TensorSpec) → TensorSpec

轉換 action 規範，使得結果規範與轉換對映匹配。

引數:

action_spec (TensorSpec) – 轉換前的規範

返回值:

轉換後預期的規範

transform_done_spec(done_spec: TensorSpec) → TensorSpec

轉換 done 規範，使得結果規範與轉換對映匹配。

引數:

done_spec (TensorSpec) – 轉換前的規範

返回值:

轉換後預期的規範

transform_env_batch_size(batch_size: Size)

轉換父環境的 batch-size。

transform_env_device(device: device)

轉換父環境的裝置。

transform_input_spec(input_spec: TensorSpec) → TensorSpec

根據變換對映轉換輸入規範，使結果規範與之匹配。

引數:

input_spec (TensorSpec) – 變換前的規範

返回值:

轉換後預期的規範

transform_observation_spec(observation_spec: TensorSpec) → TensorSpec

根據變換對映轉換觀測規範，使結果規範與之匹配。

引數:

observation_spec (TensorSpec) – 變換前的規範

返回值:

轉換後預期的規範

transform_output_spec(output_spec: Composite) → Composite

根據變換對映轉換輸出規範，使結果規範與之匹配。

此方法通常應保持原樣。更改應透過 transform_observation_spec()、transform_reward_spec() 和 transform_full_done_spec() 實現。 :param output_spec: 變換前的規範 :type output_spec: TensorSpec

返回值:

轉換後預期的規範

transform_reward_spec(reward_spec: TensorSpec) → TensorSpec

根據變換對映轉換獎勵規範，使結果規範與之匹配。

引數:

reward_spec (TensorSpec) – 變換前的規範

返回值:

轉換後預期的規範

transform_state_spec(state_spec: TensorSpec) → TensorSpec

根據變換對映轉換狀態規範，使結果規範與之匹配。

引數:

state_spec (TensorSpec) – 變換前的規範

返回值:

轉換後預期的規範

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

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

注意

此方法會就地修改模組。

引數:

dst_type (type 或 string) – 目標型別

返回值:

自身

返回型別:

Module

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

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

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

注意

此方法會就地修改模組。

引數:

device (int, 可選) – 如果指定，所有引數將被複制到該裝置。

返回值:

自身

返回型別:

Module

zero_grad(set_to_none: bool = True) → None

重置所有模型引數的梯度。

請參閱 torch.optim.Optimizer 下的類似函式以獲取更多上下文。

引數:

set_to_none (bool) – 將梯度設定為 None，而不是設定為零。詳情請參閱 torch.optim.Optimizer.zero_grad()。