torch#
创建日期:2016 年 12 月 23 日 | 最后更新日期:2025 年 7 月 22 日
torch 包包含多维张量的数据结构,并定义了这些张量上的数学运算。此外,它还提供了许多用于高效序列化张量和任意类型的实用工具,以及其他有用的工具。
它有一个 CUDA 对应项,可让您在计算能力 >= 3.0 的 NVIDIA GPU 上运行张量计算。
张量#
如果 obj 是 PyTorch 张量,则返回 True。 |
|
如果 obj 是 PyTorch 存储对象,则返回 True。 |
|
如果 |
|
如果 |
|
如果 |
|
如果 |
|
将默认浮点 dtype 设置为 |
|
获取当前的默认浮点 |
|
将默认 |
|
获取默认 |
|
|
|
设置打印选项。 |
|
禁用 CPU 上的 denormal 浮点数。 |
创建操作#
注意
随机采样创建操作列在 随机采样 下,包括: torch.rand() torch.rand_like() torch.randn() torch.randn_like() torch.randint() torch.randint_like() torch.randperm() 您也可以使用 torch.empty() 和 原地随机采样 方法来创建从更广泛的分布中采样的 torch.Tensor。
通过复制 |
|
使用指定的 |
|
使用指定的 |
|
使用指定的 |
|
使用指定的 2 维块(在 |
|
使用指定的 2 维块(在 |
|
将 |
|
将 |
|
使用指定的 |
|
创建一个以内存映射文件为后备的 CPU 张量。 |
|
从 |
|
将外部库中的张量转换为 |
|
从实现了 Python 缓冲区协议的对象创建一维 |
|
返回一个填充了标量值 0 的张量,其形状由可变参数 |
|
返回一个填充了标量值 0 的张量,其大小与 |
|
返回一个填充了标量值 1 的张量,其形状由可变参数 |
|
返回一个填充了标量值 1 的张量,其大小与 |
|
返回一个大小为 的一维张量,其值在 |
|
返回一个大小为 的一维张量,其值从 |
|
创建一个大小为 |
|
创建一个大小为 |
|
返回一个二维张量,对角线上为 1,其余为 0。 |
|
返回一个包含未初始化数据的张量。 |
|
返回一个大小与 |
|
创建一个具有指定 |
|
创建一个大小为 |
|
返回一个大小与 |
|
将浮点张量转换为具有给定缩放和零点的量化张量。 |
|
将浮点张量转换为具有给定缩放和零点的逐通道量化张量。 |
|
通过对量化张量进行反量化,返回一个fp32张量。 |
|
计算 |
索引、切片、连接、变异操作#
返回共轭且最后两个维度转置的张量视图。 |
|
返回一个包含 |
|
沿着给定维度连接 |
|
|
|
|
|
返回一个具有翻转共轭位的 |
|
尝试将张量分割成指定数量的块。 |
|
根据 |
|
通过水平堆叠 |
|
按顺序按深度方向(沿第三个轴)堆叠张量。 |
|
沿由 dim 指定的轴收集值。 |
|
根据 |
|
按水平(列方向)顺序堆叠张量。 |
|
参见 |
|
参见 |
|
参见 |
|
返回一个新的张量,该张量使用 |
|
返回一个新的 1D 张量,该张量根据布尔掩码 |
|
将 |
|
|
|
返回一个更窄的 |
|
与 |
|
返回 |
|
返回一个与 |
|
|
|
沿所选维度在给定索引处切片 |
|
|
|
将 |
|
将 |
|
将 |
|
|
|
|
|
沿指定轴对输入张量执行分段归约操作。 |
|
将张量分割成块。 |
|
返回一个张量,其中 |
|
沿新维度连接一系列张量。 |
|
|
|
|
|
期望 |
|
返回一个包含 |
|
在给定 |
|
沿维度 |
|
通过重复 |
|
返回 |
|
移除张量维度。 |
|
将平坦索引张量转换为坐标张量元组,这些元组可以索引到任意指定形状的张量。 |
|
返回一个新的张量,在指定位置插入一个大小为一的维度。 |
|
根据 |
|
按垂直(行方向)顺序堆叠张量。 |
|
根据 |
加速器#
在 PyTorch 仓库中,我们将“加速器”定义为与 CPU 一起用于加速计算的 torch.device。这些设备使用异步执行方案,通过 torch.Stream 和 torch.Event 作为同步的主要方式。我们还假设每个主机上一次只能有一个此类加速器。这使我们可以将当前加速器用作相关概念(例如,固定内存、流设备类型、FSDP 等)的默认设备。
目前,加速器设备包括(排名不分先后):“CUDA”、“MTIA”、“XPU”、“MPS”、“HPU”和 PrivateUse1(许多不是 PyTorch 仓库本身提供的设备)。
PyTorch 生态系统中的许多工具都使用 fork 来创建子进程(例如,数据加载或内部并行化),因此,尽可能延迟任何会阻止进一步 fork 的操作非常重要。这在这里尤其重要,因为大多数加速器的初始化都会产生此类影响。实际上,您应该记住,默认情况下,检查 torch.accelerator.current_accelerator() 是编译时检查,因此始终是 fork 安全的。相反,将 check_available=True 标志传递给此函数或调用 torch.accelerator.is_available() 通常会阻止后续的 fork。
一些后端提供了一个实验性的选择加入选项,以使运行时可用性检查成为 fork 安全的。例如,在使用 CUDA 设备时,可以使用 PYTORCH_NVML_BASED_CUDA_CHECK=1。
随机采样#
将生成随机数的种子设置为所有设备上的非确定性随机数。 |
|
设置所有设备上生成随机数的种子。 |
|
返回生成随机数的初始种子,作为Python long类型。 |
|
将随机数生成器状态作为torch.ByteTensor返回。 |
|
设置随机数生成器状态。 |
- torch.default_generator 返回 默认 CPU torch.Generator#
从伯努利分布中抽取二元随机数(0 或 1)。 |
|
返回一个张量,其中每行包含从 |
|
返回一个张量,其中包含从具有给定均值和标准差的独立正态分布中抽取的随机数。 |
|
返回一个与 |
|
返回一个张量,其中填充了从区间 上的均匀分布中抽取的随机数。 |
|
返回一个大小与 |
|
返回一个张量,其中填充了在 |
|
返回一个形状与张量 |
|
返回一个张量,其中填充了从均值为 0、方差为 1 的正态分布(也称为标准正态分布)中抽取的随机数。 |
|
返回一个大小与 |
|
返回从 |
原地随机采样#
张量上还定义了几种原地随机采样函数。点击查看它们的文档:
torch.Tensor.cauchy_()- 从柯西分布中抽取的数字。torch.Tensor.exponential_()- 从指数分布中抽取的数字。torch.Tensor.geometric_()- 从几何分布中抽取的元素。torch.Tensor.log_normal_()- 从对数正态分布中采样。torch.Tensor.normal_()-torch.normal()的原地版本。torch.Tensor.random_()- 从离散均匀分布中抽样的数字。torch.Tensor.uniform_()- 从连续均匀分布中抽样的数字。
拟随机采样#
|
序列化#
将对象保存到磁盘文件。 |
|
从文件加载使用 |
并行性#
返回用于并行化 CPU 操作的线程数。 |
|
设置 CPU 上内部并行化使用的线程数。 |
|
返回 CPU 上交互并行化使用的线程数(例如。 |
|
设置交互并行化使用的线程数(例如。 |
局部禁用梯度计算#
上下文管理器 torch.no_grad()、torch.enable_grad() 和 torch.set_grad_enabled() 有助于在局部禁用和启用梯度计算。有关其用法的更多详细信息,请参见 局部禁用梯度计算。这些上下文管理器是线程局部的,因此如果使用 threading 模块等将工作发送到另一个线程,它们将不起作用。
示例
>>> x = torch.zeros(1, requires_grad=True)
>>> with torch.no_grad():
... y = x * 2
>>> y.requires_grad
False
>>> is_train = False
>>> with torch.set_grad_enabled(is_train):
... y = x * 2
>>> y.requires_grad
False
>>> torch.set_grad_enabled(True) # this can also be used as a function
>>> y = x * 2
>>> y.requires_grad
True
>>> torch.set_grad_enabled(False)
>>> y = x * 2
>>> y.requires_grad
False
禁用梯度计算的上下文管理器。 |
|
启用梯度计算的上下文管理器。 |
|
启用或禁用梯度计算的上下文管理器。 |
|
如果当前启用了 grad 模式,则返回 True。 |
|
启用或禁用推理模式的上下文管理器。 |
|
如果当前启用了推理模式,则返回 True。 |
数学运算#
常量#
|
正无穷大浮点数。 |
|
“非数字”浮点值。该值不是合法的数字。 |
逐点操作#
计算 |
|
|
|
计算 |
|
|
|
返回一个新张量,其中包含 |
|
|
|
将 |
|
执行 |
|
执行 |
|
计算给定 |
|
返回一个新张量,其中包含 |
|
|
|
返回一个新张量,其中包含 |
|
|
|
返回一个新张量,其中包含 |
|
|
|
返回一个新张量,其中包含 |
|
|
|
考虑象限的 的逐元素反正切。 |
|
|
|
计算给定输入张量的按位非。 |
|
计算 |
|
计算 |
|
计算 |
|
计算 |
|
计算 |
|
返回一个新张量,其中包含 |
|
|
|
计算给定 |
|
创建一个新的浮点张量,其幅度来自 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中 |
|
将输入 |
|
|
|
|
|
|
|
返回一个新张量,其元素是输入张量 |
|
|
|
返回一个新的张量,其中 |
|
返回一个新的张量,其中 |
|
|
|
以双精度计算 |
|
返回一个新张量,其中包含 |
|
应用 C++ 的 std::fmod 入门。 |
|
计算 |
|
将 |
|
使用 二阶精确中心差分法 以及边界处的至少一阶或二阶估计,估计函数 的梯度。 |
|
返回包含 |
|
将 |
|
对两个张量 |
|
计算 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含(1 + |
|
返回一个新张量,其中包含 |
|
输入指数和的对数。 |
|
以2为底的输入指数和的对数。 |
|
计算给定输入张量的逐元素逻辑 AND。 |
|
计算给定输入张量的逐元素逻辑 NOT。 |
|
计算给定输入张量的逐元素逻辑 OR。 |
|
计算给定输入张量的逐元素逻辑 XOR。 |
|
给定直角三角形的两条直角边,返回其斜边。 |
|
|
|
将 |
|
|
|
将 |
|
返回一个新张量,其中包含 |
|
|
|
返回 |
|
返回 |
|
计算 |
|
对 4D(NCHW)量化张量应用批量归一化。 |
|
对由多个输入平面组成的输入量化张量应用 1D 最大池化。 |
|
对由多个输入平面组成的输入量化张量应用 2D 最大池化。 |
|
返回一个新张量,其中 |
|
返回包含 |
|
返回一个新张量,其中包含 |
|
计算 Python 的模运算入门。 |
|
将 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 |
|
此函数是 torch.sign() 对复数张量的扩展。 |
|
测试 |
|
返回一个新张量,其中包含 |
|
|
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 |
|
从 |
|
|
|
返回一个新张量,其中包含 |
|
返回一个新张量,其元素是 |
|
|
|
返回一个新张量,其中包含 |
|
归约操作#
返回 |
|
返回扁平张量或沿某一维度的最小值的索引 |
|
在给定维度 |
|
在给定维度 |
|
计算 |
|
测试 |
|
测试 |
|
返回 |
|
返回 |
|
返回 ( |
|
返回给定维度 |
|
计算指定维度上所有 非 NaN 元素的平均值。 |
|
返回 |
|
返回 |
|
返回一个命名元组 |
|
返回给定张量的矩阵范数或向量范数。 |
|
返回所有元素的和,将非数字 (NaN) 视为零。 |
|
返回 |
|
计算 |
|
这是 |
|
计算指定维度 |
|
计算指定维度 |
|
返回 |
|
返回输入张量的唯一元素。 |
|
从每个连续的等效元素组中删除除第一个元素之外的所有元素。 |
|
计算指定维度 |
|
计算指定维度 |
|
计算给定维度 |
|
返回 |
比较运算符#
此函数检查 |
|
根据值按升序返回沿给定维度排序张量的索引。 |
|
计算逐元素相等 |
|
如果两个张量具有相同的大小和元素,则为 |
|
逐元素计算 。 |
|
|
|
逐元素计算 。 |
|
|
|
返回一个新的布尔元素张量,表示 |
|
返回一个新的布尔元素张量,表示每个元素是否是 有限的。 |
|
测试 |
|
测试 |
|
测试 |
|
测试 |
|
返回一个新的布尔元素张量,表示 |
|
返回一个新的布尔元素张量,表示 |
|
返回一个命名元组 |
|
逐元素计算 。 |
|
|
|
逐元素计算 。 |
|
|
|
计算 |
|
计算 |
|
计算 |
|
计算 |
|
逐元素计算 。 |
|
|
|
沿给定维度按值升序对 |
|
返回给定 |
|
沿第一维度对 |
频谱运算#
短时傅里叶变换 (STFT)。 |
|
逆短时傅里叶变换。 |
|
Bartlett 窗函数。 |
|
Blackman 窗函数。 |
|
Hamming 窗函数。 |
|
Hann 窗函数。 |
|
计算具有窗口长度 |
其他运算#
返回每个输入张量的一维视图,其中零维度。 |
|
返回每个输入张量的二维视图,其中零维度。 |
|
返回每个输入张量的三维视图,其中零维度。 |
|
计算非负整数数组中每个值的频率。 |
|
从提供的张量创建块对角矩阵。 |
|
根据 广播语义 广播给定的张量。 |
|
将 |
|
与 |
|
返回 |
|
对给定的张量序列进行笛卡尔积。 |
|
计算两个行向量集合之间每对向量的 p-范数距离(批处理)。 |
|
返回 |
|
计算给定张量长度为 的组合。 |
|
估计变量的皮尔逊积矩相关系数矩阵,变量由 |
|
估计变量的协方差矩阵,变量由 |
|
返回 |
|
返回一个命名元组 |
|
返回一个命名元组 |
|
返回 |
|
返回 |
|
|
|
创建一个张量,其指定的 2D 平面的对角线(由 |
|
|
|
返回 |
|
计算沿给定维度的 n 阶前向差分。 |
|
使用基于爱因斯坦求和约定的符号,对输入 |
|
通过将 |
|
沿给定轴 |
|
左右翻转张量,返回一个新张量。 |
|
上下翻转张量,返回一个新张量。 |
|
计算 |
|
将 n 维张量在由 |
|
计算 |
|
计算张量的直方图。 |
|
计算张量中值的直方图。 |
|
计算张量中值的多维直方图。 |
|
创建由 attr:tensors 中一维输入指定的坐标网格。 |
|
计算 |
|
返回 |
|
返回一个连续的展平张量。 |
|
返回一个张量,其中 |
|
重复张量的元素。 |
|
沿给定维度(们)滚动 |
|
从 |
|
返回 |
|
返回输入 2D 矩阵对角线元素的和。 |
|
返回矩阵(2D 张量)或矩阵批次的下三角部分 |
|
返回 |
|
返回矩阵(2D 张量)或矩阵批次的上三角部分 |
|
返回 |
|
将输入张量的某个维度扩展到多个维度。 |
|
生成 Vandermonde 矩阵。 |
|
返回 |
|
返回 |
|
如果 |
|
如果 |
BLAS 和 LAPACK 运算#
执行存储在 |
|
执行 |
|
执行 |
|
计算向量 |
|
执行 |
|
执行存储在 |
|
返回 个 2D 张量的矩阵乘积。 |
|
计算对称正定矩阵 或对称正定矩阵批次的乔里斯基分解。 |
|
在已知其乔里斯基分解的情况下,计算复数厄米或实数对称正定矩阵的逆。 |
|
在已知其乔里斯基分解的情况下,计算具有复数厄米或实数对称正定左侧的线性方程组的解。 |
|
计算两个一维张量的点积。 |
|
这是一个直接调用 LAPACK geqrf 的低级函数。 |
|
|
|
计算一维张量的点积。 |
|
|
|
|
|
计算方阵或方阵批次的对数行列式。 |
|
计算矩阵或矩阵批次 |
|
使用 |
|
将 |
|
两个张量的矩阵乘积。 |
|
执行 |
|
执行 |
|
计算豪斯霍尔德矩阵乘积与一般矩阵的矩阵-矩阵乘积。 |
|
|
|
|
|
计算矩阵或矩阵批次 |
|
计算矩阵或矩阵批次 |
|
返回矩阵、矩阵批次或稀疏矩阵 的奇异值分解 |
|
对低秩矩阵、此类矩阵的批次或稀疏矩阵执行线性主成分分析 (PCA)。 |
|
使用无矩阵 LOBPCG 方法查找对称正定广义特征值问题的前 k 个最大(或最小)特征值及其对应的特征向量。 |
|
|
|
沿 |
|
沿 |
|
求解具有方阵上下三角可逆矩阵 和多个右侧项 的方程组。 |
|
计算两个一维向量沿一个维度的点积。 |
Foreach 运算#
警告
此 API 处于 beta 阶段,未来可能有所更改。不支持前向模式 AD。
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
工具#
返回 PyTorch 是否使用 _GLIBCXX_USE_CXX11_ABI=1 构建。 |
|
返回在对提供的输入张量执行算术运算时将产生的结果 |
|
根据 PyTorch 类型提升 文档 中描述的类型提升规则,确定是否允许类型转换。 |
|
返回大小和标量类型最小的 |
|
设置 PyTorch 运算是否必须使用“确定性”算法。 |
|
如果全局确定性标志已打开,则返回 True。 |
|
如果全局确定性标志设置为仅警告,则返回 True。 |
|
设置确定性运算的调试模式。 |
|
返回确定性运算调试模式的当前值。 |
|
设置 float32 矩阵乘法的内部精度。 |
|
返回 float32 矩阵乘法精度的当前值。 |
|
当此标志为 False(默认)时,某些 PyTorch 警告可能仅在每个进程中显示一次。 |
|
返回与给定设备关联的模块(例如,torch.device('cuda')、"mtia:0"、"xpu" 等)。 |
|
如果全局 warn_always 标志已打开,则返回 True。 |
|
vmap 是向量化映射; |
|
Python assert 的一个包装器,它是符号可跟踪的。 |
符号数#
算子标签#
- class torch.Tag#
成员
core
cudagraph_unsafe
data_dependent_output
dynamic_output_shape
flexible_layout
generated
inplace_view
maybe_aliasing_or_mutating
needs_contiguous_strides
needs_exact_strides
needs_fixed_stride_order
nondeterministic_bitwise
nondeterministic_seeded
pointwise
pt2_compliant_tag
view_copy
- property name#