pysiglib.prepare_branched_sig

pysiglib.prepare_branched_sig#

prepare_branched_sig(dimension, degree, *, use_disk=False, time_aug=False, lead_lag=False, planar=False)[source]#

Precomputes the basis enumeration and coproduct tables needed for branched signature computation. Must be called before branched_sig() for a given (dimension, degree) pair.

With planar=False this prepares the BCK basis of non-planar rooted trees. With planar=True this prepares the MKW basis of ordered forests of planar rooted trees.

If time_aug or lead_lag are set, the cache is prepared for the augmented dimension automatically.

Parameters:

  • dimension (int) – Dimension of the underlying path.

  • degree (int) – Maximum order (number of nodes).

  • use_disk (bool) – If True, cache the precomputed tables to disk for faster loading in future sessions. Uses the same cache directory as set_cache_dir() / prepare_log_sig().

  • time_aug (bool) – If True, prepare for time-augmented paths (dim + 1).

  • lead_lag (bool) – If True, prepare for lead-lag transformed paths (2 * dim).

  • planar (bool) – If True, prepare for planar (ordered) branched signatures.


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}
}
Contents