scvi-tools

Targets scvi-tools 1.5.1, released September 10, 2026. APIs below were checked against the tagged source and official documentation. The examples are illustrative: the repository tests exercise short CPU synthetic fits for SCVI, SCANVI, TOTALVI, MULTIVI, METHYLVI, PEAKVI and POISSONVI, plus count-preserving preprocessing, DE output contracts, save/load and minification. The tested stack is Python 3.13, Scanpy 1.12.4, AnnData 0.13.4, MuData 0.4.1, PyTorch 2.14.1 and Lightning 2.6.6. Long training, hardware-specific paths and other specialized workflows remain illustrative; these checks do not establish convergence or biological validity.

Choose the model and its input contract

The count rule is model-specific: do not feed raw RNA counts to SysVI or replace methylation coverage with ratios. Likewise, never reconstruct counts by exponentiating log-normalized data. Preserve measured counts and preprocessing provenance.

Read the corresponding references before using a specialized model:

• RNA models: SCVI, SCANVI, AUTOZI, VELOVI, ContrastiveVI, CellAssign, SOLO, LinearSCVI, AmortizedLDA.
• ATAC models: PEAKVI, POISSONVI, SCBASSET.
• Multimodal models: TOTALVI, TOTALANVI, MULTIVI, MRVI, DIAGVI.
• Spatial models: CondSCVI/DestVI, Stereoscope, Tangram, GIMVI, SCVIVA, RESOLVI.
• Specialized models: methylation, cytometry, SysVI, Decipher.

Release boundaries: JAX support, including JaxSCVI, was removed in 1.5. scvi.model.mlxSCVI remains a separate optional Apple-silicon implementation; PyTorch MPS and MLX are different backends. Spatial models and DIAGVI remain importable in 1.5.1, but upstream directs their ongoing maintenance to scVIVA-tools. Use the pinned compatibility examples here only for existing scvi-tools workflows.

Workflow

1. Confirm modality, raw-data provenance, unique cell/feature IDs, feature order, batch/sample metadata, and the intended biological comparison.
2. Perform QC and feature selection before model registration. Use count-aware HVG selection for count layers, and preserve a full-gene count object for later analyses outside the selected feature set.
3. Register the exact data object with that model's setup_anndata or setup_mudata; create and train the model. Setup is registration, not normalization.
4. Inspect validation history, held-out fit, seed stability, batch mixing and retention of known biology. A well-mixed UMAP alone does not validate integration.
5. Extract representations or model-specific normalized outputs; save the model, data, selected feature order, software versions, seed and training parameters.

Illustrative RNA workflow

Assumes rna_counts.h5ad contains measured, unnormalized counts in .X, with nonmissing obs['batch']. Choose QC thresholds for the experiment before this block.

import numpy as np
import scanpy as sc
import scvi
from scipy import sparse

scvi.settings.seed = 0
adata = sc.read_h5ad("rna_counts.h5ad")
assert adata.obs_names.is_unique and adata.var_names.is_unique
assert adata.obs["batch"].notna().all()
x = adata.X
values = x.data if sparse.issparse(x) else np.asarray(x)
assert np.isfinite(values).all() and (values >= 0).all()
assert np.allclose(values, np.rint(values))
assert (np.asarray(x.sum(axis=1)).ravel() > 0).all()
adata.layers["counts"] = x.copy()
sc.pp.filter_genes(adata, min_cells=3)
sc.pp.highly_variable_genes(
    adata, layer="counts", flavor="seurat_v3", batch_key="batch",
    n_top_genes=min(2000, adata.n_vars), subset=True,
)
adata = adata.copy()
assert (np.asarray(adata.layers["counts"].sum(axis=1)).ravel() > 0).all()
scvi.model.SCVI.setup_anndata(adata, layer="counts", batch_key="batch")
model = scvi.model.SCVI(adata, n_latent=20, gene_likelihood="nb")
model.train(max_epochs=400, early_stopping=True)
adata.obsm["X_scVI"] = model.get_latent_representation()
sc.pp.neighbors(adata, use_rep="X_scVI")
sc.tl.umap(adata)
sc.tl.leiden(adata, flavor="igraph", n_iterations=2, directed=False)
model.save("scvi_model", save_anndata=True)

seurat_v3 needs scikit-misc (included through scvi-tools' Scanpy dependency); Leiden with flavor='igraph' needs igraph. Tiny or degenerate datasets can fail the HVG local regression; reduce the feature-selection ambition, inspect data quality, and do not conceal the failure by changing the count layer.

Count validity does not prove count provenance. If filtering removes all expression from a cell, remove that cell or revise feature selection before setup. Do not add condition, tissue, or donor as nuisance covariates automatically: they may encode the biological signal being investigated, and confounding cannot be repaired by registration alone.

Registration is tied to feature order, layers and category encodings. Finish filtering before setup. If the training object changes, register it again and initialize a new model; use the dedicated query-mapping methods for a trained reference rather than changing its registry in place.

Outputs and differential expression

# SCVI normalized expression: a potentially dense cells-by-genes matrix.
normalized = model.get_normalized_expression(
    gene_list=adata.var_names[:20].tolist(), library_size=1e4,
    n_samples=25, return_mean=True,
)
# This comparison is conditional on the fitted model and selected genes.
de = model.differential_expression(
    groupby="cell_type", group1="TypeA", group2="TypeB",
    mode="change", delta=0.5, fdr_target=0.05,
    batch_correction=False, n_samples_overall=5000,
)

cell_type must exist before the second call. DE scores are posterior model quantities, not p-values. Cell-level DE is not biological-replicate pseudobulk DE; see differential expression.

For persistence, reference mapping, minification, learning rates, metric direction, custom loaders and hardware, use workflows. The theory reference explains the assumptions needed to interpret uncertainty, zero inflation and counterfactual decoding.

Installation and verification

Use a dedicated environment, separate from packages with incompatible constraints:

uv venv --python 3.13 .venv-scvi
uv pip install --python .venv-scvi/bin/python "scvi-tools==1.5.1" "scanpy==1.12.4" igraph

On Windows, use .venv-scvi/Scripts/python.exe. Select the appropriate PyTorch build for the hardware before GPU work. The cuda/cuda13 extras install additional CUDA dependencies; they are not needed for CPU or Apple MPS and do not guarantee working drivers. Specialized extras include regseq (genome sequences), diagvi, interpretability, dataloaders, and metal. Do not install every extra by default.

Check a small CPU fit and finite outputs in the actual environment before a long run; short synthetic fitting validates mechanics, not convergence or biology. Optional dataset loaders and genome/motif helpers may download data. No hosted inference endpoint, authentication, or pagination is part of this local workflow.

Sources: 1.5.1 release notes, package requirements, API reference.