Skip to main content

Graph-based foundation model for spatial transcriptomics data

Project description

novae_banner

PyPI Downloads Docs Build Code Style License Imports: isort codecov

💫 Graph-based foundation model for spatial transcriptomics data

Novae is a deep learning model for spatial domain assignments of spatial transcriptomics data (at both single-cell or spot resolution). It works across multiple gene panels, tissues, and technologies. Novae offers several additional features, including: (i) native batch-effect correction, (ii) analysis of spatially variable genes and pathways, and (iii) architecture analysis of tissue slides.

Documentation

Check Novae's documentation to get started. It contains installation explanations, API details, and tutorials.

Overview

novae_overview

(a) Novae was trained on a large dataset, and is shared on Hugging Face Hub. (b) Illustration of the main tasks and properties of Novae. (c) Illustration of the method behing Novae (self-supervision on graphs, adapted from SwAV).

Installation

PyPI

novae can be installed via PyPI on all OS, for python>=3.9.

pip install novae

Editable mode

To install novae in editable mode (e.g., to contribute), clone the repository and choose among the options below.

pip install -e .                 # pip, minimal dependencies
pip install -e '.[dev]'          # pip, all extras
poetry install                   # poetry, minimal dependencies
poetry install --all-extras      # poetry, all extras

Usage

Here is a minimal usage example. For more details, refer to the documentation.

import novae

model = novae.Novae.from_pretrained("MICS-Lab/novae-human-0")

model.compute_representations(adata, zero_shot=True)
model.assign_domains(adata)

Cite us

TODO: submit preprint (coming soon)

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

novae-0.1.0.tar.gz (42.4 kB view details)

Uploaded Source

Built Distribution

novae-0.1.0-py3-none-any.whl (53.3 kB view details)

Uploaded Python 3

File details

Details for the file novae-0.1.0.tar.gz.

File metadata

  • Download URL: novae-0.1.0.tar.gz
  • Upload date:
  • Size: 42.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.11 Linux/6.5.0-1025-azure

File hashes

Hashes for novae-0.1.0.tar.gz
Algorithm Hash digest
SHA256 924f3fc183bae2b2649bd9c218056212dc17ed019166aa413f69cba78a2039b0
MD5 40e0603e84dab7f58e6951c62ecaaed3
BLAKE2b-256 396bd49b0b7b2484cf4904567b40b8f29af47ec0510a74e70ff5b3b6e5a9b0bc

See more details on using hashes here.

File details

Details for the file novae-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: novae-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 53.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.11 Linux/6.5.0-1025-azure

File hashes

Hashes for novae-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 efca83a3a09e1c9bb0959512c07a089aed99a1e115976087344be7bbf7932477
MD5 b0c9b62b482161ac8843b038ff2d7565
BLAKE2b-256 e40d3e02124096a5475927f0047ff05ee51953295a38c51d112d447842b171fb

See more details on using hashes here.

Supported by

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