Note

This page was generated from api_overview.ipynb. Interactive online version: . Some tutorial content may look better in light mode.

Introduction to scvi-tools

In this introductory tutorial, we go through the different steps of an scvi-tools workflow.

While we focus on scVI in this tutorial, the API is consistent across all models.

!pip install --quiet scvi-colab
from scvi_colab import install
install()

import scvi
import scanpy as sc
import matplotlib.pyplot as plt

sc.set_figure_params(figsize=(4, 4))

# for white background of figures (only for docs rendering)
%config InlineBackend.print_figure_kwargs={'facecolor' : "w"}
%config InlineBackend.figure_format='retina'

Global seed set to 0

Loading and preparing data

Let us first load a subsampled version of the heart cell atlas dataset described in Litviňuková et al. (2020). scvi-tools has many “built-in” datasets as well as support for loading arbitrary .csv, .loom, and .h5ad (AnnData) files. Please see our tutorial on data loading for more examples.

• Litviňuková, M., Talavera-López, C., Maatz, H., Reichart, D., Worth, C. L., Lindberg, E. L., … & Teichmann, S. A. (2020). Cells of the adult human heart. Nature, 588(7838), 466-472.

Important

All scvi-tools models require AnnData objects as input.

adata = scvi.data.heart_cell_atlas_subsampled()

INFO     File data/hca_subsampled_20k.h5ad already downloaded

Now we preprocess the data to remove, for example, genes that are very lowly expressed and other outliers. For these tasks we prefer the Scanpy preprocessing module.

sc.pp.filter_genes(adata, min_counts=3)

In scRNA-seq analysis, it’s popular to normalize the data. These values are not used by scvi-tools, but given their popularity in other tasks as well as for visualization, we store them in the anndata object separately (via the .raw attribute).

Important

Unless otherwise specified, scvi-tools models require the raw counts (not log library size normalized).

adata.layers["counts"] = adata.X.copy() # preserve counts
sc.pp.normalize_total(adata, target_sum=1e4)
sc.pp.log1p(adata)
adata.raw = adata # freeze the state in `.raw`

Finally, we perform feature selection, to reduce the number of features (genes in this case) used as input to the scvi-tools model. For best practices of how/when to perform feature selection, please refer to the model-specific tutorial. For scVI, we recommend anywhere from 1,000 to 10,000 HVGs, but it will be context-dependent.

sc.pp.highly_variable_genes(
    adata,
    n_top_genes=1200,
    subset=True,
    layer="counts",
    flavor="seurat_v3",
    batch_key="cell_source"
)

Now it’s time to run setup_anndata(), which alerts scvi-tools to the locations of various matrices inside the anndata. It’s important to run this function with the correct arguments so scvi-tools is notified that your dataset has batches, annotations, etc. For example, if batches are registered with scvi-tools, the subsequent model will correct for batch effects. See the full documentation for details.

In this dataset, there is a “cell_source” categorical covariate, and within each “cell_source”, multiple “donors”, “gender” and “age_group”. There are also two continuous covariates we’d like to correct for: “percent_mito” and “percent_ribo”. These covariates can be registered using the categorical_covariate_keys argument. If you only have one categorical covariate, you can also use the batch_key argument instead.

scvi.model.SCVI.setup_anndata(
    adata,
    layer="counts",
    categorical_covariate_keys=["cell_source", "donor"],
    continuous_covariate_keys=["percent_mito", "percent_ribo"]
)

Warning

If the adata is modified after running setup_anndata, please run setup_anndata again, before creating an instance of a model.

Creating and training a model

While we highlight the scVI model here, the API is consistent across all scvi-tools models and is inspired by that of scikit-learn. For a full list of options, see the scvi documentation.

model = scvi.model.SCVI(adata)

We can see an overview of the model by printing it.

model

SCVI Model with the following params:
n_hidden: 128, n_latent: 10, n_layers: 1, dropout_rate: 0.1, dispersion: gene,
gene_likelihood: zinb, latent_distribution: normal
Training status: Not Trained

Important

All scvi-tools models run faster when using a GPU. By default, scvi-tools will use a GPU if one is found to be available. Please see the installation page for more information about installing scvi-tools when a GPU is available.

model.train()

GPU available: True, used: True
TPU available: False, using: 0 TPU cores
IPU available: False, using: 0 IPUs
LOCAL_RANK: 0 - CUDA_VISIBLE_DEVICES: [0]

Epoch 400/400: 100%|██████████| 400/400 [05:43<00:00,  1.16it/s, loss=284, v_num=1]

Saving and loading

Saving consists of saving the model neural network weights, as well as parameters used to initialize the model.

# model.save("my_model/")

# model = scvi.model.SCVI.load("my_model/", adata=adata, use_gpu=True)

Obtaining model outputs

latent = model.get_latent_representation()

It’s often useful to store the outputs of scvi-tools back into the original anndata, as it permits interoperability with Scanpy.

adata.obsm["X_scVI"] = latent

The model.get...() functions default to using the anndata that was used to initialize the model. It’s possible to also query a subset of the anndata, or even use a completely independent anndata object as long as the anndata is organized in an equivalent fashion.

adata_subset = adata[adata.obs.cell_type == "Fibroblast"]
latent_subset = model.get_latent_representation(adata_subset)

INFO     Received view of anndata, making copy.

INFO:scvi.model.base._base_model:Received view of anndata, making copy.

INFO     Input AnnData not setup with scvi-tools. attempting to transfer AnnData setup

INFO:scvi.model.base._base_model:Input AnnData not setup with scvi-tools. attempting to transfer AnnData setup

denoised = model.get_normalized_expression(adata_subset, library_size=1e4)
denoised.iloc[:5, :5]

INFO     Received view of anndata, making copy.

INFO:scvi.model.base._base_model:Received view of anndata, making copy.

INFO     Input AnnData not setup with scvi-tools. attempting to transfer AnnData setup

INFO:scvi.model.base._base_model:Input AnnData not setup with scvi-tools. attempting to transfer AnnData setup

	ISG15	TNFRSF18	VWA1	HES5	SPSB1
GTCAAGTCATGCCACG-1-HCAHeart7702879	0.343808	0.118372	1.945633	0.062702	4.456603
GAGTCATTCTCCGTGT-1-HCAHeart8287128	1.552080	0.275485	1.457585	0.013442	14.617260
CCTCTGATCGTGACAT-1-HCAHeart7702881	5.157080	0.295140	1.195748	0.143792	2.908867
CGCCATTCATCATCTT-1-H0035_apex	0.352172	0.019281	0.570386	0.105633	6.325405
TCGTAGAGTAGGACTG-1-H0015_septum	0.290155	0.040910	0.400771	0.723409	8.142258

Let’s store the normalized values back in the anndata.

adata.layers["scvi_normalized"] = model.get_normalized_expression(
    library_size=10e4
)

Interoperability with Scanpy

Scanpy is a powerful python library for visualization and downstream analysis of scRNA-seq data. We show here how to feed the objects produced by scvi-tools into a scanpy workflow.

Visualization without batch correction

Warning

We use UMAP to qualitatively assess our low-dimension embeddings of cells. We do not advise using UMAP or any similar approach quantitatively. We do recommend using the embeddings produced by scVI as a plug-in replacement of what you would get from PCA, as we show below.

First, we demonstrate the presence of nuisance variation with respect to nuclei/whole cell, age group, and donor by plotting the UMAP results of the top 30 PCA components for the raw count data.

# run PCA then generate UMAP plots
sc.tl.pca(adata)
sc.pp.neighbors(adata, n_pcs=30, n_neighbors=20)
sc.tl.umap(adata, min_dist=0.3)

sc.pl.umap(
    adata,
    color=["cell_type"],
    frameon=False,
)
sc.pl.umap(
    adata,
    color=["donor", "cell_source"],
    ncols=2,
    frameon=False,
)

We see that while the cell types are generally well separated, nuisance variation plays a large part in the variation of the data.

Visualization with batch correction (scVI)

Now, let us try using the scVI latent space to generate the same UMAP plots to see if scVI successfully accounts for batch effects in the data.

# use scVI latent space for UMAP generation
sc.pp.neighbors(adata, use_rep="X_scVI")
sc.tl.umap(adata, min_dist=0.3)

sc.pl.umap(
    adata,
    color=["cell_type"],
    frameon=False,
)
sc.pl.umap(
    adata,
    color=["donor", "cell_source"],
    ncols=2,
    frameon=False,
)

We can see that scVI was able to correct for nuisance variation due to nuclei/whole cell, age group, and donor, while maintaining separation of cell types.

Clustering on the scVI latent space

The user will note that we imported curated labels from the original publication. Our interface with scanpy makes it easy to cluster the data with scanpy from scVI’s latent space and then reinject them into scVI (e.g., for differential expression).

# neighbors were already computed using scVI
sc.tl.leiden(adata, key_added="leiden_scVI", resolution=0.5)

sc.pl.umap(
    adata,
    color=["leiden_scVI"],
    frameon=False,
)

Differential expression

We can also use many scvi-tools models for differential expression. For further details on the methods underlying these functions as well as additional options, please see the API docs.

adata.obs.cell_type.head()

AACTCCCCACGAGAGT-1-HCAHeart7844001                      Myeloid
ATAACGCAGAGCTGGT-1-HCAHeart7829979    Ventricular_Cardiomyocyte
GTCAAGTCATGCCACG-1-HCAHeart7702879                   Fibroblast
GGTGATTCAAATGAGT-1-HCAHeart8102858                  Endothelial
AGAGAATTCTTAGCAG-1-HCAHeart8102863                  Endothelial
Name: cell_type, dtype: category
Categories (11, object): ['Adipocytes', 'Atrial_Cardiomyocyte', 'Endothelial', 'Fibroblast', ..., 'Neuronal', 'Pericytes', 'Smooth_muscle_cells', 'Ventricular_Cardiomyocyte']

For example, a 1-vs-1 DE test is as simple as:

de_df = model.differential_expression(
    groupby="cell_type",
    group1="Endothelial",
    group2="Fibroblast"
)
de_df.head()

DE...: 100%|██████████| 1/1 [00:00<00:00,  3.07it/s]

	proba_de	proba_not_de	bayes_factor	scale1	scale2	pseudocounts	delta	lfc_mean	lfc_median	lfc_std	...	raw_mean1	raw_mean2	non_zeros_proportion1	non_zeros_proportion2	raw_normalized_mean1	raw_normalized_mean2	is_de_fdr_0.05	comparison	group1	group2
SOX17	0.9998	0.0002	8.516943	0.001615	0.000029	0.0	0.25	6.222365	6.216846	1.967564	...	0.784371	0.006541	0.307617	0.004497	17.128170	0.185868	True	Endothelial vs Fibroblast	Endothelial	Fibroblast
SLC9A3R2	0.9996	0.0004	7.823621	0.010660	0.000171	0.0	0.25	5.977907	6.049340	1.672150	...	4.451492	0.045380	0.712339	0.034342	111.582703	1.657324	True	Endothelial vs Fibroblast	Endothelial	Fibroblast
ABCA10	0.9990	0.0010	6.906745	0.000081	0.006355	0.0	0.25	-8.468659	-9.058912	2.959383	...	0.014359	1.282508	0.007788	0.499591	0.501825	69.613876	True	Endothelial vs Fibroblast	Endothelial	Fibroblast
EGFL7	0.9986	0.0014	6.569875	0.008471	0.000392	0.0	0.25	4.751251	4.730982	1.546327	...	2.376779	0.036795	0.741543	0.025756	89.507553	1.169474	True	Endothelial vs Fibroblast	Endothelial	Fibroblast
VWF	0.9984	0.0016	6.436144	0.014278	0.000553	0.0	0.25	5.013347	5.029471	1.758744	...	5.072563	0.054375	0.808226	0.032298	169.693512	2.207696	True	Endothelial vs Fibroblast	Endothelial	Fibroblast

5 rows × 22 columns

We can also do a 1-vs-all DE test, which compares each cell type with the rest of the dataset:

de_df = model.differential_expression(
    groupby="cell_type",
)
de_df.head()

DE...: 100%|██████████| 11/11 [00:03<00:00,  3.08it/s]

	proba_de	proba_not_de	bayes_factor	scale1	scale2	pseudocounts	delta	lfc_mean	lfc_median	lfc_std	...	raw_mean1	raw_mean2	non_zeros_proportion1	non_zeros_proportion2	raw_normalized_mean1	raw_normalized_mean2	is_de_fdr_0.05	comparison	group1	group2
CIDEC	0.9988	0.0012	6.724225	0.002336	0.000031	0.0	0.25	7.082959	7.075700	2.681833	...	1.137931	0.001406	0.510345	0.001406	21.809771	0.057564	True	Adipocytes vs Rest	Adipocytes	Rest
ADIPOQ	0.9988	0.0012	6.724225	0.003627	0.000052	0.0	0.25	7.722131	7.461277	3.332577	...	2.324136	0.003622	0.593103	0.003352	33.361748	0.217763	True	Adipocytes vs Rest	Adipocytes	Rest
GPAM	0.9986	0.0014	6.569875	0.025417	0.000202	0.0	0.25	7.365266	7.381156	2.562121	...	17.372416	0.035791	0.896552	0.031520	280.340485	1.565905	True	Adipocytes vs Rest	Adipocytes	Rest
PLIN1	0.9984	0.0016	6.436144	0.004482	0.000048	0.0	0.25	7.818194	7.579515	2.977385	...	2.799999	0.004379	0.806897	0.004325	52.921761	0.196486	True	Adipocytes vs Rest	Adipocytes	Rest
GPD1	0.9974	0.0026	5.949637	0.002172	0.000044	0.0	0.25	6.543847	6.023436	2.865962	...	1.758620	0.007353	0.620690	0.007299	30.203791	0.255079	True	Adipocytes vs Rest	Adipocytes	Rest

5 rows × 22 columns

We now extract top markers for each cluster using the DE results.

markers = {}
cats = adata.obs.cell_type.cat.categories
for i, c in enumerate(cats):
    cid = "{} vs Rest".format(c)
    cell_type_df = de_df.loc[de_df.comparison == cid]

    cell_type_df = cell_type_df[cell_type_df.lfc_mean > 0]

    cell_type_df = cell_type_df[cell_type_df["bayes_factor"] > 3]
    cell_type_df = cell_type_df[cell_type_df["non_zeros_proportion1"] > 0.1]

    markers[c] = cell_type_df.index.tolist()[:3]

sc.tl.dendrogram(adata, groupby="cell_type", use_rep="X_scVI")

sc.pl.dotplot(
    adata,
    markers,
    groupby='cell_type',
    dendrogram=True,
    color_map="Blues",
    swap_axes=True,
    use_raw=True,
    standard_scale="var",
)

We can also visualize the scVI normalized gene expression values with the layer option.

sc.pl.heatmap(
    adata,
    markers,
    groupby='cell_type',
    layer="scvi_normalized",
    standard_scale="var",
    dendrogram=True,
    figsize=(8, 12)
)

Logging information

Verbosity varies in the following way:

• logger.setLevel(logging.WARNING) will show a progress bar.

• logger.setLevel(logging.INFO) will show global logs including the number of jobs done.

• logger.setLevel(logging.DEBUG) will show detailed logs for each training (e.g the parameters tested).

This function’s behaviour can be customized, please refer to its documentation for information about the different parameters available.

In general, you can use scvi.settings.verbosity to set the verbosity of the scvi package. Note that verbosity corresponds to the logging levels of the standard python logging module. By default, that verbosity level is set to INFO (=20). As a reminder the logging levels are:

Level	Numeric value
CRITICAL	50
ERROR	40
WARNING	30
INFO	20
DEBUG	10
NOTSET	0