numpy.einsum#

numpy.einsum(subscripts, *operands, out=None, dtype=None, order='K', casting='safe', optimize=False)[source]#

对操作数执行爱因斯坦求和约定。

使用爱因斯坦求和约定，许多常见的多维线性代数数组操作可以用简单的方式表示。在隐式模式下 einsum 计算这些值。

在显式模式下，einsum 通过禁用或强制对指定下标标签求和，提供了更大的灵活性来计算其他可能不被视为经典爱因斯坦求和操作的数组操作。

请参阅注释和示例以获得澄清。

参数:

subscriptsstr

指定用逗号分隔的下标标签列表作为求和下标。除非包含显式指示符 ‘->’ 以及精确输出形式的下标标签，否则执行隐式（经典爱因斯坦求和）计算。

operandsarray_like 列表

这些是用于操作的数组。

outndarray, 可选

如果提供，计算结果将存储到此数组中。

dtype{数据类型, None}, 可选

如果提供，强制计算使用指定的数据类型。请注意，您可能还需要提供一个更宽松的 casting 参数以允许类型转换。默认值为 None。

order{‘C’, ‘F’, ‘A’, ‘K’}, 可选

控制输出的内存布局。‘C’ 表示应为 C 连续。‘F’ 表示应为 Fortran 连续，‘A’ 表示如果所有输入都是 ‘F’ 则为 ‘F’，否则为 ‘C’。‘K’ 表示应尽可能接近输入的布局，包括任意排列的轴。默认值为 ‘K’。

casting{‘no’, ‘equiv’, ‘safe’, ‘same_kind’, ‘unsafe’}, 可选

控制可能发生的数据类型转换。不建议将其设置为 ‘unsafe’，因为它可能对累加产生不利影响。

‘no’ 表示数据类型根本不应进行转换。
‘equiv’ 表示只允许字节顺序更改。
‘safe’ 表示只允许可以保留值的类型转换。
‘same_kind’ 表示只允许安全转换或同类转换，例如从 float64 到 float32。
‘unsafe’ 表示可以进行任何数据转换。

默认值为 ‘safe’。

optimize{False, True, ‘greedy’, ‘optimal’}, 可选

控制是否进行中间优化。如果为 False 则不进行优化，如果为 True 则默认使用 ‘greedy’ 算法。也接受来自 np.einsum_path 函数的显式收缩列表。有关更多详细信息，请参阅 np.einsum_path。默认值为 False。

返回:

输出ndarray: 基于爱因斯坦求和约定的计算结果。

另请参阅

einsum_path, dot, inner, outer, tensordot, linalg.multi_dot
einsum: einops 包提供了类似的详细接口，涵盖了额外的操作：转置、重塑/展平、重复/平铺、挤压/非挤压和约简。opt_einsum 以与后端无关的方式优化了类 einsum 表达式的收缩顺序。

注释

爱因斯坦求和约定可用于计算许多多维线性代数数组操作。einsum 提供了一种简洁的方式来表示这些操作。

下面列出了 einsum 可以计算的这些操作的非穷尽列表，并附带示例：

数组的迹，numpy.trace。
返回对角线，numpy.diag。
数组轴求和，numpy.sum。
转置和排列，numpy.transpose。
矩阵乘法和点积，numpy.matmul
numpy.dot.
向量内积和外积，numpy.inner
numpy.outer.
广播、逐元素和标量乘法，
numpy.multiply.
张量收缩，numpy.tensordot。
链式数组操作，以高效计算顺序，
numpy.einsum_path.

下标字符串是用逗号分隔的下标标签列表，其中每个标签都指代相应操作数的一个维度。只要标签重复，就会进行求和，因此 np.einsum('i,i', a, b) 等效于 np.inner(a,b)。如果一个标签只出现一次，则不进行求和，因此 np.einsum('i', a) 会生成 a 的一个视图，没有变化。另一个例子是 np.einsum('ij,jk', a, b)，它描述了传统的矩阵乘法，等效于 np.matmul(a,b)。一个操作数中重复的下标标签表示取对角线。例如，np.einsum('ii', a) 等效于 np.trace(a)。

在 隐式模式 下，所选下标很重要，因为输出的轴是按字母顺序重新排序的。这意味着 np.einsum('ij', a) 不会影响 2D 数组，而 np.einsum('ji', a) 则取其转置。此外，np.einsum('ij,jk', a, b) 返回矩阵乘法，而 np.einsum('ij,jh', a, b) 返回乘法的转置，因为下标 ‘h’ 在下标 ‘i’ 之前。

在 显式模式 下，可以通过指定输出下标标签直接控制输出。这需要标识符 ‘->’ 以及输出下标标签列表。此功能增加了函数的灵活性，因为在需要时可以禁用或强制求和。如果 a 是 1-D 数组，则调用 np.einsum('i->', a) 类似于 np.sum(a)；如果 a 是方阵 2-D 数组，则 np.einsum('ii->i', a) 类似于 np.diag(a)。区别在于 einsum 默认不允许广播。此外，np.einsum('ij,jh->ih', a, b) 直接指定了输出下标标签的顺序，因此返回矩阵乘法，这与隐式模式下的上述示例不同。

要启用和控制广播，请使用省略号。默认的 NumPy 风格广播是通过在每个项的左侧添加省略号来完成的，例如 np.einsum('...ii->...i', a)。对于任何形状的数组 a，np.einsum('...i->...', a) 类似于 np.sum(a, axis=-1)。要沿第一和最后一轴取迹，可以使用 np.einsum('i...i', a)；或者要使用最左侧索引而不是最右侧索引进行矩阵-矩阵乘积，可以使用 np.einsum('ij...,jk...->ik...', a, b)。

当只有一个操作数，且没有轴求和，也没有提供输出参数时，返回的是操作数的一个视图而不是一个新数组。因此，将对角线作为 np.einsum('ii->i', a) 会产生一个视图（版本 1.10.0 中更改）。

einsum 还提供了另一种提供下标和操作数的方式，即 einsum(op0, sublist0, op1, sublist1, ..., [sublistout])。如果未以这种格式提供输出形状，einsum 将以隐式模式计算，否则将以显式模式执行。下面的示例具有使用两种参数方法对应的 einsum 调用。

只要输入数组是可写的，从 einsum 返回的视图现在就是可写的。例如，np.einsum('ijk...->kji...', a) 现在将具有与 np.swapaxes(a, 0, 2) 相同的效果，并且 np.einsum('ii->i', a) 将返回 2D 数组对角线的一个可写视图。

添加了 optimize 参数，它将优化 einsum 表达式的收缩顺序。对于包含三个或更多操作数的收缩，这可以大大提高计算效率，但代价是计算期间内存占用更大。

通常采用“贪婪”算法，经验测试表明该算法在大多数情况下都能返回最优路径。在某些情况下，“optimal” 将通过更昂贵、详尽的搜索返回最佳路径。对于迭代计算，建议计算一次最优路径，并通过将其作为参数提供来重复使用该路径。示例如下。

有关更多详细信息，请参阅 numpy.einsum_path。

示例

>>> a = np.arange(25).reshape(5,5)
>>> b = np.arange(5)
>>> c = np.arange(6).reshape(2,3)

矩阵的迹

>>> np.einsum('ii', a)
60
>>> np.einsum(a, [0,0])
60
>>> np.trace(a)
60

提取对角线（需要显式形式）

>>> np.einsum('ii->i', a)
array([ 0,  6, 12, 18, 24])
>>> np.einsum(a, [0,0], [0])
array([ 0,  6, 12, 18, 24])
>>> np.diag(a)
array([ 0,  6, 12, 18, 24])

沿轴求和（需要显式形式）

>>> np.einsum('ij->i', a)
array([ 10,  35,  60,  85, 110])
>>> np.einsum(a, [0,1], [0])
array([ 10,  35,  60,  85, 110])
>>> np.sum(a, axis=1)
array([ 10,  35,  60,  85, 110])

对于更高维度的数组，可以使用省略号对单个轴进行求和

>>> np.einsum('...j->...', a)
array([ 10,  35,  60,  85, 110])
>>> np.einsum(a, [Ellipsis,1], [Ellipsis])
array([ 10,  35,  60,  85, 110])

计算矩阵转置，或重新排列任意数量的轴

>>> np.einsum('ji', c)
array([[0, 3],
       [1, 4],
       [2, 5]])
>>> np.einsum('ij->ji', c)
array([[0, 3],
       [1, 4],
       [2, 5]])
>>> np.einsum(c, [1,0])
array([[0, 3],
       [1, 4],
       [2, 5]])
>>> np.transpose(c)
array([[0, 3],
       [1, 4],
       [2, 5]])

向量内积

>>> np.einsum('i,i', b, b)
30
>>> np.einsum(b, [0], b, [0])
30
>>> np.inner(b,b)
30

矩阵向量乘法

>>> np.einsum('ij,j', a, b)
array([ 30,  80, 130, 180, 230])
>>> np.einsum(a, [0,1], b, [1])
array([ 30,  80, 130, 180, 230])
>>> np.dot(a, b)
array([ 30,  80, 130, 180, 230])
>>> np.einsum('...j,j', a, b)
array([ 30,  80, 130, 180, 230])

广播和标量乘法

>>> np.einsum('..., ...', 3, c)
array([[ 0,  3,  6],
       [ 9, 12, 15]])
>>> np.einsum(',ij', 3, c)
array([[ 0,  3,  6],
       [ 9, 12, 15]])
>>> np.einsum(3, [Ellipsis], c, [Ellipsis])
array([[ 0,  3,  6],
       [ 9, 12, 15]])
>>> np.multiply(3, c)
array([[ 0,  3,  6],
       [ 9, 12, 15]])

向量外积

>>> np.einsum('i,j', np.arange(2)+1, b)
array([[0, 1, 2, 3, 4],
       [0, 2, 4, 6, 8]])
>>> np.einsum(np.arange(2)+1, [0], b, [1])
array([[0, 1, 2, 3, 4],
       [0, 2, 4, 6, 8]])
>>> np.outer(np.arange(2)+1, b)
array([[0, 1, 2, 3, 4],
       [0, 2, 4, 6, 8]])

张量收缩

>>> a = np.arange(60.).reshape(3,4,5)
>>> b = np.arange(24.).reshape(4,3,2)
>>> np.einsum('ijk,jil->kl', a, b)
array([[4400., 4730.],
       [4532., 4874.],
       [4664., 5018.],
       [4796., 5162.],
       [4928., 5306.]])
>>> np.einsum(a, [0,1,2], b, [1,0,3], [2,3])
array([[4400., 4730.],
       [4532., 4874.],
       [4664., 5018.],
       [4796., 5162.],
       [4928., 5306.]])
>>> np.tensordot(a,b, axes=([1,0],[0,1]))
array([[4400., 4730.],
       [4532., 4874.],
       [4664., 5018.],
       [4796., 5162.],
       [4928., 5306.]])

可写返回数组（自版本 1.10.0 起）

>>> a = np.zeros((3, 3))
>>> np.einsum('ii->i', a)[:] = 1
>>> a
array([[1., 0., 0.],
       [0., 1., 0.],
       [0., 0., 1.]])

省略号使用示例

>>> a = np.arange(6).reshape((3,2))
>>> b = np.arange(12).reshape((4,3))
>>> np.einsum('ki,jk->ij', a, b)
array([[10, 28, 46, 64],
       [13, 40, 67, 94]])
>>> np.einsum('ki,...k->i...', a, b)
array([[10, 28, 46, 64],
       [13, 40, 67, 94]])
>>> np.einsum('k...,jk', a, b)
array([[10, 28, 46, 64],
       [13, 40, 67, 94]])

链式数组操作。对于更复杂的收缩，可以通过重复计算“贪婪”路径或预先计算“最优”路径并重复应用它（使用 einsum_path 插入，自版本 1.12.0 起）来实现加速。对于大型数组，性能提升可能尤为显著

>>> a = np.ones(64).reshape(2,4,8)

基本 einsum: 约 1520 毫秒（在 3.1GHz Intel i5 上进行基准测试。）

>>> for iteration in range(500):
...     _ = np.einsum('ijk,ilm,njm,nlk,abc->',a,a,a,a,a)

次优 einsum（由于重复路径计算时间）：约 330 毫秒

>>> for iteration in range(500):
...     _ = np.einsum('ijk,ilm,njm,nlk,abc->',a,a,a,a,a,
...         optimize='optimal')

贪婪 einsum（更快的近似最优路径）：约 160 毫秒

>>> for iteration in range(500):
...     _ = np.einsum('ijk,ilm,njm,nlk,abc->',a,a,a,a,a, optimize='greedy')

最优 einsum（在某些用例中最佳使用模式）：约 110 毫秒

>>> path = np.einsum_path('ijk,ilm,njm,nlk,abc->',a,a,a,a,a,
...     optimize='optimal')[0]
>>> for iteration in range(500):
...     _ = np.einsum('ijk,ilm,njm,nlk,abc->',a,a,a,a,a, optimize=path)