Copyright 2025 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.
pyttb: Python Tensor Toolbox
Welcome to pyttb, a refactor of the
Tensor Toolbox for MATLAB in Python.
This package contains data classes and methods for manipulating dense, sparse, and structured tensors, along with algorithms for computing low-rank tensor decompositions:
- Data Classes:
tensor,sptensor,ktensor,ttensor,tenmat,sptenmat,sumtensor - Algorithms:
cp_als,cp_apr,gcp_opt,hosvd,tucker_als
Quick Start
Installation
python3 -m pip install pyttb
Example
>>> import pyttb as ttb
>>> X = ttb.tenrand((2,2,2))
>>> type(X)
<class 'pyttb.tensor.tensor'>
>>> M = ttb.cp_als(X, rank=1)
CP_ALS:
Iter 0: f = 7.367245e-01 f-delta = 7.4e-01
Iter 1: f = 7.503069e-01 f-delta = 1.4e-02
Iter 2: f = 7.508240e-01 f-delta = 5.2e-04
Iter 3: f = 7.508253e-01 f-delta = 1.3e-06
Final f = 7.508253e-01
Memory layout
For historical reasons we use Fortran memory layouts, where numpy by default uses C. This is relevant for indexing. In the future we hope to extend support for both.
>>> import numpy as np
>>> c_order = np.arange(8).reshape((2,2,2))
>>> f_order = np.arange(8).reshape((2,2,2), order="F")
>>> print(c_order[0,1,1])
3
>>> print(f_order[0,1,1])
6
Getting Help
- Documentation
- Tutorials
- Info for users coming from MATLAB
- Learn about tensor decompositions: tensor paper, tensor book
Contributing
Citing pyttb in your work
If you use pyttb in your work, please cite it using the citation info here.
1 maintainer
Metadata
1 maintainer
Release files for pyttb 1.8.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyttb-1.8.5.tar.gz | 189.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyttb-1.8.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 343.5 kB
Release files / pyttb-1.8.5.tar.gz
| Download URL | pyttb-1.8.5.tar.gz |
|---|---|
| Size | 189.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0a3f35489014ccfb98c424519d66c539241e2eb9c4bd3c3811aa87ae8e9319e5
|
|
BLAKE2b-256 checksum How to use checksums |
38ed0e68c6887da6422cbde358ce68f1c621e26fb8c0aa76aa3d6cdd574594cc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 17, 2026.
Transparency logRelease files / pyttb-1.8.5-py3-none-any.whl
| Download URL | pyttb-1.8.5-py3-none-any.whl |
|---|---|
| Size | 153.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
617312f28d48e07a8ca7c5d36a2ea5a86d607f7c84767d958aae5cb583e9e341
|
|
BLAKE2b-256 checksum How to use checksums |
d5a7ffd271f7f5baf3beb42c42e43ea0fc5aa104ceeafffcd5cbfd73a78a4910
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Mar 17, 2026.
Transparency log
