tensorly

TensorLy 项目介绍

项目概述

TensorLy 是一个旨在使张量学习变得简单且易于使用的 Python 库。该库提供了便捷的工具来进行张量分解、张量学习和张量代数。其后端系统支持多种计算框架，包括 NumPy、PyTorch、JAX、TensorFlow、CuPy 和 Paddle，从而可以在 CPU 或 GPU 上大规模地运行各种方法。

安装指南

安装 TensorLy 的唯一前提条件是您已安装 Python 3。最简单的方法是通过 Anaconda 分发进行安装。以下是不同安装方法的指引：

• 使用 pip 安装（推荐）

  pip install -U tensorly

• 使用 conda 安装

  conda install -c tensorly tensorly

• 用于开发（从源代码安装）

  # 克隆库的代码仓库
  git clone https://github.com/tensorly/tensorly
  cd tensorly
  # 以可编辑模式安装
  pip install -e .

需要注意的是，TensorLy 默认依赖于 NumPy。如果需要使用其他后端，需要另外安装相应的软件包。

快速入门

创建张量

用户可以很容易地创建张量，比如创建一个 3x4x2 的小型三阶张量，并对其进行基本操作：

import tensorly as tl
import numpy as np

tensor = tl.tensor(np.arange(24).reshape((3, 4, 2)), dtype=tl.float64)
unfolded = tl.unfold(tensor, mode=0)
tl.fold(unfolded, mode=0, shape=tensor.shape)

也可以创建随机张量：

from tensorly import random

# 一个随机张量
tensor = random.random_tensor((3, 4, 2))
# 一个随机 CP 格式的张量
cp_tensor = random.random_tensor(shape=(3, 4, 2), rank='same')

设置后端

用户可以更改后端以使用不同的计算框架进行计算，默认使用 NumPy。可选择的框架还包括 PyTorch、TensorFlow、JAX、CuPy 和 Paddle。设置后端示例：

tl.set_backend('pytorch')  # 或 'numpy', 'tensorflow', 'cupy', 'jax'
tensor = tl.tensor(np.arange(24).reshape((3, 4, 2)), device='cuda:0')
type(tensor)  # torch.Tensor

张量分解

在 TensorLy 中应用张量分解相对简单，以 Tucker 分解为例：

from tensorly.decomposition import tucker

# 应用 Tucker 分解
tucker_tensor = tucker(tensor, rank=[2, 2, 2])
# 从分解形式重构完整张量
tl.tucker_to_tensor(tucker_tensor)

TensorLy 提供更多种类的分解方法来满足不同的需求。

下一步

以上只是 TensorLy 基本功能的快速介绍。如果想了解更多的信息，请查阅用户指南和 API 文档。

贡献代码

社区欢迎所有的贡献！如果你有想分享的不错的张量方法，或是发现了错误或文档中的问题，请在 GitHub 上报告，或提交 Pull-Request。

测试

测试与文档是 TensorLy 的重要组成部分。测试可以通过 pytest 包运行，确保代码的一致性和功能完整性：

pip install pytest
pytest -v tensorly

# 指定运行测试的后端
TENSORLY_BACKEND='numpy' pytest -v tensorly

学术引用

如果在学术论文中使用了 TensorLy，请按以下格式引用：

@article{tensorly,
  author  = {Jean Kossaifi and Yannis Panagakis and Anima Anandkumar and Maja Pantic},
  title   = {TensorLy: Tensor Learning in Python},
  journal = {Journal of Machine Learning Research},
  year    = {2019},
  volume  = {20},
  number  = {26},
  pages   = {1-6},
}