torch¶
torch 包包含用于多维张量的数据结构,并定义了对这些张量的数学运算。此外,它还提供了许多实用程序,用于高效地序列化张量和任意类型,以及其他有用的实用程序。
它有一个 CUDA 对应项,使您能够在计算能力 >= 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
。
通过复制 |
|
使用给定 |
|
使用给定 |
|
使用给定 |
|
使用给定 |
|
使用给定 |
|
将 |
|
将 |
|
使用指定的 |
|
创建一个由内存映射文件支持的存储的 CPU 张量。 |
|
从 |
|
将来自外部库的张量转换为 |
|
从实现 Python 缓冲区协议的对象创建一个 1 维 |
|
返回一个用标量值 0 填充的张量,其形状由可变参数 |
|
返回一个用标量值 0 填充的张量,其大小与 |
|
返回一个用标量值 1 填充的张量,其形状由可变参数 |
|
返回一个用标量值 1 填充的张量,其大小与 |
|
返回一个大小为 的 1 维张量,其值来自区间 |
|
返回一个大小为 的 1 维张量,其值从 |
|
创建一个大小为 |
|
创建一个大小为 |
|
返回一个在对角线上为 1,其他位置为 0 的 2 维张量。 |
|
返回一个用未初始化数据填充的张量。 |
|
返回一个与 |
|
创建一个具有指定 |
|
创建一个大小为 |
|
返回一个与 |
|
使用给定的比例和零点,将浮点张量转换为量化张量。 |
|
使用给定的比例和零点,将浮点张量转换为按通道量化的张量。 |
|
通过反量化量化张量,返回一个 fp32 张量 |
|
计算 |
索引、切片、连接、变异操作¶
返回张量的共轭视图,并将最后两个维度转置。 |
|
返回一个张量,其中包含 |
|
在给定维度中连接 |
|
|
|
|
|
返回 |
|
尝试将张量拆分为指定数量的块。 |
|
根据 |
|
通过水平堆叠 |
|
深度方向(沿第三轴)堆叠张量序列。 |
|
沿 dim 指定的轴收集值。 |
|
根据 |
|
水平方向(按列)堆叠张量序列。 |
|
有关函数描述,请参见 |
|
有关函数描述,请参见 |
|
有关函数描述,请参见 |
|
返回一个新的张量,该张量使用 LongTensor |
|
返回一个新的 1 维张量,该张量根据布尔掩码 |
|
将 |
|
|
|
返回一个新的张量,该张量是 |
|
与 |
|
返回原始张量 |
|
返回一个与 |
|
|
|
在给定索引处沿选定维度切片 |
|
非原地操作版本的 |
|
将 |
|
将 |
|
将 |
|
非原地操作版本的 |
|
非原地操作版本的 |
|
将张量分割成块。 |
|
返回一个移除 |
|
沿着新的维度连接一系列张量。 |
|
是 |
|
是 |
|
期望 |
|
返回一个包含 |
|
沿着给定的 |
|
将张量沿着维度 |
|
通过重复 |
|
返回一个 |
|
移除一个张量维度。 |
|
将扁平索引的张量转换为坐标张量的元组,这些坐标张量可以索引到指定形状的任意张量中。 |
|
返回一个新的张量,在指定位置插入大小为一的维度。 |
|
根据 |
|
垂直 (按行) 堆叠序列中的张量。 |
|
返回一个根据 |
加速器¶
在 PyTorch 代码库中,我们将“加速器”定义为与 CPU 一起使用的 torch.device
,用于加速计算。这些设备使用异步执行方案,使用 torch.Stream
和 torch.Event
作为执行同步的主要方式。我们还假设在给定主机上一次只能使用一个这样的加速器。这允许我们将当前加速器用作相关概念 (例如,pinned memory, Stream device_type, 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.bernoulli_()
- 是torch.bernoulli()
的原地操作版本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。 |
数学运算¶
常量¶
|
浮点正无穷大。是 |
|
浮点“非数字”值。此值不是合法的数字。是 |
逐元素操作¶
计算 |
|
是 |
|
计算 |
|
是 |
|
返回一个包含 |
|
是 |
|
将 |
|
将 |
|
将 |
|
计算给定 |
|
返回一个包含 |
|
是 |
|
返回一个包含 |
|
是 |
|
返回一个包含 |
|
是 |
|
返回一个包含 |
|
是 |
|
逐元素计算 的反正切值,并考虑象限。 |
|
是 |
|
计算给定输入张量的按位 NOT。 |
|
计算 |
|
计算 |
|
计算 |
|
计算 |
|
计算 |
|
返回一个包含 |
|
是 |
|
计算给定 |
|
创建一个新的浮点张量,其幅度与 |
|
返回一个包含 |
|
返回一个包含 |
|
返回一个新张量,其中 |
|
将输入 |
|
是 |
|
是 |
|
是 |
|
是 |
|
是 |
|
返回一个包含输入张量 |
|
是 |
|
是 |
|
返回一个新的张量,其中 |
|
返回一个新的张量,其中 |
|
是 |
|
逐元素计算 |
|
返回一个包含 |
|
逐元素应用 C++ 的 std::fmod。 |
|
计算 |
|
将 |
|
使用 二阶精度中心差分法 以及边界处的一阶或二阶估计,估计一个或多个维度中函数 的梯度。 |
|
返回一个包含 |
|
将 |
|
对两个张量 |
|
计算 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 (1 + |
|
返回一个新张量,其中包含 |
|
输入指数之和的对数。 |
|
以 2 为底的输入指数之和的对数。 |
|
计算给定输入张量的逐元素逻辑与。 |
|
计算给定输入张量的逐元素逻辑非。 |
|
计算给定输入张量的逐元素逻辑或。 |
|
计算给定输入张量的逐元素逻辑异或。 |
|
别名,指向 |
|
给定直角三角形的两条直角边,返回其斜边。 |
|
别名,指向 |
|
别名,指向 |
|
别名,指向 |
|
将 |
|
别名,指向 |
|
别名,指向 |
|
将 |
|
返回一个新张量,其中包含 |
|
别名,指向 |
|
返回 |
|
别名,指向 |
|
返回 |
|
计算 |
|
对 4D (NCHW) 量化张量应用批归一化。 |
|
对由多个输入平面组成的输入量化张量应用 1D 最大池化。 |
|
对由多个输入平面组成的输入量化张量应用 2D 最大池化。 |
|
返回一个新张量,其中每个元素是将 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 |
|
逐元素计算 Python 的模运算。 |
|
将 |
|
返回一个新张量,其中包含 |
|
别名,指向 |
|
返回一个新张量,其中包含 |
|
此函数是 torch.sign() 对复数张量的扩展。 |
|
测试 |
|
返回一个新张量,其中包含 |
|
别名,指向 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 |
|
从 |
|
别名,指向 |
|
返回一个新张量,其中包含 |
|
返回一个新张量,其中包含 |
|
别名,指向 |
|
返回一个新张量,其中包含 |
|
别名,指向 |
归约运算¶
返回 |
|
返回展平张量或沿维度的最小值的索引。 |
|
返回给定维度 |
|
返回给定维度 |
|
计算 |
|
测试 |
|
测试 |
|
返回 |
|
返回 |
|
返回 ( |
|
返回给定维度 |
|
计算指定维度上所有 非 NaN 元素的均值。 |
|
返回 |
|
返回 |
|
返回一个 namedtuple |
|
返回给定张量的矩阵范数或向量范数。 |
|
返回所有元素的总和,并将非数字 (NaN) 视为零。 |
|
返回 |
|
计算维度 |
|
这是 |
|
计算由 |
|
计算由 |
|
返回 |
|
返回输入张量的唯一元素。 |
|
从每个连续的等效元素组中消除除第一个元素之外的所有元素。 |
|
计算由 |
|
计算由 |
|
计算给定 |
比较运算¶
此函数检查 |
|
返回沿给定维度按值升序对张量进行排序的索引。 |
|
计算逐元素相等性 |
|
如果两个张量具有相同的大小和元素,则返回 |
|
逐元素计算 。 |
|
别名,指向 |
|
逐元素计算 。 |
|
别名,指向 |
|
返回一个新张量,其中包含布尔元素,表示 |
|
返回一个新张量,其中包含布尔元素,表示每个元素是否为 有限的。 |
|
测试 |
|
测试 |
|
测试 |
|
测试 |
|
返回一个新张量,其中包含布尔元素,表示 |
|
返回一个新张量,其中包含布尔元素,表示 |
|
返回一个 namedtuple |
|
逐元素计算 。 |
|
别名,指向 |
|
逐元素计算 。 |
|
别名,指向 |
|
计算 |
|
计算 |
|
计算 |
|
计算 |
|
逐元素计算 。 |
|
别名,指向 |
|
沿给定维度按值升序对 |
|
返回给定维度上 |
|
沿第一个维度按值升序对 |
频谱运算¶
短时傅里叶变换 (STFT)。 |
|
逆短时傅里叶变换。 |
|
Bartlett 窗函数。 |
|
Blackman 窗函数。 |
|
Hamming 窗函数。 |
|
Hann 窗函数。 |
|
计算窗口长度为 |
其他运算¶
返回每个零维输入张量的 1 维视图。 |
|
返回每个零维输入张量的 2 维视图。 |
|
返回每个零维输入张量的 3 维视图。 |
|
计算非负整数数组中每个值的频率。 |
|
从提供的张量创建块对角矩阵。 |
|
根据 广播语义 广播给定的张量。 |
|
将 |
|
类似于 |
|
返回 |
|
对给定张量序列执行笛卡尔积。 |
|
计算两组行向量集合中每对向量之间的分批 p 范数距离。 |
|
返回 |
|
计算给定张量的长度为 的组合。 |
|
估计由 |
|
估计由 |
|
返回 |
|
返回一个 namedtuple |
|
返回一个 namedtuple |
|
返回维度 |
|
返回维度 |
|
|
|
创建一个张量,其某些 2D 平面(由 |
|
|
|
返回 |
|
计算沿给定维度的 n 阶前向差分。 |
|
根据基于爱因斯坦求和约定的符号,对输入 |
|
通过将 |
|
沿 dims 中给定的轴反转 n 维张量的顺序。 |
|
在左右方向翻转张量,返回一个新张量。 |
|
在上下方向翻转张量,返回一个新张量。 |
|
计算 |
|
在由 dims 轴指定的平面中将 n 维张量旋转 90 度。 |
|
计算 |
|
计算张量的直方图。 |
|
计算张量中值的直方图。 |
|
计算张量中值的多维直方图。 |
|
创建由 attr:tensors 中的 1D 输入指定的坐标网格。 |
|
计算 |
|
返回维度 |
|
返回一个连续的展平张量。 |
|
返回一个张量,其中沿维度 |
|
重复张量的元素。 |
|
沿给定维度滚动张量 |
|
从 |
|
返回 a 和 b 在多个维度上的收缩。 |
|
返回输入 2 维矩阵的对角线元素的总和。 |
|
返回矩阵(2 维张量)或批量矩阵 |
|
返回 |
|
返回矩阵(2 维张量)或批量矩阵 |
|
返回 |
|
在多个维度上展开输入张量的维度。 |
|
生成范德蒙矩阵。 |
|
将 |
|
将 |
|
如果 |
|
如果 |
BLAS 和 LAPACK 操作¶
对存储在 |
|
对矩阵 |
|
对矩阵 |
|
对向量 |
|
对 |
|
对存储在 |
|
返回 个 2 维张量的矩阵乘积。 |
|
计算对称正定矩阵 或对称正定矩阵批量的 Cholesky 分解。 |
|
计算给定 Cholesky 分解的复 Hermitian 矩阵或实对称正定矩阵的逆矩阵。 |
|
计算给定 Cholesky 分解的复 Hermitian 矩阵或实对称正定左手边 (lhs) 线性方程组的解。 |
|
计算两个一维张量的点积。 |
|
这是一个直接调用 LAPACK 的 geqrf 的底层函数。 |
|
|
|
计算一维张量的点积。 |
|
计算方阵或方阵批量的对数行列式。 |
|
计算矩阵或矩阵批量 |
|
使用来自 |
|
将 |
|
两个张量的矩阵乘积。 |
|
对矩阵 |
|
对矩阵 |
|
计算 Householder 矩阵的乘积与一般矩阵的矩阵-矩阵乘法。 |
|
|
|
计算矩阵或矩阵批量 |
|
计算矩阵或矩阵批量 |
|
返回矩阵、矩阵批量或稀疏矩阵 的奇异值分解 |
|
对低秩矩阵、此类矩阵的批量或稀疏矩阵执行线性主成分分析 (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 断言的包装器,可以进行符号跟踪。 |
符号数字¶
- class torch.SymFloat(node)[source][source]¶
类似于 float(包括魔术方法),但重定向对包装节点的所有操作。这尤其用于在符号形状工作流程中以符号方式记录操作。
- class torch.SymBool(node)[source][source]¶
类似于 bool(包括魔术方法),但重定向对包装节点的所有操作。这尤其用于在符号形状工作流程中以符号方式记录操作。
与常规布尔值不同,常规布尔运算符将强制执行额外的保护,而不是符号化求值。请改用按位运算符来处理此问题。
用于浮点数转换的 SymInt 感知实用工具。 |
|
用于整数转换的 SymInt 感知实用工具。 |
|
用于 max 的 SymInt 感知实用工具,可避免在 a < b 时分支。 |
|
用于 min() 的 SymInt 感知实用工具。 |
|
用于逻辑否定的 SymInt 感知实用工具。 |
|
N 元加法,对于长列表,其计算速度比迭代二元加法更快。 |