Skip to main content

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},
}

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.8.0.tar.gz (53.1 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.8.0-py3-none-any.whl (67.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for scyan-1.8.0.tar.gz
Algorithm Hash digest
SHA256 45573ebf6a566e2572c704802b07b738e5bd900b1d8a8fad86e910e1c6bc0db5
MD5 fd17bfb95fd3f52ffe6a97993ed1334c
BLAKE2b-256 23525af090c064e5bf3c316d0eff6c69e70413dc8c4ec83ba83b68a3d98cf6c5

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for scyan-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 333175b494a803255dbb3ef2a4ae89901cb45b0f117b34daeda95cc51d99c828
MD5 74da5e81f0837badf86b224782b6ee62
BLAKE2b-256 688a72a4bfe3740698f4b264939ad1b79bd20a3ab8b0cf9e296c87fa49ab9150

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 Sentry Error logging StatusPage Status page