scNym is a neural network model for predicting cell types from single cell profiling data (e.g. scRNA-seq) and deriving cell type representations from these models.
While cell type classification is the main use case, these models can map single cell profiles to arbitrary output classes (e.g. experimental conditions).
We've described scNym in detail in a recent paper in Genome Research.
Please cite our work if you find this tool helpful.
We also have a research website that describes scNym in brief -- https://scnym.research.calicolabs.com
Semi-supervised adversarial neural networks for single cell classification.
Jacob C. Kimmel and David R. Kelley.
Genome Research. 2021. doi: https://doi.org/10.1101/gr.268581.120
BibTeX
@article{kimmel_scnym_2021,
title = {Semi-supervised adversarial neural networks for single-cell classification},
issn = {1088-9051, 1549-5469},
url = {https://genome.cshlp.org/content/early/2021/02/24/gr.268581.120},
doi = {10.1101/gr.268581.120},
pages = {gr.268581.120},
journaltitle = {Genome Research},
shortjournal = {Genome Res.},
author = {Kimmel, Jacob C. and Kelley, David R.},
urldate = {2021-02-26},
date = {2021-02-24},
langid = {english},
pmid = {33627475}
}If you have an questions, please feel free to email me.
Jacob C. Kimmel
[email protected]
Calico Life Sciences, LLC
The scNym model is a neural network leveraging modern best practices in architecture design.
Gene expression vectors are transformed by non-linear functions at each layer in the network.
Each of these functions have parameters that are learned from data.
scNym uses the MixMatch semi-supervision framework (Berthelot et. al. 2019) and domain adversarial training to take advantange of both labeled training data and unlabeled target data to learn these parameters.
Given a labeled dataset X and an unlabeled dataset U, scNym uses the model to guess "pseudolabels" for each unlabeled observation.
All observations are then augmented using the "MixUp" weighted averaging method prior to computing losses.
We also introduce a domain adversarial network (Ganin et. al. 2016) that predicts the domain of origin (e.g. {target, train} or {method_A, method_B, method_C}) for each observation.
We invert the adversary's gradients during backpropogation so the model learns to "compete" with the adversary by adapting across domains.
Model parameters are then trained to minimize a supervised cross-entropy loss applied to the labeled examples, an unsupervised mean squared error loss applied to the unlabeled examples, and a classification loss across domains for the domain adversary.
The best way to become acquainted with scNym is to walk through one of our interactive tutorials.
We've prepared tutorials using Google Colab so that all computation can be performed using free GPUs.
You can even analyze data on your cell phone!
This tutorial demonstrates how to train a semi-supervised scNym model using a pre-prepared cell atlas as a training data set and a new data set as the target.
You can upload your own data through Google Drive to classify cell types in a new experiment.
Transfering labels from a cell atlas
This tutorial shows how to use scNym to transfer annotations across experiments using different sequencing technologies. We use human peripheral blood mononuclear cell profiles generated with different versions of the 10x Genomics chemistry for demonstration.
Cross-technology annotation transfer
First, clone the repository:
We recommend creating a virtual environment for use with scNym.
This is easily accomplished using virtualenv or conda.
We recommend using python=3.8 for scNym, as some of our dependencies don't currently support the newest Python versions.
$ python3 -m venv scnym_env # python3 is python3.8
$ source scnym_env/bin/activateor
$ conda create -n scnym_env -c conda-forge python=3.8
$ conda activate scnym_envOnce the environment is set up, simply run:
$ cd scnym
$ pip install -e ./After installation completes, you should be able to import scnym in Python and run scNym as a command line tool:
$ python -c "import scnym; print(scnym.__file__)"
$ scnym --helpData inputs for scNym should be log(CPM + 1) normalized counts, where CPM is Counts Per Million and log is the natural logarithm.
This transformation is crucial if you would like to use any of our pre-trained model weights, provided in the tutorials above.
For the recommended Python API interface, data should be formatted as an AnnData object with normalized counts in the main .X observations attribute.
For the command line tool, data can be stored as a dense [Cells, Genes] CSV of normalized counts, an AnnData h5ad object, or a Loompy loom object.
We recommend users take advantange of our Python API for scNym, suitable for use in scripts and Jupyter notebooks.
The API follows the scanpy functional style and has a single end-point for training and prediction.
To begin with the Python API, load your training and test data into anndata.AnnData objects using scanpy.
Training an scNym model using the Python API is simple. We provide an example below.
from scnym.api import scnym_api
scnym_api(
adata=adata,
task='train',
groupby='cell_ontology_class',
out_path='./scnym_output',
config='no_new_identity',
)The groupby keyword specifies a column in adata.obs containing annotations to use for model training.
This API supports semi-supervised adversarial training using a special token in the annotation column.
Any cell with the annotation "Unlabeled" will be treated as part of the target dataset and used for semi-supervised and adversarial training.
We also provide two predefined configurations for model training.
no_new_identity-- This configuration assumes every cell in the target set belongs to one of the classes in the training set. This assumption improves performance, but can lead to erroneously high confidence scores if new cell types are present in the target data.new_identity_discovery-- This configuration is useful for experiments where new cell type discoveries may occur. It uses pseudolabel thresholding to avoid the assumption above. If new cell types are present in the target data, they correctly receive low confidence scores.
from scnym.api import scnym_api
scnym_api(
adata=adata,
task='predict',
key_added='scNym',
trained_model='./scnym_output',
out_path='./scnym_output',
config='no_new_identity',
)The prediction task adds a key to adata.obs that contains the scNym annotation predictions, as well as the associated confidence scores.
The key is defined by key_added and the confidence scores are stored as adata.obs[key_added + '_confidence'].
The prediction task also extracts the activations of the penultimate scNym layer as an embedding and stores the result in adata.obsm["X_scnym"].
scNym models can be interpreted using the expected gradients technique to estimate Shapley values (Erion et. al. 2020). Briefly, expected gradient estimation computes the gradient on the predicted output class score with respect to an input vector, where the input vector is a random interpolation between an observation x and some reference vector x'.
Intuitively, we are using gradients on the input vector to highlight important genes that influence class predictions.
We can then rank the importance of various genes using the resulting expected gradient value.
Computing expected gradients in scNym is accomplished with the scnym_interpret API endpoint.
from scnym.api import scnym_interpret
expected_gradients = scnym_interpret(
adata=adata,
groupby="cell_type",
target="target_cell_type",
source="all", # use all data except target cells as a reference
trained_model=PATH_TO_TRAINED_MODEL,
config=CONFIG_USED_FOR_TRAINING,
)
# `expected_gradients["saliency"]` is a pandas.Series ranking genes by their mean
# expected gradient across cells
# `expected_gradients["gradients"]` is a pd.DataFrame [Cells, Features] table of expected
# gradient estimates for each feature in each `target` cellWe also provide a set of preprocessed cell atlas references for human, mouse, and rat, as well as pretrained weights for each.
It's easy to use the scNym API to transfer labels from these atlases to your own data.
The best way to transfer labels is by training an scNym model using your data as the target dataset for semi-supervised learning. Below, we demonstrate how to train a model on a cell atlas with your data as the target.
We provide access to cell atlases for the mouse and rat through the scNym API, but we encourage users to thoughfully consider which training data are most appropriate for their experiments.
import anndata
from scnym.api import scnym_api, atlas2target
# load your data
adata = anndata.read_h5ad(path_to_your_data)
# first, we create a single object with both the cell
# atlas and your data
# `atlas2target` will take care of passing annotations
joint_adata = atlas2target(
adata=adata,
species='mouse',
key_added='annotations',
)
# now train an scNym model as above
scnym_api(
adata=joint_adata,
task='train',
groupby='annotations',
out_path='./scnym_output',
config='new_identity_discovery',
)By default, scNym treats training cells as one domain, and target cells as another.
scNym also offers the ability to integrate across multiple training and target domains through the domain adversary.
This feature can be enabled by providing domain labels for each training cell in the AnnData object and passing the name of the relevant anntotation column to scNym.
# load multiple training and target datasets
# ...
# set unique labels for each domain
training_adata_00.obs['domain_label'] = 'train_0'
training_adata_01.obs['domain_label'] = 'train_1'
target_adata_00.obs['domain_label'] = 'target_0'
target_adata_01.obs['domain_label'] = 'target_1'
# set target annotations to "Unlabeled"
target_adata_00.obs['annotations'] = 'Unlabeled'
target_adata_01.obs['annotations'] = 'Unlabeled'
# concatenate
adata = training_adata_00.concatenate(
training_adata_01,
target_adata_00,
target_adata_01,
)
# provide the `domain_groupby` argument to `scnym_api`
scnym_api(
adata=adata,
task='train',
groupby='annotations',
domain_groupby='domain_label',
out_path='./scnym_output',
config='no_new_identity',
)We provide two configurations for scNym model training, as noted above. However, users may wish to experiment with different configuration options for new applications of scNym models.
To experiment with custom configuration options, users can simply copy one of the pre-defined configurations and modify as desired.
All pre-defined configurations are stored as Python dictionaries in scnym.api.CONFIGS.
import scnym
config = scnym.api.CONFIGS["no_new_identity"]
# increase the number of training epochs
config["n_epochs"] = 500
# increase the weight of the domain adversary 0.1 -> 0.3
config["ssl_kwargs"]["dan_max_weight"] = 0.3
# descriptions of all parameters and their default values
"default": {
"n_epochs": 100, # number of training epochs
"patience": 40, # number of epochs to wait before early stopping
"lr": 1.0, # learning rate
"optimizer_name": "adadelta", # optimizer
"weight_decay": 1e-4, # weight decay for the optimizer
"batch_size": 256, # minibatch size
"mixup_alpha": 0.3, # shape parameter for MixUp: lambda ~ Beta(alpha, alpha)
"unsup_max_weight": 1.0, # maximum weight for the MixMatch loss
"unsup_mean_teacher": False, # use a mean teacher for MixMatch pseudolabeling
"ssl_method": "mixmatch", # semi-supervised learning method to use
"ssl_kwargs": {
"augment_pseudolabels": False, # perform augmentations before pseudolabeling
"augment": "log1p_drop", # augmentation to use if `augment_pseudolabels`
"unsup_criterion": "mse", # criterion fxn for MixMatch loss
"n_augmentations": 1, # number of augmentations per observation
"T": 0.5, # temperature scaling parameter
"ramp_epochs": 100, # number of epochs to ramp up the MixMatch loss
"burn_in_epochs": 0, # number of epochs to wait before ramping MixMatch
"dan_criterion": True, # use a domain adversary
"dan_ramp_epochs": 20, # ramp epochs for the adversarial loss
"dan_max_weight": 0.1, # max weight for the adversarial loss
"min_epochs": 20, # minimum epochs to train before saving a best model
},
"model_kwargs": {
"n_hidden": 256, # number of hidden units per hidden layer
"n_layers": 2, # number of hidden layers
"init_dropout": 0.0, # dropout on the initial layer
"residual": False, # use residual layers
},
# save logs for tensorboard. enables nice visualizations, but can slow down
# training if filesystem I/O is limiting.
"tensorboard": False,
}Models can be also trained using the included command line interface, scnym.
The CLI allows for more detailed model configuration, but should only be used for experimentation.
The CLI accepts configuration files in YAML or JSON formats, with parameters carrying the same names as command line arguments.
To see a list of command line arguments/configuration parameters, run:
$ scnym -hA sample configuration is included as default_config.txt.
A CLI demo shell script is provided that downloads data from the Tabula Muris and trains an scnym model.
To execute the script, run:
chmod +x demo_script.sh
source demo_script.shin the repository directory.
We provide processed data we used to evaluate scNym in the common AnnData format.