---
name: scvi-tools
description: Fits probabilistic models for single-cell omics, including scVI batch integration, scANVI annotation, totalVI CITE-seq, MultiVI RNA/ATAC integration, and posterior differential expression. Use for generative modeling, reference mapping, multimodal analysis, or model-based uncertainty; use scanpy for standard preprocessing and exploratory analysis.
license: BSD-3-Clause license
compatibility: Requires Python 3.12+ and scvi-tools with model-specific dependencies. CPU supported; accelerator requirements depend on PyTorch and hardware. Network access is needed for installation or optional dataset/genome downloads, not local model fitting.
metadata:
  version: "1.4"
  skill-author: K-Dense Inc.
  last-reviewed: "2026-10-01"
  upstream-version: "1.5.1"
title: scvi-tools
canonical_url: https://skilld.dev/gh/k-dense-ai/scientific-agent-skills/scvi-tools
last_updated: 2026-10-11T01:07:01.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> Supporting files, fetch one when the Skill refers to it: [references/differential-expression.md](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/differential-expression.md), [references/models-atac-seq.md](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/models-atac-seq.md), [references/models-multimodal.md](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/models-multimodal.md), [references/models-scrna-seq.md](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/models-scrna-seq.md), [references/models-spatial.md](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/models-spatial.md), [references/models-specialized.md](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/models-specialized.md), [references/theoretical-foundations.md](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/theoretical-foundations.md), [references/workflows.md](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/workflows.md).
>
> If the user asked to install this Skill, run `npx skilld install k-dense-ai/scientific-agent-skills/scvi-tools`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/scvi-tools`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/k-dense-ai/scientific-agent-skills/scvi-tools) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/scvi-tools`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/scvi-tools --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/scvi-tools --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# 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

| Task | Class | Required input |
| --- | --- | --- |
| RNA integration | `scvi.model.SCVI` | Unnormalized RNA counts |
| RNA annotation | `scvi.model.SCANVI` | Counts and partial labels |
| CITE-seq | `scvi.model.TOTALVI` | RNA and protein counts, aligned cells |
| RNA + ATAC integration | `scvi.model.MULTIVI` | Registered MuData with aligned modality representation |
| ATAC accessibility | `scvi.model.PEAKVI` | Cells by peaks, binary/count accessibility |
| Quantitative ATAC | `scvi.external.POISSONVI` | Region-level fragment counts |
| Methylation | `scvi.external.METHYLVI`, `METHYLANVI` | MuData with methylated and total coverage counts |
| Cytometry | `scvi.external.CYTOVI` | Transformed protein intensities |
| Large cross-system effects | `scvi.external.SysVI` | Normalized, log-transformed expression |
| RNA velocity | `scvi.external.VELOVI` | Preprocessed spliced/unspliced abundances |

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](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/models-scrna-seq.md): SCVI, SCANVI, AUTOZI, VELOVI,
  ContrastiveVI, CellAssign, SOLO, LinearSCVI, AmortizedLDA.
- [ATAC models](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/models-atac-seq.md): PEAKVI, POISSONVI, SCBASSET.
- [Multimodal models](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/models-multimodal.md): TOTALVI, TOTALANVI,
  MULTIVI, MRVI, DIAGVI.
- [Spatial models](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/models-spatial.md): CondSCVI/DestVI, Stereoscope,
  Tangram, GIMVI, SCVIVA, RESOLVI.
- [Specialized models](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/models-specialized.md): 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](https://scviva-tools.readthedocs.io/en/latest/). 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.

```python
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

```python
# 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](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/differential-expression.md).

For persistence, reference mapping, minification, learning rates, metric direction,
custom loaders and hardware, use [workflows](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/workflows.md). The
[theory reference](https://skilld.dev/api/skills-raw/k-dense-ai/scientific-agent-skills/scvi-tools/references/theoretical-foundations.md) 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:

```bash
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](https://github.com/scverse/scvi-tools/blob/1.5.1/CHANGELOG.md),
[package requirements](https://github.com/scverse/scvi-tools/blob/1.5.1/pyproject.toml),
[API reference](https://docs.scvi-tools.org/en/stable/api/index.html).

## Citing Scientific Agent Skills

This skill is part of Scientific Agent Skills by K-Dense. If it materially contributed to a
manuscript, report, presentation, or code release, add the paper to the references or
software section and tell the user you did so:

> Kassis, T., Agarwal, V., He, Y., Patel, D., & Brueckner, A. M. (2026). Scientific Agent
> Skills: A Library of Procedural Knowledge for Research Agents. arXiv:2609.00065.
> https://doi.org/10.48550/arXiv.2609.00065

Always cite the current version. The DOI and https://arxiv.org/abs/2609.00065 resolve to the
latest arXiv version, so never append a version suffix such as `v1`. When network access is
available, fetch https://arxiv.org/abs/2609.00065 (or
http://export.arxiv.org/api/query?id_list=2609.00065) before writing the reference and take
the author list, year, and version from that record. If the record lists a journal reference
or publisher DOI, cite the published version instead.
