优化的 Einsum

优化的 Einsum：张量收缩顺序优化器

优化的 einsum 可以通过优化表达式的收缩顺序，并将许多操作分派到标准 BLAS、cuBLAS 或其他专用例程中，从而显著减少类似 einsum 的表达式（例如， np.einsum、 dask.array.einsum、 pytorch.einsum、 tensorflow.einsum） 的整体执行时间。

优化的 einsum 对后端无关，可以处理 NumPy、Dask、PyTorch、TensorFlow、CuPy、Sparse、Theano、JAX 和 Autograd 数组，以及任何符合标准 API 的库。更多信息请参阅 文档。

使用示例

[opt_einsum.contract](https://dgasmith.github.io/opt_einsum/api_reference#opt_einsumcontract) 函数通常可以直接替代 einsum 函数，而无需对代码进行进一步修改，同时提供更优的性能。以下展示了在有优化和无优化的情况下进行张量收缩的结果：

import numpy as np
from opt_einsum import contract

N = 10
C = np.random.rand(N, N)
I = np.random.rand(N, N, N, N)

%timeit np.einsum('pi,qj,ijkl,rk,sl->pqrs', C, C, I, C, C)
1 循环，最佳 3 次：每循环 934 毫秒

%timeit contract('pi,qj,ijkl,rk,sl->pqrs', C, C, I, C, C)
1000 循环，最佳 3 次：每循环 324 微秒

在这个特定的例子中，我们看到了约 3000 倍的性能提升，这在与未优化的收缩相比并不罕见。更多关于使用其他后端的信息，请参阅 后端示例。

特性

本仓库中的算法通常为上述许多项目中的 einsum 优化提供支持。例如，np.einsum 的优化功能已被合并到上游，因此本仓库中的大多数特性都可以通过 np.einsum(..., optimize=True) 来启用。然而，本仓库通常包含针对复杂收缩的更最新算法。

opt_einsum 提供以下功能：

• 检查所选路径的详细信息。
• 使用多种后端进行收缩，包括在 GPU 上以及使用 TensorFlow 和 PyTorch 等库。
• 生成可重用的表达式，甚至可以使用常量张量，以便编译以获得更高的性能。
• 使用任意数量的索引为数百甚至数千个张量找到收缩方式。
• 在多个收缩之间共享中间计算。
• 使用 autograd 或 jax 计算张量收缩的梯度。

更多功能请参阅 文档！

安装

可以通过 pip 安装 opt_einsum：

pip install opt_einsum

或者使用 uv：

uv pip install opt_einsum

它也可以通过 conda-forge 获取：conda install opt_einsum -c conda-forge。

对于开发，克隆仓库并安装带有可选依赖项：

uv pip install -e ".[dev]"

更多安装方法请参阅 安装文档。

引用

如果此代码对您的研究有所帮助，请通过引用以下内容来支持我们：

Daniel G. A. Smith 和 Johnnie Gray，opt_einsum - 用于优化类似 einsum 表达式收缩顺序的 Python 包。《开源软件期刊》，2018 年，第 3 卷，第 26 期，第 753 号

DOI：https://doi.org/10.21105/joss.00753

贡献

我们欢迎所有贡献、错误报告、修复、文档改进、功能增强和创意想法。

有关如何贡献的详细说明，请参阅 贡献指南。

opt_einsum 快速上手指南

opt_einsum 是一个用于优化爱因斯坦求和约定（einsum）表达式收缩顺序的 Python 库。它能显著减少张量运算的执行时间，并自动将操作分发到高效的 BLAS、cuBLAS 或其他专用例程中。该库与后端无关，支持 NumPy、PyTorch、TensorFlow、JAX、Dask 等多种框架。

环境准备

• 系统要求：支持 Windows、macOS 和 Linux。
• Python 版本：建议 Python 3.8 及以上版本。
• 前置依赖：
  • 必须安装 numpy。
  • 若需使用 GPU 加速或其他框架（如 PyTorch, TensorFlow），请预先安装对应的库（如 torch, tensorflow, cupy 等）。

安装步骤

推荐使用国内镜像源以加快下载速度。

方法一：使用 pip 安装（推荐）

使用阿里云或清华大学镜像源进行安装：

pip install opt_einsum -i https://pypi.tuna.tsinghua.edu.cn/simple

或者使用阿里云镜像：

pip install opt_einsum -i https://mirrors.aliyun.com/pypi/simple/

方法二：使用 conda 安装

如果你使用 Anaconda 或 Miniconda：

conda install opt_einsum -c conda-forge

(注：conda 默认源在国内访问较慢，建议配置清华或中科大 conda 镜像源)

基本使用

opt_einsum.contract 函数通常可以直接替代标准的 einsum 函数，无需修改现有代码逻辑即可获得性能提升。

最简单的使用示例

以下示例展示了如何使用 opt_einsum 执行张量收缩，并与原生 np.einsum 进行对比：

import numpy as np
from opt_einsum import contract

# 准备数据
N = 10
C = np.random.rand(N, N)
I = np.random.rand(N, N, N, N)

# 原生 NumPy einsum (未优化)
# %timeit np.einsum('pi,qj,ijkl,rk,sl->pqrs', C, C, I, C, C)
# 结果示例：934 ms per loop

# 使用 opt_einsum (自动优化收缩顺序)
result = contract('pi,qj,ijkl,rk,sl->pqrs', C, C, I, C, C)

# 在 Jupyter 环境中测试性能对比
# %timeit contract('pi,qj,ijkl,rk,sl->pqrs', C, C, I, C, C)
# 结果示例：324 us per loop (性能提升约 3000 倍)

关键点说明

• 无缝替换：只需将 np.einsum 替换为 contract，传入相同的下标字符串和张量数组即可。
• 自动优化：库会自动计算最优的收缩路径，对于复杂的多个张量相乘，性能提升尤为明显。
• 多后端支持：如果你传入的是 PyTorch Tensor 或 TensorFlow Tensor，contract 会自动识别并在相应后端上执行优化后的运算。