torch.nn

这些是图表的构建基块

参数	一种张量，它被认为是模块参数。
未初始化参数	未初始化的参数。
未初始化缓冲区	未初始化的缓冲区。

容器

模块	所有神经网络模块的基础类。
顺序	顺序容器。
ModuleList	将子模块保存在列表中。
ModuleDict	将子模块保存在字典中。
ParameterList	将参数保存在列表中。
ParameterDict	将参数保存在字典中。

模块的全局挂钩

register_module_forward_pre_hook	为所有模块注册一个前向预挂钩。
register_module_forward_hook	为所有模块注册一个全局前向挂钩。
register_module_backward_hook	为所有模块注册一个反向挂钩。
register_module_full_backward_pre_hook	为所有模块注册一个反向预挂钩。
register_module_full_backward_hook	为所有模块注册一个反向挂钩。
register_module_buffer_registration_hook	为所有模块注册一个缓冲区注册挂钩。
register_module_module_registration_hook	为所有模块注册一个模块注册挂钩。
register_module_parameter_registration_hook	为所有模块注册一个参数注册挂钩。

卷积层

nn.Conv1d	对由多个输入平面组成的输入信号应用 1D 卷积。
nn.Conv2d	对由多个输入平面组成的输入信号应用 2D 卷积。
nn.Conv3d	对由多个输入平面组成的输入信号应用 3D 卷积。
nn.ConvTranspose1d	对由多个输入平面组成的输入图像应用 1D 转置卷积算子。
nn.ConvTranspose2d	对由多个输入平面组成的输入图像应用 2D 转置卷积算子。
nn.ConvTranspose3d	对由多个输入平面组成的输入图像应用 3D 转置卷积算子。
nn.LazyConv1d	一个 torch.nn.Conv1d 模块，其中 in_channels 参数的初始化是延迟的。
nn.LazyConv2d	一个 torch.nn.Conv2d 模块，其中 in_channels 参数的初始化是延迟的。
nn.LazyConv3d	一个 torch.nn.Conv3d 模块，对 in_channels 参数进行延迟初始化。
nn.LazyConvTranspose1d	一个 torch.nn.ConvTranspose1d 模块，对 in_channels 参数进行延迟初始化。
nn.LazyConvTranspose2d	一个 torch.nn.ConvTranspose2d 模块，对 in_channels 参数进行延迟初始化。
nn.LazyConvTranspose3d	一个 torch.nn.ConvTranspose3d 模块，对 in_channels 参数进行延迟初始化。
nn.Unfold	从批处理输入张量中提取滑动局部块。
nn.Fold	将滑动局部块数组合并到一个包含的大张量中。

池化层

nn.MaxPool1d	对由多个输入平面组成的输入信号应用 1D 最大池化。
nn.MaxPool2d	对由多个输入平面组成的输入信号应用 2D 最大池化。
nn.MaxPool3d	对由多个输入平面组成的输入信号应用 3D 最大池化。
nn.MaxUnpool1d	计算 MaxPool1d 的部分逆。
nn.MaxUnpool2d	计算 MaxPool2d 的部分逆。
nn.MaxUnpool3d	计算 MaxPool3d 的部分逆。
nn.AvgPool1d	对由多个输入平面组成的输入信号应用 1D 平均池化。
nn.AvgPool2d	对由多个输入平面组成的输入信号应用 2D 平均池化。
nn.AvgPool3d	对由多个输入平面组成的输入信号应用 3D 平均池化。
nn.FractionalMaxPool2d	对由多个输入平面组成的输入信号应用 2D 分数最大池化。
nn.FractionalMaxPool3d	对由多个输入平面组成的输入信号应用 3D 分数最大池化。
nn.LPPool1d	对由多个输入平面组成的输入信号应用 1D 幂平均池化。
nn.LPPool2d	对由多个输入平面组成的输入信号应用 2D 幂平均池化。
nn.LPPool3d	对由多个输入平面组成的输入信号应用 3D 幂平均池化。
nn.AdaptiveMaxPool1d	对由多个输入平面组成的输入信号应用 1D 自适应最大池化。
nn.AdaptiveMaxPool2d	对由多个输入平面组成的输入信号应用 2D 自适应最大池化。
nn.AdaptiveMaxPool3d	对由多个输入平面组成的输入信号应用 3D 自适应最大池化。
nn.AdaptiveAvgPool1d	对由多个输入平面组成的输入信号应用 1D 自适应平均池化。
nn.AdaptiveAvgPool2d	对由多个输入平面组成的输入信号应用 2D 自适应平均池化。
nn.AdaptiveAvgPool3d	对由多个输入平面组成的输入信号应用 3D 自适应平均池化。

填充层

nn.ReflectionPad1d	使用输入边界的反射填充输入张量。
nn.ReflectionPad2d	使用输入边界的反射填充输入张量。
nn.ReflectionPad3d	使用输入边界的反射填充输入张量。
nn.ReplicationPad1d	使用输入边界的复制填充输入张量。
nn.ReplicationPad2d	使用输入边界的复制填充输入张量。
nn.ReplicationPad3d	使用输入边界的复制填充输入张量。
nn.ZeroPad1d	使用零填充输入张量边界。
nn.ZeroPad2d	使用零填充输入张量边界。
nn.ZeroPad3d	使用零填充输入张量边界。
nn.ConstantPad1d	使用常量值填充输入张量边界。
nn.ConstantPad2d	使用常量值填充输入张量边界。
nn.ConstantPad3d	使用常量值填充输入张量边界。
nn.CircularPad1d	使用输入边界的循环填充填充输入张量。
nn.CircularPad2d	使用输入边界的循环填充填充输入张量。
nn.CircularPad3d	使用输入边界的循环填充填充输入张量。

非线性激活（加权和，非线性）

nn.ELU	逐个元素应用指数线性单元 (ELU) 函数。
nn.Hardshrink	逐个元素应用硬收缩 (Hardshrink) 函数。
nn.Hardsigmoid	逐个元素应用硬 Sigmoid 函数。
nn.Hardtanh	逐个元素应用硬双曲正切函数。
nn.Hardswish	逐元素应用 Hardswish 函数。
nn.LeakyReLU	逐元素应用 LeakyReLU 函数。
nn.LogSigmoid	逐元素应用 Logsigmoid 函数。
nn.MultiheadAttention	允许模型联合关注来自不同表示子空间的信息。
nn.PReLU	应用逐元素 PReLU 函数。
nn.ReLU	逐元素应用修正线性单元函数。
nn.ReLU6	逐元素应用 ReLU6 函数。
nn.RReLU	逐元素应用随机修正线性修正线性单元函数。
nn.SELU	逐元素应用 SELU 函数。
nn.CELU	逐元素应用 CELU 函数。
nn.GELU	应用高斯误差线性单元函数。
nn.Sigmoid	逐元素应用 Sigmoid 函数。
nn.SiLU	逐元素应用 Sigmoid 线性单元 (SiLU) 函数。
nn.Mish	逐元素应用 Mish 函数。
nn.Softplus	逐元素应用 Softplus 函数。
nn.Softshrink	逐元素应用软收缩函数。
nn.Softsign	逐元素应用 Softsign 函数。
nn.Tanh	逐元素应用双曲正切 (Tanh) 函数。
nn.Tanhshrink	逐元素应用 Tanhshrink 函数。
nn.Threshold	对输入张量的每个元素进行阈值处理。
nn.GLU	应用门控线性单元函数。

非线性激活（其他）

nn.Softmin	对 n 维输入张量应用 Softmin 函数。
nn.Softmax	对 n 维输入张量应用 Softmax 函数。
nn.Softmax2d	对每个空间位置的特征应用 SoftMax。
nn.LogSoftmax	对 n 维输入张量应用 $\log(\text{Softmax}(x))$ 函数。
nn.AdaptiveLogSoftmaxWithLoss	高效的 softmax 近似。

归一化层

nn.BatchNorm1d	对 2D 或 3D 输入应用批归一化。
nn.BatchNorm2d	对 4D 输入应用批归一化。
nn.BatchNorm3d	对 5D 输入应用批归一化。
nn.LazyBatchNorm1d	具有延迟初始化的 torch.nn.BatchNorm1d 模块。
nn.LazyBatchNorm2d	具有延迟初始化的 torch.nn.BatchNorm2d 模块。
nn.LazyBatchNorm3d	具有延迟初始化的 torch.nn.BatchNorm3d 模块。
nn.GroupNorm	对小批量输入应用组归一化。
nn.SyncBatchNorm	对 N 维输入应用批归一化。
nn.InstanceNorm1d	应用实例归一化。
nn.InstanceNorm2d	应用实例归一化。
nn.InstanceNorm3d	应用实例归一化。
nn.LazyInstanceNorm1d	具有 num_features 参数延迟初始化的 torch.nn.InstanceNorm1d 模块。
nn.LazyInstanceNorm2d	具有 num_features 参数延迟初始化的 torch.nn.InstanceNorm2d 模块。
nn.LazyInstanceNorm3d	具有 num_features 参数延迟初始化的 torch.nn.InstanceNorm3d 模块。
nn.LayerNorm	对小批量输入应用层归一化。
nn.LocalResponseNorm	对输入信号应用局部响应归一化。

循环层

nn.RNNBase	RNN 模块（RNN、LSTM、GRU）的基类。
nn.RNN	将多层 Elman RNN 应用于输入序列，具有 $\tanh$ 或 $\text{ReLU}$ 非线性。
nn.LSTM	将多层长短期记忆 (LSTM) RNN 应用于输入序列。
nn.GRU	将多层门控循环单元 (GRU) RNN 应用于输入序列。
nn.RNNCell	具有 tanh 或 ReLU 非线性的 Elman RNN 单元。
nn.LSTMCell	长短期记忆 (LSTM) 单元。
nn.GRUCell	门控循环单元 (GRU) 单元。

Transformer 层

nn.Transformer	Transformer 模型。
nn.TransformerEncoder	TransformerEncoder 是 N 个编码器层的堆栈。
nn.TransformerDecoder	TransformerDecoder 是 N 个解码器层的堆栈。
nn.TransformerEncoderLayer	TransformerEncoderLayer 由自注意力和前馈网络组成。
nn.TransformerDecoderLayer	TransformerDecoderLayer 由自注意力、多头注意力和前馈网络组成。

线性层

nn.Identity	一个占位符标识符运算符，与参数无关。
nn.Linear	对输入数据应用线性变换：$y = xA^T + b$.
nn.Bilinear	对输入数据应用双线性变换：$y = x_1^T A x_2 + b$.
nn.LazyLinear	一个 torch.nn.Linear 模块，其中 in_features 是推断的。

Dropout 层

nn.Dropout	在训练期间，使用概率 p 随机将输入张量中的一些元素归零。
nn.Dropout1d	随机将整个通道归零。
nn.Dropout2d	随机将整个通道归零。
nn.Dropout3d	随机将整个通道归零。
nn.AlphaDropout	对输入应用 Alpha Dropout。
nn.FeatureAlphaDropout	随机屏蔽整个通道。

稀疏层

nn.Embedding	一个简单的查找表，用于存储固定词典和大小的嵌入。
nn.EmbeddingBag	计算“嵌入包”的总和或平均值，而不实例化中间嵌入。

距离函数

nn.CosineSimilarity	返回 $x_1$ 和 $x_2$ 之间的余弦相似性，沿着 dim 计算。
nn.PairwiseDistance	计算输入向量之间的成对距离，或输入矩阵的列之间的成对距离。

损失函数

nn.L1Loss	创建一个准则，用于测量输入 $x$ 中的每个元素和目标 $y$ 之间的平均绝对误差 (MAE)。
nn.MSELoss	创建一种准则，测量输入 $x$ 和目标 $y$ 中每个元素之间的均方误差（平方 L2 范数）。
nn.CrossEntropyLoss	此准则计算输入 logits 和目标之间的交叉熵损失。
nn.CTCLoss	连接主义时序分类损失。
nn.NLLLoss	负对数似然损失。
nn.PoissonNLLLoss	目标的泊松分布的负对数似然损失。
nn.GaussianNLLLoss	高斯负对数似然损失。
nn.KLDivLoss	Kullback-Leibler 散度损失。
nn.BCELoss	创建一种准则，测量目标和输入概率之间的二元交叉熵
nn.BCEWithLogitsLoss	此损失将 Sigmoid 层和 BCELoss 合并到一个单一类中。
nn.MarginRankingLoss	创建一种准则，测量给定输入 $x1$, $x2$, 两个 1D 小批量或 0D 张量以及标签 1D 小批量或 0D 张量 $y$（包含 1 或 -1）的损失。
nn.HingeEmbeddingLoss	测量给定输入张量 $x$ 和标签张量 $y$（包含 1 或 -1）的损失。
nn.MultiLabelMarginLoss	创建优化输入 $x$（一个 2D 小批量 Tensor）和输出 $y$（一个目标类索引的 2D Tensor）之间的多类多分类铰链损失（基于边界的损失）的准则。
nn.HuberLoss	创建一个准则，如果绝对逐元素误差低于 delta，则使用平方项，否则使用 delta 缩放的 L1 项。
nn.SmoothL1Loss	创建一个准则，如果绝对逐元素误差低于 beta，则使用平方项，否则使用 L1 项。
nn.SoftMarginLoss	创建一个准则，优化输入张量 $x$ 和目标张量 $y$（包含 1 或 -1）之间的两类分类逻辑损失。
nn.MultiLabelSoftMarginLoss	创建一个准则，优化基于最大熵的多标签一对多损失，输入为 $x$，目标为 $y$，大小为 $(N, C)$.
nn.CosineEmbeddingLoss	创建一个衡量给定输入张量 $x_1$, $x_2$ 和 Tensor 标签 $y$ 的损失的标准，其中值是 1 或 -1。
nn.MultiMarginLoss	创建一个优化输入$x$（一个 2D 小批量Tensor）和输出$y$（这是一个目标类别索引的 1D 张量，$0 \leq y \leq \text{x.size}(1)-1$）之间的多类别分类铰链损失（基于边界的损失）的标准。
nn.TripletMarginLoss	创建一个标准，用于测量给定输入张量$x1$, $x2$, $x3$和一个大于$0$的值的边界的损失。
nn.TripletMarginWithDistanceLoss	创建一个标准，用于衡量给定张量 $a$、$p$ 和 $n$（分别表示锚点、正例和负例）的 triplet loss，以及一个非负实值函数（“距离函数”），用于计算锚点和正例之间的关系（“正距离”）以及锚点和负例之间的关系（“负距离”）。

视觉层

nn.PixelShuffle	根据上采样因子重新排列张量中的元素。
nn.PixelUnshuffle	反转 PixelShuffle 操作。
nn.Upsample	对给定的多通道 1D（时间）、2D（空间）或 3D（体积）数据进行上采样。
nn.UpsamplingNearest2d	对由多个输入通道组成的输入信号应用 2D 最近邻上采样。
nn.UpsamplingBilinear2d	对由多个输入通道组成的输入信号应用 2D 双线性上采样。

Shuffle 层

nn.ChannelShuffle

分割和重新排列张量中的通道。

DataParallel 层（多 GPU，分布式）

nn.DataParallel	在模块级别实现数据并行性。
nn.parallel.DistributedDataParallel	在模块级别基于 torch.distributed 实现分布式数据并行性。

实用工具

来自 torch.nn.utils 模块

用于剪切参数梯度的实用函数。

clip_grad_norm_	剪切参数的可迭代梯度范数。
clip_grad_norm	剪切参数的可迭代梯度范数。
clip_grad_value_	将可迭代参数的梯度剪切到指定值。

用于将模块参数展平和从单个向量中取消展平的实用函数。

parameters_to_vector	将可迭代参数展平到单个向量中。
vector_to_parameters	将向量的切片复制到可迭代参数中。

用于将模块与 BatchNorm 模块融合的实用函数。

fuse_conv_bn_eval	将卷积模块和 BatchNorm 模块融合到单个新卷积模块中。
fuse_conv_bn_weights	将卷积模块参数和 BatchNorm 模块参数融合到新的卷积模块参数中。
fuse_linear_bn_eval	将线性模块和 BatchNorm 模块融合到单个新线性模块中。
fuse_linear_bn_weights	将线性模块参数和 BatchNorm 模块参数融合到新的线性模块参数中。

用于转换模块参数内存格式的实用函数。

convert_conv2d_weight_memory_format	将 nn.Conv2d.weight 的 memory_format 转换为 memory_format。
convert_conv3d_weight_memory_format	将 nn.Conv3d.weight 的 memory_format 转换为 memory_format 该转换递归应用于嵌套的 nn.Module，包括 module。

用于对模块参数应用和移除权重归一化的实用函数。

weight_norm	对给定模块中的参数应用权重归一化。
remove_weight_norm	从模块中移除权重归一化重新参数化。
spectral_norm	对给定模块中的参数应用频谱归一化。
remove_spectral_norm	从模块中移除频谱归一化重新参数化。

用于初始化模块参数的实用函数。

skip_init

给定模块类对象和参数/关键字参数，在不初始化参数/缓冲区的情况下实例化模块。

用于修剪模块参数的实用类和函数。

prune.BasePruningMethod	创建新修剪技术的抽象基类。
prune.PruningContainer	用于迭代修剪的容器，其中包含一系列修剪方法。
prune.Identity	实用修剪方法，不会修剪任何单元，但会使用全 1 掩码生成修剪参数化。
prune.RandomUnstructured	随机修剪张量中（当前未修剪的）单元。
prune.L1Unstructured	通过将 L1 范数最低的单元归零，修剪张量中（当前未修剪的）单元。
prune.RandomStructured	随机修剪张量中（当前未修剪的）整个通道。
prune.LnStructured	根据其 Ln 范数，修剪张量中（当前未修剪的）整个通道。
prune.CustomFromMask
prune.identity	应用修剪重新参数化，而不修剪任何单元。
prune.random_unstructured	通过移除随机（当前未修剪的）单元来修剪张量。
prune.l1_unstructured	通过移除 L1 范数最低的单元来修剪张量。
prune.random_structured	通过移除沿指定维度随机的通道来修剪张量。
prune.ln_structured	通过移除沿指定维度 Ln 范数最低的通道来修剪张量。
prune.global_unstructured	通过应用指定的 pruning_method，全局修剪与 parameters 中所有参数对应的张量。
prune.custom_from_mask	通过在 mask 中应用预先计算的掩码，修剪 module 中名为 name 的参数对应的张量。
prune.remove	从模块中移除修剪重新参数化，并从前向挂钩中移除修剪方法。
prune.is_pruned	通过查找修剪预挂钩来检查模块是否已修剪。

使用 torch.nn.utils.parameterize.register_parametrization() 中的新参数化功能实现的参数化。

parametrizations.orthogonal	对矩阵或一批矩阵应用正交或酉参数化。
parametrizations.weight_norm	对给定模块中的参数应用权重归一化。
parametrizations.spectral_norm	对给定模块中的参数应用频谱归一化。

用于对现有模块中的张量进行参数化的实用函数。请注意，这些函数可用于对给定的参数或缓冲区进行参数化，前提是给定一个从输入空间映射到参数化空间的特定函数。它们不是将对象转换为参数的参数化。有关如何实现自己的参数化的更多信息，请参阅参数化教程。

parametrize.register_parametrization	向模块中的张量注册参数化。
parametrize.remove_parametrizations	移除模块中张量上的参数化。
parametrize.cached	上下文管理器，可在使用 register_parametrization() 注册的参数化中启用缓存系统。
parametrize.is_parametrized	确定模块是否具有参数化。

parametrize.ParametrizationList

一个顺序容器，用于保存和管理参数化 torch.nn.Module 的原始参数或缓冲区。

以无状态方式调用给定模块的实用函数。

stateless.functional_call

通过用提供的参数和缓冲区替换模块参数和缓冲区，对模块执行功能调用。

其他模块中的实用函数

nn.utils.rnn.PackedSequence	保存打包序列的数据和 batch_sizes 列表。
nn.utils.rnn.pack_padded_sequence	打包包含可变长度填充序列的张量。
nn.utils.rnn.pad_packed_sequence	填充一批可变长度序列。
nn.utils.rnn.pad_sequence	使用 padding_value 填充可变长度张量列表。
nn.utils.rnn.pack_sequence	打包可变长度张量列表。
nn.utils.rnn.unpack_sequence	将 PackedSequence 解包为可变长度张量列表。
nn.utils.rnn.unpad_sequence	将填充的张量解包为可变长度张量列表。

nn.Flatten	将连续范围的维度展平为一个张量。
nn.Unflatten	将张量维度展平，将其扩展为所需形状。

量化函数

量化是指以低于浮点精度的位宽执行计算和存储张量的技术。PyTorch 支持按张量和按通道非对称线性量化。要了解如何在 PyTorch 中使用量化函数，请参阅 量化 文档。

延迟模块初始化

nn.modules.lazy.LazyModuleMixin

用于延迟初始化参数（也称为“延迟模块”）的模块的混合。