torch¶
torch 包包含用于多维张量的数据结构,并定义了对这些张量的数学运算。此外,它还提供了许多用于高效序列化张量和任意类型的实用程序,以及其他有用的实用程序。
它有一个 CUDA 对应版本,使您能够在具有 compute capability >= 3.0 的 NVIDIA GPU 上运行张量计算。
张量¶
如果obj 是 PyTorch 张量,则返回 True。 |
|
如果obj 是 PyTorch 存储对象,则返回 True。 |
|
如果 |
|
如果 |
|
如果 |
|
如果 |
|
将默认浮点 dtype 设置为 |
|
获取当前默认浮点 |
|
将默认 |
|
获取默认 |
|
返回 |
|
设置打印选项。 |
|
禁用 CPU 上的非规格化浮点数。 |
创建操作¶
注意
随机采样创建操作列在 随机采样 下,包括:torch.rand()
torch.rand_like()
torch.randn()
torch.randn_like()
torch.randint()
torch.randint_like()
torch.randperm()
您也可以使用 torch.empty()
和 就地随机采样 方法来创建具有从更广泛的分布中采样值的 torch.Tensor
。
通过复制 |
|
使用给定 |
|
使用给定 |
|
使用给定 |
|
使用给定 |
|
使用指定的二维块构建一个 BSC(块压缩稀疏列)格式的稀疏张量,这些块位于给定的 |
|
将 |
|
将 |
|
创建现有 torch.Tensor |
|
创建一个 CPU 张量,其存储由内存映射文件支持。 |
|
从 |
|
将来自外部库的张量转换为 |
|
从实现 Python 缓冲协议的对象创建一个一维 |
|
返回一个填充标量值 0 的张量,其形状由可变参数 |
|
返回一个填充标量值 0 的张量,其大小与 |
|
返回一个填充标量值 1 的张量,其形状由可变参数 |
|
返回一个填充标量值 1 的张量,其大小与 |
|
返回大小为 的一维张量,其值取自区间 |
|
返回大小为 的一维张量,其值从 |
|
创建一个大小为 |
|
创建一个大小为 |
|
返回一个二维张量,对角线上的元素为 1,其他元素为 0。 |
|
返回一个填充未初始化数据的张量。 |
|
返回一个未初始化的张量,其大小与 |
|
创建一个具有指定 |
|
创建一个大小为 |
|
返回一个与 |
|
将浮点张量转换为具有给定比例和零点的量化张量。 |
|
将浮点张量转换为具有给定比例和零点的按通道量化张量。 |
|
通过反量化量化张量返回一个 fp32 张量 |
|
计算 |
索引、切片、连接、变异操作¶
返回张量的共轭视图,并将最后两个维度进行转置。 |
|
返回一个张量,包含 |
|
在给定的维度上连接给定的 |
|
|
|
|
|
返回 |
|
尝试将张量拆分为指定数量的块。 |
|
根据 |
|
通过水平堆叠 |
|
按深度顺序(沿第三轴)堆叠张量。 |
|
沿由 dim 指定的轴收集值。 |
|
根据 |
|
水平(列方向)顺序堆叠张量。 |
|
有关函数描述,请参阅 |
|
有关函数描述,请参阅 |
|
有关函数描述,请参见 |
|
返回一个新的张量,该张量使用 LongTensor 类型且位于 |
|
返回一个新的 1 维张量,该张量根据布尔掩码 |
|
将 |
|
|
|
返回一个新的张量,它是 |
|
与 |
|
返回原始张量 |
|
返回一个与 |
|
|
|
沿给定索引处的选定维度切片 |
|
|
|
将 |
|
将 |
|
将 |
|
|
|
|
|
将张量分割成块。 |
|
返回一个张量,其中删除了 |
|
沿着一个新维度连接一系列张量。 |
|
|
|
|
|
期望 |
|
返回一个新的张量,其中包含给定索引处 |
|
从 |
|
将张量拆分为多个子张量,所有这些子张量都是 |
|
通过重复 |
|
返回一个张量,它是 |
|
删除张量维度。 |
|
将平面索引的张量转换为坐标张量的元组,这些坐标张量索引到指定形状的任意张量中。 |
|
返回一个新的张量,在指定位置插入一个大小为一的维度。 |
|
根据 |
|
按顺序垂直(行方式)堆叠张量。 |
|
根据 |
加速器¶
在 PyTorch 代码库中,我们将“加速器”定义为 torch.device
,它与 CPU 一起使用以加速计算。这些设备使用异步执行方案,使用 torch.Stream
和 torch.Event
作为它们执行同步的主要方式。我们还假设在给定主机上一次只能有一个这样的加速器可用。这使我们能够将当前加速器用作相关概念(如固定内存、Stream 设备类型、FSDP 等)的默认设备。
截至今天,加速器设备是(无特定顺序)“CUDA”、“MTIA”、“XPU” 和 PrivateUse1(许多设备不在 PyTorch 代码库本身中)。
一个按顺序执行各自任务的异步队列,按照先进先出 (FIFO) 顺序。 |
|
查询和记录 Stream 状态,以识别或控制跨 Stream 的依赖关系并测量时间。 |
随机采样¶
将所有设备上生成随机数的种子设置为非确定性随机数。 |
|
设置所有设备上生成随机数的种子。 |
|
将生成随机数的初始种子作为 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.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为底的输入指数和的对数。 |
|
计算给定输入张量的逐元素逻辑与。 |
|
计算给定输入张量的逐元素逻辑非。 |
|
计算给定输入张量的逐元素逻辑或。 |
|
计算给定输入张量的逐元素逻辑异或。 |
|
给定直角三角形的两条直角边,返回其斜边。 |
|
将 |
|
|
|
将 |
|
返回一个新的张量,其中包含 |
|
|
|
逐元素返回紧随 |
|
是 |
|
返回 |
|
使用 |
|
对 4D (NCHW) 量化张量应用批归一化。 |
|
对由多个输入平面组成的输入量化张量应用 1D 最大池化。 |
|
对由多个输入平面组成的输入量化张量应用 2D 最大池化。 |
|
返回一个新的张量,其中 |
|
返回一个新的张量,包含 |
|
返回一个新的张量,包含 |
|
逐元素计算 Python 的取模运算。 |
|
将 |
|
返回一个新的张量,包含 |
|
是 |
|
返回一个新的张量,包含 |
|
此函数是 torch.sign() 对复数张量的扩展。 |
|
测试 |
|
返回一个新的张量,包含 |
|
是 |
|
返回一个新的张量,包含 |
|
返回一个新的张量,包含 |
|
返回一个新的张量,包含 |
|
从 |
|
是 |
|
返回一个新的张量,包含 |
|
返回一个新的张量,包含 |
|
是 |
|
返回一个新的张量,包含 |
|
是 |
约简操作¶
返回 |
|
返回扁平化张量或沿指定维度最小值(s)的索引。 |
|
返回给定维度(s) |
|
返回给定维度(s) |
|
计算 |
|
测试 |
|
测试 |
|
返回 |
|
返回 |
|
返回 ( |
|
返回给定维度 |
|
返回 |
|
计算沿指定维度所有非 NaN 元素的平均值。 |
|
返回 |
|
返回 |
|
返回一个名为元组 |
|
返回给定张量的矩阵范数或向量范数。 |
|
返回所有元素的总和,将非数字 (NaN) 视为零。 |
|
返回 |
|
计算沿维度 |
|
这是 |
|
计算由 |
|
计算由 |
|
返回 |
|
返回输入张量的唯一元素。 |
|
消除每个连续的等价元素组中的第一个元素之外的所有元素。 |
|
计算由 |
|
计算由 |
|
计算张量 |
比较操作¶
此函数检查 |
|
返回沿给定维度按值升序对张量排序的索引。 |
|
计算逐元素相等性。 |
|
如果两个张量具有相同的大小和元素,则为 |
|
逐元素计算 。 |
|
是 |
|
逐元素计算 。 |
|
|
|
返回一个新的张量,其布尔元素表示 |
|
返回一个新的张量,其布尔元素表示每个元素是否为有限。 |
|
测试 |
|
测试 |
|
测试 |
|
测试 |
|
返回一个新的张量,其布尔元素表示 |
|
返回一个新的张量,其布尔元素表示 |
|
返回一个名为元组 |
|
逐元素计算 。 |
|
|
|
逐元素计算 。 |
|
|
|
计算 |
|
计算 |
|
计算 |
|
计算 |
|
逐元素计算 。 |
|
|
|
沿给定维度对 |
|
沿给定维度返回给定 |
|
沿其第一维度对 |
频谱运算¶
短时傅里叶变换 (STFT)。 |
|
逆短时傅里叶变换。 |
|
巴特利特窗函数。 |
|
布莱克曼窗函数。 |
|
汉明窗函数。 |
|
汉宁窗函数。 |
|
计算窗口长度为 |
其他运算¶
返回每个零维输入张量的一维视图。 |
|
返回每个零维输入张量的二维视图。 |
|
返回每个零维输入张量的三维视图。 |
|
计算非负整数数组中每个值的频率。 |
|
从提供的张量创建一个块对角矩阵。 |
|
根据 广播语义 广播给定的张量。 |
|
将 |
|
类似于 |
|
返回 |
|
对给定的张量序列执行笛卡尔积。 |
|
计算两个行向量集合的每个对之间的 p 范数距离。 |
|
返回 |
|
计算给定张量的长度为 的组合。 |
|
估计由 |
|
估计由 |
|
返回 |
|
返回一个名为元组 |
|
返回一个名为元组 |
|
返回 |
|
返回 |
|
|
|
创建一个张量,其某些二维平面(由 |
|
|
|
返回 |
|
沿给定维度计算第 n 个前向差分。 |
|
根据爱因斯坦求和约定,使用基于符号的表示法,沿指定维度对输入 |
|
通过将其重塑为一维张量来展平 |
|
沿 dims 中给定的轴反转 n 维张量的顺序。 |
|
沿左右方向翻转张量,返回一个新的张量。 |
|
沿上下方向翻转张量,返回一个新的张量。 |
|
计算克罗内克积,记为 , |
|
将 n 维张量在由 dims 轴指定的平面内旋转 90 度。 |
|
计算 |
|
计算张量的直方图。 |
|
计算张量中值的直方图。 |
|
计算张量中值的多分量直方图。 |
|
创建由 attr:tensors 中的 1D 输入指定的坐标网格。 |
|
计算 |
|
返回 |
|
返回一个连续的扁平化张量。 |
|
返回一个张量,其中 |
|
重复张量的元素。 |
|
沿着给定维度(们)滚动张量 |
|
查找 |
|
返回 a 和 b 在多个维度上的收缩。 |
|
返回输入 2D 矩阵对角线元素的和。 |
|
返回矩阵(2D 张量)或矩阵批次 |
|
在一个 2xN 的张量中返回 |
|
返回矩阵(2D 张量)或矩阵批次 |
|
在一个 2xN 的张量中返回 |
|
将输入张量的一个维度扩展到多个维度。 |
|
生成范德蒙矩阵。 |
|
返回 |
|
返回 |
|
如果 |
|
如果 |
BLAS 和 LAPACK 操作¶
执行存储在 |
|
执行矩阵 |
|
执行矩阵 |
|
执行向量 |
|
执行 |
|
执行存储在 |
|
返回 个 2D 张量的矩阵乘积。 |
|
计算对称正定矩阵 或对称正定矩阵批次的 Cholesky 分解。 |
|
给定其 Cholesky 分解,计算复厄米特或实对称正定矩阵的逆。 |
|
给定其 Cholesky 分解,计算具有复厄米特或实对称正定左端项的线性方程组的解。 |
|
计算两个 1D 张量的点积。 |
|
这是一个用于直接调用 LAPACK 的 geqrf 的低级函数。 |
|
|
|
计算 1D 张量的点积。 |
|
计算方阵或方阵批次的 log 行列式。 |
|
计算矩阵或矩阵批次 |
|
使用 |
|
将 |
|
两个张量的矩阵乘积。 |
|
执行矩阵 |
|
执行矩阵 |
|
计算 Householder 矩阵乘积与一般矩阵的矩阵-矩阵乘积。 |
|
|
|
计算矩阵或一批矩阵 |
|
计算矩阵或一批矩阵 |
|
返回矩阵、矩阵批次或稀疏矩阵的奇异值分解 |
|
对低秩矩阵、此类矩阵的批次或稀疏矩阵执行线性主成分分析 (PCA)。 |
|
使用无矩阵 LOBPCG 方法查找对称正定广义特征值问题的 k 个最大(或最小)特征值及其对应的特征向量。 |
|
别名,等价于 |
|
沿 |
|
沿 |
|
求解具有方形上三角或下三角可逆矩阵和多个右侧的方程组。 |
|
沿某个维度计算两个一维向量的点积。 |
Foreach 操作¶
警告
此 API 处于测试阶段,将来可能会发生变化。不支持前向模式 AD。
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
|
将 |
实用程序¶
返回 PyTorch 是否使用 _GLIBCXX_USE_CXX11_ABI=1 构建。 |
|
返回对提供的输入张量执行算术运算将产生的 |
|
确定在类型提升文档中描述的 PyTorch 转换规则下是否允许类型转换。 |
|
返回大小最小且标量类型不低于type1或type2的 |
|
设置 PyTorch 操作是否必须使用“确定性”算法。 |
|
如果全局确定性标志已开启,则返回 True。 |
|
如果全局确定性标志设置为仅警告,则返回 True。 |
|
设置确定性操作的调试模式。 |
|
返回确定性操作当前的调试模式值。 |
|
设置 float32 矩阵乘法的内部精度。 |
|
返回 float32 矩阵乘法当前的精度值。 |
|
当此标志为 False(默认值)时,某些 PyTorch 警告可能每个进程仅出现一次。 |
|
返回与给定设备关联的模块(例如,torch.device('cuda')、"mtia:0"、"xpu" 等)。 |
|
如果全局 warn_always 标志已开启,则返回 True。 |
|
vmap 是向量化映射; |
|
Python 的 assert 的包装器,可进行符号跟踪。 |
符号数字¶
- class torch.SymBool(node)[source]¶
类似于 bool(包括魔术方法),但将包装节点上的所有操作重定向。这尤其用于在符号形状工作流中符号记录操作。
与常规布尔值不同,常规布尔运算符将强制执行额外的保护,而不是进行符号评估。使用按位运算符来处理此问题。
SymInt 感知的 float 类型转换实用程序。 |
|
SymInt 感知的 int 类型转换实用程序。 |
|
SymInt 感知的 max 实用程序,避免在 a < b 上分支。 |
|
SymInt 感知的 min() 实用程序。 |
|
SymInt 感知的逻辑非实用程序。 |
|