Skip to main content

Biologically Guided Variational Inference for Interpretable Multimodal Single-Cell Integration and Discovery

Project description

python black Documentation PyPI

NetworkVI: Biologically Guided Variational Inference for Interpretable Multimodal Single-Cell Integration and Discovery

Getting started

NetworkVI is a sparse deep generative model designed for the paired, vertical (shared cells across measurements), horizontal (shared features across datasets) or mosaic integration and interpretation of multimodal single-cell data. The model learns a rich, batch-corrected low-dimensional representation of bi- and trimodal single-cell count datasets, estimating the representation using normalized input data. Please refer to the documentation. We also provide tutorials:

Installation

NetworkVI supports both standard pip installation and Pixi-based reproducible environments. We recommend Pixi for most users, as it automatically manages Python, CUDA, and PyTorch versions.

Recommended: Installation using Pixi (reproducible, CUDA-enabled)

Pixi is a modern environment manager that combines Conda and pip, making it easy to install GPU-enabled scientific software reproducibly.

  1. Install Pixi

Follow the instructions at: https://pixi.sh

  1. Clone the repository
git clone https://github.com/LArnoldt/networkvi.git
cd networkvi
  1. Create and activate the environment
pixi install
pixi shell

Alternative: Installation using pip

If you prefer a standard pip-based installation (CPU or manually managed GPU):

  1. Install the latest release of NetworkVI from PyPi:
pip install networkvi
  1. (Optional, GPU) Install PyTorch and PyG dependencies manually

For CUDA 12.1:

pip install -U torch==2.2.0 --index-url https://download.pytorch.org/whl/cu121
pip install -U torch-scatter torch-sparse -f https://data.pyg.org/whl/torch-2.2.0+cu121.html

Other CUDA versions are available at:

Optional dependencies

Additional functionality can be installed via extras:

pip install "networkvi[tutorials]"
pip install "networkvi[docs]"
pip install "networkvi[all]"

When using Pixi, extras can be enabled by adjusting pixi.toml.

API

Please find the API here.

Release notes

Please find the release notes here.

Contact

If you found a bug, please use the issue tracker. If you use NetworkVI in your research, please consider citing the preprint:

Arnoldt, L., Upmeier zu Belzen, J., Herrmann, L., Nguyen, K., Theis, F.J., Wild, B. , Eils, R., "Biologically Guided Variational Inference for Interpretable Multimodal Single-Cell Integration and Mechanistic Discovery", bioRxiv, June 2025.

Reproducibility

Code and notebooks to reproduce the results and figues from the paper are available here.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

networkvi-0.2.0-py3-none-any.whl (210.9 kB view details)

Uploaded Python 3

File details

Details for the file networkvi-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: networkvi-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 210.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for networkvi-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6e5b319153fc151b634987e2b18c625e28838395a85f89f09458da9dcfe59c5f
MD5 67e0c810dd27f9e1aca46a101435ba67
BLAKE2b-256 b82b006a15f52d6371ef72ae62879bd0b710dfbec46a41d9ab79aba9c78de0d9

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