MultiStepTransform

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

重播緩衝區的多步轉換。

此轉換會在本地緩衝區中保留先前的 n_steps 觀察值。反向轉換（在 extend() 期間呼叫）會使用 T-n_steps 目前畫面輸出轉換後的先前 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, optional) – 輸入 tensordict 中的獎勵鍵。由這些鍵指示的獎勵條目將在未來 n_steps 步中累計和折扣。對應的 <reward_key>_orig 條目將寫入輸出 tensordict 的 "next" 條目中，以追蹤獎勵的原始值。預設為 ["reward"]。

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

• done_keys (list of NestedKey, optional) – 輸入 tensordict 中的結束鍵清單。由這些鍵指示的所有條目將不受轉換的影響。預設為 ["done", "truncated", "terminated"]。

• mask_key (NestedKey, optional) – 輸入 tensordict 中的 mask 鍵。mask 表示輸入 tensordict 中的有效幀，並且應具有允許使用 mask 遮罩輸入 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) – 要套用至每個子模組的函數

傳回:

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

bfloat16() → T

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

注意

此方法會就地修改模組。

傳回:

self

傳回類型:

Module

buffers(recurse: bool = True) → Iterator[Tensor]

傳回模組緩衝區的迭代器。

參數:

recurse (bool) – 如果為 True，則產生此模組和所有子模組的緩衝區。否則，僅產生作為此模組直接成員的緩衝區。

產生:

torch.Tensor – 模組緩衝區

範例

>>> # xdoctest: +SKIP("undefined vars")
>>> for buf in model.buffers():
>>>     print(type(buf), buf.size())
<class 'torch.Tensor'> (20L,)
<class 'torch.Tensor'> (20L, 1L, 5L, 5L)

children() → Iterator[Module]

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

產生:

Module – 子模組

compile(*args, **kwargs)

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

此模組的 __call__ 方法已編譯，並且所有引數都按原樣傳遞到 torch.compile()。

請參閱torch.compile()以了解此函數的參數詳情。

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。

注意

此方法會就地修改模組。

傳回:

self

傳回類型:

Module

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

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

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

注意

此方法會就地修改模組。

參數:

device (int, optional) – 如果指定，所有參數將被複製到該裝置

傳回:

self

傳回類型:

Module

double() → T

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

注意

此方法會就地修改模組。

傳回:

self

傳回類型:

Module

eval() → T

將模組設定為評估模式。

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

這等同於 self.train(False)。

請參閱 本地停用梯度計算，以比較 .eval() 和一些可能與之混淆的類似機制。

傳回:

self

傳回類型:

Module

extra_repr() → str

設定模組的額外表示。

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

float() → T

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

注意

此方法會就地修改模組。

傳回:

self

傳回類型:

Module

forward(tensordict: TensorDictBase = None) → TensorDictBase

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

get_buffer(target: str) → Tensor

如果存在，則返回由 target 給定的緩衝區，否則拋出錯誤。

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

參數:

target – 要尋找的緩衝區的完整字串名稱。（請參閱 get_submodule 以了解如何指定完整字串。）

傳回:

由 target 引用的緩衝區

傳回類型:

torch.Tensor

引發:

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

get_extra_state() → Any

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

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

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

傳回:

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

傳回類型:

物件 (object)

get_parameter(target: str) → Parameter

如果存在由 target 給定的參數，則返回該參數；否則拋出錯誤。

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

參數:

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)，其中 N 是可遞模組的數量。因此，對於一個簡單的檢查，看看是否存在某些子模組，應該始終使用 get_submodule。

參數:

target – 要尋找的子模組的完整字串名稱。（有關如何指定完整字串，請參閱上面的範例。）

傳回:

由 target 引用的子模組

傳回類型:

torch.nn.Module

引發:

AttributeError – 如果目標字串引用無效路徑或解析為非 nn.Module 的物件

half() → T

將所有浮點參數和緩衝區轉換為 half 數據類型。

注意

此方法會就地修改模組。

傳回:

self

傳回類型:

Module

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

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

這也會使相關的參數和緩衝區成為不同的物件。因此，如果模組將在 IPU 上運行並進行優化，則應在建構優化器之前調用此方法。

注意

此方法會就地修改模組。

參數:

device (int, optional) – 如果指定，所有參數將被複製到該裝置

傳回:

self

傳回類型:

Module

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

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

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

警告

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

參數:

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

• strict (bool, optional) – 是否嚴格要求 state_dict 中的鍵與此模組的 state_dict() 函數返回的鍵相符。預設值：True

• assign (bool, optional) – 當 False 時，保留目前模組中張量的屬性；當 True 時，保留狀態字典中張量的屬性。唯一的例外是 requires_grad 欄位。 Default: ``False`

傳回:

• missing_keys 是一個字串列表，其中包含此模組預期的但提供的 state_dict 中缺少的任何鍵。

  by this module but missing from the provided state_dict.

• unexpected_keys 是一個字串列表，其中包含此模組未預期但提供的 state_dict 中存在的鍵。

  expected by this module but present in the provided state_dict.

傳回類型:

NamedTuple 具有 missing_keys 和 unexpected_keys 欄位

注意

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

modules() → Iterator[Module]

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

產生:

Module – 網路中的模組

注意

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

範例

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

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

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

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

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

注意

此方法會就地修改模組。

參數:

device (int, optional) – 如果指定，所有參數將被複製到該裝置

傳回:

self

傳回類型:

Module

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) – 包含名稱和緩衝區的 Tuple

範例

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

回傳轉換的父環境 (parent 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

在模組上註冊一個反向鉤子 (backward hook)。

此函數已被棄用，建議使用 register_full_backward_hook()，並且此函數的行為將在未來版本中更改。

傳回:

一個控制代柄 (handle)，可用於通過呼叫 handle.remove() 來移除已新增的鉤子。

傳回類型:

torch.utils.hooks.RemovableHandle

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

將一個緩衝區 (buffer) 新增到模組中。

這通常用於註冊不應被視為模型參數的緩衝區。例如，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 hook。

每次在 forward() 計算出輸出後，都會呼叫這個 hook。

如果 with_kwargs 是 False 或未指定，則輸入僅包含提供給模組的位置引數。關鍵字引數不會傳遞給 hooks，只會傳遞給 forward。這個 hook 可以修改輸出。 它可以就地修改輸入，但由於這是在呼叫 forward() 之後呼叫的，因此不會對 forward 產生影響。這個 hook 應該具有以下簽名：

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

如果 with_kwargs 是 True，則 forward hook 將傳遞給 forward 函式的 kwargs，並預期會傳回可能修改後的輸出。這個 hook 應該具有以下簽名：

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

參數:

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

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

• with_kwargs (bool) – 如果 True，hook 將會傳遞給 forward 函數的 kwargs。預設值：False

• always_call (bool) – 如果 True，則無論呼叫模組時是否引發例外，都會執行 hook。預設值：False

傳回:

一個控制代柄 (handle)，可用於通過呼叫 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 pre-hook)。

每次呼叫 forward() 之前，都會呼叫這個鉤子。

如果 with_kwargs 為 false 或未指定，則輸入僅包含傳遞給模組的位置參數。關鍵字參數將不會傳遞給鉤子，而只會傳遞給 forward。鉤子可以修改輸入。使用者可以在鉤子中回傳一個 tuple 或一個經過修改的單一值。如果回傳單一值 (除非該值已經是一個 tuple)，我們將把該值包裝到一個 tuple 中。鉤子應該具有以下簽章：

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) – 要註冊的使用者定義 hook。

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

• with_kwargs (bool) – 如果為 true，則 hook 將會被傳遞給 forward 函式的 kwargs。預設值： False

傳回:

一個控制代柄 (handle)，可用於通過呼叫 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 是包含相對於輸入和輸出的梯度的元組。 Hook 不應修改其參數，但可以選擇性地傳回相對於輸入的新梯度，該梯度將用於後續計算中，以取代 grad_input。 grad_input 只會對應到作為位置參數給定的輸入，所有關鍵字參數 (kwarg) 都會被忽略。 對於所有非 Tensor 參數，grad_input 和 grad_output 中的條目將會是 None。

由於技術原因，當此 hook 應用於 Module 時，其 forward 函數將接收傳遞給 Module 的每個 Tensor 的視圖 (view)。 同樣地，呼叫者 (caller) 將接收由 Module 的 forward 函數傳回的每個 Tensor 的視圖。

警告

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

參數:

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

• prepend (bool) – 如果為 true，提供的 hook 將在本 torch.nn.modules.Module 上的所有現有 backward hooks 之前觸發。 否則，提供的 hook 將在本 torch.nn.modules.Module 上的所有現有 backward hooks 之後觸發。 請注意，使用 register_module_full_backward_hook() 註冊的全域 backward hooks 將在由此方法註冊的所有 hooks 之前觸發。

傳回:

一個控制代柄 (handle)，可用於通過呼叫 handle.remove() 來移除已新增的鉤子。

傳回類型:

torch.utils.hooks.RemovableHandle

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

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

每次計算模組的梯度時都會呼叫此 hook。 此 hook 應具有以下簽名：

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

grad_output 是一個元組。 Hook 不應修改其參數，但可以選擇性地傳回相對於輸出的新梯度，該梯度將用於後續計算中，以取代 grad_output。 對於所有非 Tensor 參數，grad_output 中的條目將會是 None。

由於技術原因，當此 hook 應用於 Module 時，其 forward 函數將接收傳遞給 Module 的每個 Tensor 的視圖 (view)。 同樣地，呼叫者 (caller) 將接收由 Module 的 forward 函數傳回的每個 Tensor 的視圖。

警告

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

參數:

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

• prepend (bool) – 如果為 true，提供的 hook 將在本 torch.nn.modules.Module 上的所有現有 backward_pre hooks 之前觸發。 否則，提供的 hook 將在本 torch.nn.modules.Module 上的所有現有 backward_pre hooks 之後觸發。 請注意，使用 register_module_full_backward_pre_hook() 註冊的全域 backward_pre hooks 將在由此方法註冊的所有 hooks 之前觸發。

傳回:

一個控制代柄 (handle)，可用於通過呼叫 handle.remove() 來移除已新增的鉤子。

傳回類型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_post_hook(hook)

註冊一個 post-hook，在呼叫模組的 load_state_dict() 之後執行。

它應該具有以下簽名：

hook(module, incompatible_keys) -> None

module 參數是此 hook 註冊所在的當前模組，而 incompatible_keys 參數是一個 NamedTuple，包含 missing_keys 和 unexpected_keys 屬性。missing_keys 是一個 str 的 list，包含遺失的鍵，而 unexpected_keys 是一個 str 的 list，包含未預期的鍵。

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

請注意，使用 strict=True 呼叫 load_state_dict() 時執行的檢查會受到 hook 對 missing_keys 或 unexpected_keys 所做修改的影響，正如預期的那樣。新增到任一組鍵將導致在 strict=True 時拋出錯誤，而清除遺失和未預期的鍵將避免錯誤。

傳回:

一個控制代柄 (handle)，可用於通過呼叫 handle.remove() 來移除已新增的鉤子。

傳回類型:

torch.utils.hooks.RemovableHandle

register_load_state_dict_pre_hook(hook)

註冊一個 pre-hook，使其在模組的 load_state_dict() 被呼叫之前執行。

它應該具有以下簽名：

hook(module, state_dict, prefix, local_metadata, strict, missing_keys, unexpected_keys, error_msgs) -> None # noqa: B950

參數:

hook (Callable) – 將在載入 state dict 之前呼叫的可呼叫 hook。

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() 方法註冊一個 post-hook。

它應該具有以下簽名：

hook(module, state_dict, prefix, local_metadata) -> None

已註冊的 hook 可以就地修改 state_dict。

register_state_dict_pre_hook(hook)

為 state_dict() 方法註冊一個 pre-hook。

它應該具有以下簽名：

hook(module, prefix, keep_vars) -> None

已註冊的 hook 可用於在進行 state_dict 呼叫之前執行預處理。

requires_grad_(requires_grad: bool = True) → T

更改 autograd 是否應記錄此模組中參數的操作。

此方法就地設定參數的 requires_grad 屬性。

此方法有助於凍結模組的一部分以進行微調，或個別訓練模型的部分 (例如，GAN 訓練)。

有關 .requires_grad_() 與可能與之混淆的幾種相似機制之間的比較，請參閱本機停用梯度計算。

參數:

requires_grad (bool) – 是否自動微分 (autograd) 應該記錄此模組中參數上的操作。預設值：True。

傳回:

self

傳回類型:

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, optional) – 如果提供，模組的狀態將更新到字典中，並傳回相同的物件。否則，將建立並傳回 OrderedDict。預設值：None。

• prefix (str, optional) – 加到參數和緩衝區名稱的前綴，以組成 state_dict 中的鍵。預設值：''。

• keep_vars (bool, optional) – 預設情況下，狀態字典中傳回的 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 設定為 True 時，它會嘗試相對於 host 進行非同步轉換/移動（如果可能的話），例如，將具有釘選記憶體的 CPU Tensor 移動到 CUDA 裝置。

請參閱以下範例。

注意

此方法會就地修改模組。

參數:

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

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

• tensor (torch.Tensor) – Tensor，其 dtype 和裝置為此模組中所有參數和緩衝區的目標 dtype 和裝置

• memory_format (torch.memory_format) – 此模組中 4D 參數和緩衝區的目標記憶體格式（僅限關鍵字參數）

傳回:

self

傳回類型:

Module

範例

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

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

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

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

參數:

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

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

傳回:

self

傳回類型:

Module

train(mode: bool = True) → T

將模組設定為訓練模式。

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

參數:

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

傳回:

self

傳回類型:

Module

transform_done_spec(done_spec: TensorSpec) → TensorSpec

轉換 done spec，使產生的 spec 與轉換映射相符。

參數:

done_spec (TensorSpec) – 轉換前的 spec

傳回:

轉換後預期的 spec

transform_env_batch_size(batch_size: Size)

轉換父環境的批次大小。

transform_env_device(device: device)

轉換父環境的裝置。

transform_input_spec(input_spec: TensorSpec) → TensorSpec

轉換 input spec，使產生的 spec 與轉換映射相符。

參數:

input_spec (TensorSpec) – 轉換前的 spec

傳回:

轉換後預期的 spec

transform_observation_spec(observation_spec: TensorSpec) → TensorSpec

轉換 observation spec，使產生的 spec 與 transform mapping 相符。

參數:

observation_spec (TensorSpec) – transform 前的 spec

傳回:

轉換後預期的 spec

transform_output_spec(output_spec: Composite) → Composite

轉換 output spec，使產生的 spec 與 transform mapping 相符。

這個方法通常應該保持不變。 變更應使用 transform_observation_spec()、transform_reward_spec() 和 transformfull_done_spec() 來實作。 :param output_spec: transform 前的 spec :type output_spec: TensorSpec

傳回:

轉換後預期的 spec

transform_reward_spec(reward_spec: TensorSpec) → TensorSpec

轉換 reward spec，使產生的 spec 與 transform mapping 相符。

參數:

reward_spec (TensorSpec) – transform 前的 spec

傳回:

轉換後預期的 spec

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

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

注意

此方法會就地修改模組。

參數:

dst_type (type 或 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()。