Skip to content

sandialabs/pyttb

Repository files navigation

Copyright 2022 National Technology & Engineering Solutions of Sandia,
LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the
U.S. Government retains certain rights in this software.

Regression tests Coverage Status pypi package image Ruff Code style: black

pyttb: Python Tensor Toolbox

Welcome to pyttb, a set of Python classes and methods functions for manipulating dense, sparse, and structured tensors, along with algorithms for computing low-rank tensor models.

Tensor Classes:

  • tensor: dense tensors
  • sptensor: sparse tensors
  • ktensor: Kruskal tensors
  • tenmat: matricized tensors
  • ttensor: Tucker tensors

Tensor Algorithms:

  • cp_als, cp_apr: Canonical Polyadic (CP) decompositions
  • tucker_als: Tucker decompostions

Getting Started

For full details see our documentation.

Quick Start

We are on pypi

pip install pyttb

or install from source

pip install .

Contributing

Check out our contributing guide.