Skip to main content

Graph-based foundation model for spatial transcriptomics data

Project description

novae_banner

PyPI Downloads Docs Build License codecov uv Ruff

💫 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.

[!NOTE] Novae was developed by the authors of sopa and is part of the scverse ecosystem.

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 behind Novae (self-supervision on graphs, adapted from SwAV).

Installation

novae can be installed via PyPI on all OS, for any Python version from 3.10 to 3.12 (included).

pip install novae

[!NOTE] See this installation section for more details about extras and other installations modes.

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

You can cite our preprint as below:

@article{blampeyNovae2024,
  title = {Novae: A Graph-Based Foundation Model for Spatial Transcriptomics Data},
  author = {Blampey, Quentin and Benkirane, Hakim and Bercovici, Nadege and Andre, Fabrice and Cournede, Paul-Henry},
  year = {2024},
  pages = {2024.09.09.612009},
  publisher = {bioRxiv},
  doi = {10.1101/2024.09.09.612009},
}

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-1.0.0.tar.gz (50.4 kB view details)

Uploaded Source

Built Distribution

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

novae-1.0.0-py3-none-any.whl (65.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: novae-1.0.0.tar.gz
  • Upload date:
  • Size: 50.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.20

File hashes

Hashes for novae-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ea31b2f7c3929659d0a45d59cab3d5c62a9ae5e9b15b4ca9fe90e24a28174d73
MD5 9369ad0697d05295b2ea8288573e8b78
BLAKE2b-256 5904964ff88f5ccbf59261f450209a5b0acffadfae5ed8d02b6c53aa2b61444b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: novae-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 65.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.20

File hashes

Hashes for novae-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 849c2491b285b09b7e9bfc040841a4e9f931509a3e269680869a16d523129a09
MD5 faea12043a12a5fcbc4a6e13e887507b
BLAKE2b-256 675255186f68052efc27ead70c213f3c27a56fcb9405dc5be6653ad0072d9707

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