Skip to main content

Single-cell Cytometry Annotation Network

Project description

scyan_logo

PyPI Downloads Docs Build License uv Ruff

🧬 Single-cell Cytometry Annotation Network

Based on biological knowledge prior, Scyan provides a fast cell population annotation without requiring any training label. It is an interpretable model that also corrects batch-effect and can be used for debarcoding, cell sampling, and population discovery.

Documentation

The complete documentation can be found here. It contains installation guidelines, tutorials, a description of the API, etc.

Overview

Scyan is a Bayesian probabilistic model composed of a deep invertible neural network called a normalizing flow (the function $f_{\phi}$). It maps a latent distribution of cell expressions into the empirical distribution of cell expressions. This cell distribution is a mixture of gaussian-like distributions representing the sum of a cell-specific and a population-specific term. Also, interpretability and batch effect correction are based on the model latent space — more details in the article's Methods section.

overview_image

Getting started

Installation

Scyan can be installed on every OS with pip for python>=3.11:

pip install scyan

Basic usage / Demo

import scyan

adata, table = scyan.data.load("aml") # Automatic loading

model = scyan.Scyan(adata, table)
model.fit()
model.predict()

This code should run in approximately 40 seconds (once the dataset is loaded). For more usage demo, read the tutorials or the complete documentation.

Cite us

Our paper is published in Briefings in Bioinformatics and is available here.

@article{10.1093/bib/bbad260,
    author = {Blampey, Quentin and Bercovici, Nadège and Dutertre, Charles-Antoine and Pic, Isabelle and Ribeiro, Joana Mourato and André, Fabrice and Cournède, Paul-Henry},
    title = "{A biology-driven deep generative model for cell-type annotation in cytometry}",
    journal = {Briefings in Bioinformatics},
    pages = {bbad260},
    year = {2023},
    month = {07},
    issn = {1477-4054},
    doi = {10.1093/bib/bbad260},
    url = {https://doi.org/10.1093/bib/bbad260},
    eprint = {https://academic.oup.com/bib/advance-article-pdf/doi/10.1093/bib/bbad260/50973199/bbad260.pdf},
}

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

scyan-1.7.3.tar.gz (49.5 kB view details)

Uploaded Source

Built Distribution

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

scyan-1.7.3-py3-none-any.whl (63.0 kB view details)

Uploaded Python 3

File details

Details for the file scyan-1.7.3.tar.gz.

File metadata

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

File hashes

Hashes for scyan-1.7.3.tar.gz
Algorithm Hash digest
SHA256 43653adc917148b88f7f88770de50cea49e6b3c0f1249a45b7f8185f24dbb8d5
MD5 78a4f2a6e2f7e5050bd12ff62e29bb8c
BLAKE2b-256 f8496e6d52dbea6665ebfdbf135be5fde286c438049099634a52d75c0c1175ce

See more details on using hashes here.

File details

Details for the file scyan-1.7.3-py3-none-any.whl.

File metadata

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

File hashes

Hashes for scyan-1.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 85d07f95e7fd3478ad710be3ceed0cbbc30840035b44294ac001a65b295ca8a3
MD5 34251107319b45bbd6ae97fe4e1a6531
BLAKE2b-256 2fa736843f486ed2af1b45a80045a5e38ddb045f35ac29e7b2ab443d48ac2804

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