Skip to main content

sisal

License PyPI Python Version CI codecov

The SiSAL package is an approach based on the beta-variational autoencoder and kernel density estimation to dissect data along independent, uncertainty-aware, and interpretable (yet non-linear) latent axes. It includes a novel comparative-latent-traversal algorithm to translate latent findings back into the original measurement context. You can find demonstrations in the /experiments folder. It includes an imaging mass spectrometry-based molecular imaging of human kidney and a synthetic dataset. The approach’s disentangling properties are shown to impose a latent space structure that separates signal strength from relative signal content, offering exceptional chemical insight.

Installing

You can install sisal from PyPI:

pip install sisal

or directly from source:

git clone https://github.com/vandeplaslab/sisal.git

pip install "."

Examples

If you are planning on running the examples, you can install the optional dependencies with:

pip install sisal[demo]

This will include additional packages such as jupyterlab and pooch to download data from Zenodo.

You can find the example data on Zenodo.

Contributing

Contributions are always welcome. Please feel free to submit PRs with new features, bug fixes, or documentation improvements.

git clone https://github.com/vandeplaslab/sisal.git

pip install -e .[dev]

Figures

Kidney imaging mass spectrometry datasets


Figure 1: Kernel density estimation of the latent space generated by the SiSAL approach together with the associated masks.

Figure 2 (latent traversal): Traversal example between the two highlighted regions.

Figure 3 (feature differentiators): The traversal algorithm extracts the most important molecular features between the two regions.

Metadata

Release files for sisal 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sisal 0.1.0
File Size Uploaded Provenance Actions
sisal-0.1.0.tar.gz 407.8 kB Without provenance Details for sisal-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sisal 0.1.0
File Interpreter ABI Platform Actions
sisal-0.1.0-py3-none-any.whl Python 3 none any Details for sisal-0.1.0-py3-none-any.whl

Total release size: 428.4 kB

Release files / sisal-0.1.0.tar.gz

Download URL sisal-0.1.0.tar.gz
Size 407.8 kB
Tags Source
SHA-256 checksum
How to use checksums
d54198e23943cd2b15ec1f705ea3618e6bf25ba88db6764c265764cea395fa9d
BLAKE2b-256 checksum
How to use checksums
9fd23a4ae76e0068e7a47ab1816ab617e819a18153b6ef8f8d03b781688a2b64
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / sisal-0.1.0-py3-none-any.whl

Download URL sisal-0.1.0-py3-none-any.whl
Size 20.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4eb8009189322686b769d43c65fd3b2b5de015e0881192dc06408e44af5b76f1
BLAKE2b-256 checksum
How to use checksums
5c7d75d3fcc4626875645ed681a7c80e8a7f29a640f723d741585bb50427901a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for sisal 0.1.0

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page