Skip to main content

A package for generating an embedding space from scRNA-Seq. This space can be used for cell type annotation, novel cell type detection, cell type representations, and visualization.

Project description

CELLULAR: CELLUlar contrastive Learning for Annotation and Representation

Abstract Batch effects are a significant concern in single-cell RNA sequencing (scRNA-Seq) data analysis, where variations in the data can be attributed to factors unrelated to cell types. This can make downstream analysis a challenging task. In this study, we present a novel deep learning approach using contrastive learning and a carefully designed loss function for learning an generalizable embedding space from scRNA-Seq data. We call this model CELLULAR: CELLUlar contrastive Learning for Annotation and Representation. When benchmarked against multiple established methods for scRNA-Seq integration, CELLULAR outperforms existing methods in learning a generalizable embedding space on multiple datasets. Cell annotation was also explored as a downstream application for the learned embedding space. When compared against multiple well-established methods, CELLULAR demonstrates competitive performance with top cell classification methods in terms of accuracy, balanced accuracy, and F1 score. CELLULAR is also capable of performing novel cell type detection. These findings aim to quantify the meaningfulness of the embedding space learned by the model by highlighting the robust performance of our learned cell representations in various applications. The model has been structured into an open-source Python package, specifically designed to simplify and streamline its usage for bioinformaticians and other scientists interested in cell representation learning.

Necessary programming languages

  • Python version >= 3.10.5

Setup

pip install --extra-index-url https://download.pytorch.org/whl/cu118 torch==2.2.1
pip install CELLULAR-scRNA

Functionality

The following functions have been included:

  • Training function for the embedding space model.
  • Training function for the classifier model.
  • Predict function for generating an embedding space.
  • Predict function for performing cell type annotation.
  • Function for novel cell type detection.
  • Function for creating cell type representation vectors.
  • Function for applying the same normalization strategy as was used in this study, giving the end user the option of using the same strategy or implementing their own.
  • Function for automatic preprocessing, although it is still recommended for end users to use their own preprocessing pipeline to make sure it is appropriate for their data.

Data

Data for the tutorial can be installed from here.

Usage

For making embedding space

import scanpy as sc
import CELLULAR

adata_train = sc.read("train_data.h5ad", cache=True)
CELLULAR.train(adata=adata_train, target_key="cell_type", batch_key="batch")

adata_test = sc.read("test_data.h5ad", cache=True)
predictions = CELLULAR.predict(adata=adata_test)

For cell type annotation

import scanpy as sc
import CELLULAR

adata_train = sc.read("train_data.h5ad", cache=True)
CELLULAR.train(adata=adata_train, train_classifier=True, target_key="cell_type", batch_key="batch")

adata_test = sc.read("test_data.h5ad", cache=True)
predictions = CELLULAR.predict(adata=adata_test, use_classifier=True)

For novel cell type detection

import scanpy as sc
import CELLULAR

adata_train = sc.read("train_data.h5ad", cache=True)
CELLULAR.train(adata=adata_train, target_key="cell_type", batch_key="batch")

adata_test = sc.read("test_data.h5ad", cache=True)
CELLULAR.novel_cell_type_detection(adata=adata_test)

For making cell type representations

import scanpy as sc
import CELLULAR

adata_train = sc.read("train_data.h5ad", cache=True)
CELLULAR.train(adata=adata_train, target_key="cell_type", batch_key="batch")

adata_test = sc.read("test_data.h5ad", cache=True)
representations = CELLULAR.generate_representations(adata=adata_test, target_key="cell_type")

Tutorials

See Tutorial/embedding_space_tutorial.ipynb, Tutorial/classification_tutorial.ipynb, and Tutorial/pre_process_tutorial.ipynb.

Citation

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

CELLULAR_CL-0.0.1.tar.gz (26.2 kB view details)

Uploaded Source

Built Distribution

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

CELLULAR_CL-0.0.1-py3-none-any.whl (30.5 kB view details)

Uploaded Python 3

File details

Details for the file CELLULAR_CL-0.0.1.tar.gz.

File metadata

  • Download URL: CELLULAR_CL-0.0.1.tar.gz
  • Upload date:
  • Size: 26.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.0 CPython/3.10.5

File hashes

Hashes for CELLULAR_CL-0.0.1.tar.gz
Algorithm Hash digest
SHA256 d738da07b867b80624db2b7c61c8682078fba06d53f7b658708784e8cce9f17e
MD5 8c7450c99e7ce307e65ad486ed45aea6
BLAKE2b-256 9779e004cb95dc0a3ae6becd86ed52f2c733a44ab0c7eeb288b1c2ef09b57a95

See more details on using hashes here.

File details

Details for the file CELLULAR_CL-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: CELLULAR_CL-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 30.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.0 CPython/3.10.5

File hashes

Hashes for CELLULAR_CL-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a497bdc098442a358884115b51947b5acf1c41c2218fc35ffb3b28e55e54d374
MD5 8301d04b50ed67ab561cd57fd143688a
BLAKE2b-256 8cca86eb9a1cc228a707d2f55ad139350a168c3b31fcb8b771f9138be21aa262

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