Skip to main content

Fast Signature Computations on CPU and GPU

Project description

Logo

Fast Signature, Log Signature and Signature Kernel Computations on CPU and GPU

PyPI - Version PyPI - Downloads CI - Test codecov Read the Docs GitHub License

Installation

Before installing, please ensure you have a compatible C++ compiler installed (MSVC for Windows, GCC or Clang for Linux and MacOS), then run

pip install pysiglib

pySigLib will automatically detect CUDA, provided the CUDA_PATH environment variable is set correctly. To manually disable CUDA and build pySigLib for CPU only, create an environment variable CUSIG and set it to 0:

set CUSIG=0
pip install pysiglib

For detailed and up-to-date installation instructions on Windows, Linux and MacOS, see the installation guide.

Documentation

Full documentation is available at https://pysiglib.readthedocs.io

Examples

Signatures

pySigLib implements truncated signature transforms through the function pysiglib.sig, which takes as input a path or batch of paths X, and a truncation degree.

X can be a numpy array or a torch tensor. For a single path, X must be of shape (path length, path dimension). For a batch of paths, it must be of shape (batch size, path length, path dimension).

The computation will run on whichever device X is on. For example, passing X = np.random.uniform(size=(32, 1000, 10)) will trigger the computation to run on the CPU, whilst X = torch.rand(32, 1000, 10, device = "cuda") will run on the CUDA device.

import numpy as np
import pysiglib

X = np.random.uniform(size=(32, 1000, 10))
s = pysiglib.sig(X, degree = 5)

Log Signatures

Similarly to signatures, pySigLib implements truncated log signature transforms through the function pysiglib.log_sig. The function takes a method parameter, which determines the method used to compute the log signature and the form of the output. For details, please see the documentation.

import numpy as np
import pysiglib
pysiglib.prepare_log_sig(dimension = 10, degree = 5, method = 1)

X = np.random.uniform(size=(32, 1000, 10))
ls = pysiglib.log_sig(X, degree = 5, method = 1)

Signature Kernels

pySigLib implements signature kernels through the function pysiglib.sig_kernel, which takes as input a pair of paths or a pair of batches of paths X, Y. The dyadic_order parameter can be used to refine the PDE grid, giving more accurate results. If specified as an integer, the same refinement factor is applied to both X and Y. To apply different factors to the two paths, dyadic_order can be specified as a tuple.

As with signatures, X,Y can be numpy arrays or torch tensors, and must have the same shapes as described above. Again, the computation will run on whichever device X,Y are located on.

import numpy as np
import pysiglib

X = np.random.uniform(size=(32, 1000, 10))
Y = np.random.uniform(size=(32, 1000, 10))
k = pysiglib.sig_kernel(X, Y, dyadic_order=1)

# In cases where the paths differ in length, it may
# be advantageous to refine the PDE grid by different
# amounts for X and Y:

X = np.random.uniform(size=(32, 100, 10))
Y = np.random.uniform(size=(32, 5000, 10))
k = pysiglib.sig_kernel(X, Y, dyadic_order=(3, 0))

Contribution

Pull requests are not being accepted at this time, but issues and suggestions are welcome.

Citation

If you found this library useful in your research, please consider citing the paper:

@article{shmelev2025pysiglib,
  title={pySigLib-Fast Signature-Based Computations on CPU and GPU},
  author={Shmelev, Daniil and Salvi, Cristopher},
  journal={arXiv preprint arXiv:2509.10613},
  year={2025}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysiglib-1.0.0.tar.gz (230.6 kB view details)

Uploaded Source

File details

Details for the file pysiglib-1.0.0.tar.gz.

File metadata

  • Download URL: pysiglib-1.0.0.tar.gz
  • Upload date:
  • Size: 230.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for pysiglib-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c767245e0ef7a7a33240c524ce93c12de603d34d7764a9e71bf655c91345d089
MD5 5c2aedd62e352c4f08da53abd9080d72
BLAKE2b-256 4254036be11ba19f725b026b8c71c5481e01cc4833aeaed7c1c29b8f3fb08370

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page