Scvi Tools
AnthropicOfficialPublished by Anthropic
- Skill
- Tool integration
- Data and AI
- Apache-2.0
- Low risk
- Has scripts
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
scvi-tools provides a suite of probabilistic models designed for the analysis of single-cell data, including scRNA-seq, scATAC-seq, and multi-modal datasets. It leverages variational autoencoders to handle batch correction, data integration, label transfer, and dimensionality reduction. This skill serves as a guide for utilizing specific models like scVI, scANVI, totalVI, PeakVI, MultiVI, DestVI, and veloVI, offering standardized workflows, CLI scripts for pipeline automation, and best practices for data preparation and model training.
What it does
- Performs batch correction and data integration across different experimental conditions.
- Supports multi-modal analysis for CITE-seq and multiome (RNA+ATAC) data.
- Enables label transfer and reference mapping between query and reference datasets.
- Facilitates spatial transcriptomics deconvolution and RNA velocity estimation.
- Provides modular Python scripts for common analysis pipelines.
- Offers guidance on model selection based on specific data types and research goals.
When to use it
- When integrating multiple single-cell datasets with significant batch effects.
- When analyzing multi-modal data such as CITE-seq or joint RNA+ATAC profiles.
- When performing reference-based label transfer or query-to-reference mapping.
- When conducting deep learning-based dimensionality reduction for clustering and visualization.
- When working with spatial transcriptomics or RNA velocity data.
Advantages
- Standardized approach to complex single-cell deep learning workflows.
- Modular scripts allow for reproducible and scalable analysis pipelines.
- Comprehensive model selection guide for diverse genomic data types.
- Built-in support for advanced tasks like batch correction and multi-modal integration.
- Clear documentation on data preparation requirements for probabilistic models.
Usage examples
- “How do I integrate two scRNA-seq datasets using scVI?”
- The agent provides the workflow for preparing the AnnData objects, selecting highly variable genes, setting up the model with batch keys, and training the scVI model.
- “I have CITE-seq data, which model should I use?”
- The agent identifies totalVI as the appropriate model and directs the user to the corresponding reference file for multi-modal integration.
- “How can I map my new scRNA-seq query data to an existing reference?”
- The agent explains the use of scArches for query-to-reference mapping and provides the necessary steps to configure the model.
- “What are the requirements for input data before training a model?”
- The agent outlines the necessity of raw integer count data, the importance of highly variable gene selection, and how to correctly set up the AnnData object.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/anthropics/scvi-tools/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip scvi-tools.zip -d .agents/skills
Documentation by Anthropic
scvi-tools Deep Learning Skill
This skill provides guidance for deep learning-based single-cell analysis using scvi-tools, the leading framework for probabilistic models in single-cell genomics.
How to Use This Skill
Identify the appropriate workflow from the model/workflow tables below
Read the corresponding reference file for detailed steps and code
Use scripts in
scripts/to avoid rewriting common codeFor installation or GPU issues, consult
references/environment_setup.mdFor debugging, consult
references/troubleshooting.md
When to Use This Skill
When scvi-tools, scVI, scANVI, or related models are mentioned
When deep learning-based batch correction or integration is needed
When working with multi-modal data (CITE-seq, multiome)
When reference mapping or label transfer is required
When analyzing ATAC-seq or spatial transcriptomics data
When learning latent representations of single-cell data
Model Selection Guide
| Data Type | Model | Primary Use Case |
|---|---|---|
| scRNA-seq | scVI | Unsupervised integration, DE, imputation |
| scRNA-seq + labels | scANVI | Label transfer, semi-supervised integration |
| CITE-seq (RNA+protein) | totalVI | Multi-modal integration, protein denoising |
| scATAC-seq | PeakVI | Chromatin accessibility analysis |
| Multiome (RNA+ATAC) | MultiVI | Joint modality analysis |
| Spatial + scRNA reference | DestVI | Cell type deconvolution |
| RNA velocity | veloVI | Transcriptional dynamics |
| Cross-technology | sysVI | System-level batch correction |
Workflow Reference Files
| Workflow | Reference File | Description |
|---|---|---|
| Environment Setup | references/environment_setup.md | Installation, GPU, version info |
| Data Preparation | references/data_preparation.md | Formatting data for any model |
| scRNA Integration | references/scrna_integration.md | scVI/scANVI batch correction |
| ATAC-seq Analysis | references/atac_peakvi.md | PeakVI for accessibility |
| CITE-seq Analysis | references/citeseq_totalvi.md | totalVI for protein+RNA |
| Multiome Analysis | references/multiome_multivi.md | MultiVI for RNA+ATAC |
| Spatial Deconvolution | references/spatial_deconvolution.md | DestVI spatial analysis |
| Label Transfer | references/label_transfer.md | scANVI reference mapping |
| scArches Mapping | references/scarches_mapping.md | Query-to-reference mapping |
| Batch Correction | references/batch_correction_sysvi.md | Advanced batch methods |
| RNA Velocity | references/rna_velocity_velovi.md | veloVI dynamics |
| Troubleshooting | references/troubleshooting.md | Common issues and solutions |
CLI Scripts
Modular scripts for common workflows. Chain together or modify as needed.
Pipeline Scripts
| Script | Purpose | Usage |
|---|---|---|
prepare_data.py | QC, filter, HVG selection | python scripts/prepare_data.py raw.h5ad prepared.h5ad --batch-key batch |
train_model.py | Train any scvi-tools model | python scripts/train_model.py prepared.h5ad results/ --model scvi |
cluster_embed.py | Neighbors, UMAP, Leiden | python scripts/cluster_embed.py adata.h5ad results/ |
differential_expression.py | DE analysis | python scripts/differential_expression.py model/ adata.h5ad de.csv --groupby leiden |
transfer_labels.py | Label transfer with scANVI | python scripts/transfer_labels.py ref_model/ query.h5ad results/ |
integrate_datasets.py | Multi-dataset integration | python scripts/integrate_datasets.py results/ data1.h5ad data2.h5ad |
validate_adata.py | Check data compatibility | python scripts/validate_adata.py data.h5ad --batch-key batch |
Example Workflow
# 1. Validate input data
python scripts/validate_adata.py raw.h5ad --batch-key batch --suggest
# 2. Prepare data (QC, HVG selection)
python scripts/prepare_data.py raw.h5ad prepared.h5ad --batch-key batch --n-hvgs 2000
# 3. Train model
python scripts/train_model.py prepared.h5ad results/ --model scvi --batch-key batch
# 4. Cluster and visualize
python scripts/cluster_embed.py results/adata_trained.h5ad results/ --resolution 0.8
# 5. Differential expression
python scripts/differential_expression.py results/model results/adata_clustered.h5ad results/de.csv --groupby leidenPython Utilities
The scripts/model_utils.py provides importable functions for custom workflows:
| Function | Purpose |
|---|---|
prepare_adata() | Data preparation (QC, HVG, layer setup) |
train_scvi() | Train scVI or scANVI |
evaluate_integration() | Compute integration metrics |
get_marker_genes() | Extract DE markers |
save_results() | Save model, data, plots |
auto_select_model() | Suggest best model |
quick_clustering() | Neighbors + UMAP + Leiden |
Critical Requirements
Raw counts required: scvi-tools models require integer count data
adata.layers["counts"] = adata.X.copy() # Before normalization scvi.model.SCVI.setup_anndata(adata, layer="counts")HVG selection: Use 2000-4000 highly variable genes
sc.pp.highly_variable_genes(adata, n_top_genes=2000, batch_key="batch", layer="counts", flavor="seurat_v3") adata = adata[:, adata.var['highly_variable']].copy()Batch information: Specify batch_key for integration
scvi.model.SCVI.setup_anndata(adata, layer="counts", batch_key="batch")
Quick Decision Tree
Need to integrate scRNA-seq data?
├── Have cell type labels? → scANVI (references/label_transfer.md)
└── No labels? → scVI (references/scrna_integration.md)
Have multi-modal data?
├── CITE-seq (RNA + protein)? → totalVI (references/citeseq_totalvi.md)
├── Multiome (RNA + ATAC)? → MultiVI (references/multiome_multivi.md)
└── scATAC-seq only? → PeakVI (references/atac_peakvi.md)
Have spatial data?
└── Need cell type deconvolution? → DestVI (references/spatial_deconvolution.md)
Have pre-trained reference model?
└── Map query to reference? → scArches (references/scarches_mapping.md)
Need RNA velocity?
└── veloVI (references/rna_velocity_velovi.md)
Strong cross-technology batch effects?
└── sysVI (references/batch_correction_sysvi.md)Key Resources
Files
- ATTRIBUTION.mdAdded by AutoGineer932 B
- LICENSE.txt10.0 KiB
- SKILL.md7.2 KiB
- references/atac_peakvi.md9.3 KiB
- references/batch_correction_sysvi.md10.2 KiB
- references/citeseq_totalvi.md10.1 KiB
- references/data_preparation.md6.2 KiB
- references/environment_setup.md6.3 KiB
- references/label_transfer.md10.2 KiB
- references/multiome_multivi.md8.9 KiB
- references/rna_velocity_velovi.md8.6 KiB
- references/scarches_mapping.md10.8 KiB
- references/scrna_integration.md9.6 KiB
- references/spatial_deconvolution.md11.2 KiB
- references/troubleshooting.md10.8 KiB
- scripts/cluster_embed.pyScript6.3 KiB
- scripts/differential_expression.pyScript6.7 KiB
- scripts/integrate_datasets.pyScript6.9 KiB
- scripts/model_utils.pyScript17.0 KiB
- scripts/prepare_data.pyScript5.1 KiB
- scripts/train_model.pyScript11.3 KiB
- scripts/transfer_labels.pyScript7.2 KiB
- scripts/validate_adata.pyScript11.9 KiB
references/batch_correction_sysvi.md
Advanced Batch Correction with sysVI
This reference covers system-level batch correction using sysVI, designed for integrating data across major technological or study differences.
Overview
sysVI (System Variational Inference) extends scVI for scenarios where:
Batch effects are very strong (different technologies)
Standard scVI over-corrects biological signal
You need to separate "system" effects from biological variation
When to Use sysVI vs scVI
| Scenario | Recommended Model |
|---|---|
| Same technology, different samples | scVI |
| 10x v2 vs 10x v3 | scVI (usually) |
| 10x vs Smart-seq2 | sysVI |
| Different sequencing depths | scVI with covariates |
| Cross-study integration | sysVI |
| Atlas-scale integration | sysVI |
Prerequisites
import scvi
import scanpy as sc
import numpy as np
print(f"scvi-tools version: {scvi.__version__}")Understanding sysVI Architecture
sysVI separates variation into:
Biological variation: Cell type, state, trajectory
System variation: Technology, study, lab effects
┌─────────────────┐
Input counts ──────►│ Encoder │
│ │
System info ───────►│ (conditioned) │
└────────┬────────┘
│
┌────────▼────────┐
│ Latent z │
│ (biological) │
└────────┬────────┘
│
┌────────▼────────┐
System info ───────►│ Decoder │
│ (conditioned) │
└────────┬────────┘
│
Reconstructed countsBasic sysVI Workflow
Step 1: Prepare Data
# Load datasets from different systems
adata1 = sc.read_h5ad("10x_data.h5ad")
adata2 = sc.read_h5ad("smartseq_data.h5ad")
# Add system labels
adata1.obs["system"] = "10x"
adata2.obs["system"] = "Smart-seq2"
# Add batch labels (within system)
# e.g., different samples within each technology
# Concatenate
adata = sc.concat([adata1, adata2])
# Store raw counts
adata.layers["counts"] = adata.X.copy()Step 2: HVG Selection
# Select HVGs considering both batch and system
sc.pp.highly_variable_genes(
adata,
n_top_genes=4000, # More genes for cross-system
flavor="seurat_v3",
batch_key="system", # Consider system for HVG
layer="counts"
)
# Optionally: ensure overlap between systems
# Check HVGs are expressed in both systems
adata = adata[:, adata.var["highly_variable"]].copy()Step 3: Setup and Train sysVI
# Setup AnnData
# Note: sysVI may be accessed differently depending on version
# Check scvi-tools documentation for current API
scvi.model.SCVI.setup_anndata(
adata,
layer="counts",
batch_key="sample", # Within-system batches
categorical_covariate_keys=["system"] # System-level covariate
)
# For true sysVI (if available in your version)
# scvi.model.SysVI.setup_anndata(...)
# Create model with system awareness
model = scvi.model.SCVI(
adata,
n_latent=30,
n_layers=2,
gene_likelihood="nb"
)
# Train
model.train(max_epochs=300)Step 4: Extract Representations
# Get latent representation
adata.obsm["X_integrated"] = model.get_latent_representation()
# Clustering and visualization
sc.pp.neighbors(adata, use_rep="X_integrated")
sc.tl.umap(adata)
sc.tl.leiden(adata)
# Check integration
sc.pl.umap(adata, color=["system", "leiden", "cell_type"])Alternative: Harmony + scVI
For cross-system integration, combining methods can work well:
import scanpy.external as sce
# First run PCA
sc.pp.pca(adata)
# Apply Harmony for initial alignment
sce.pp.harmony_integrate(adata, key="system")
# Then train scVI on Harmony-corrected embedding
# Or use Harmony representation directlyAlternative: Using Covariates in scVI
For moderate system effects:
# Include system as categorical covariate
scvi.model.SCVI.setup_anndata(
adata,
layer="counts",
batch_key="sample",
categorical_covariate_keys=["system", "technology_version"]
)
model = scvi.model.SCVI(adata, n_latent=30)
model.train()Alternative: Separate Models + Integration
For very different systems:
# Train separate models
scvi.model.SCVI.setup_anndata(adata1, layer="counts", batch_key="sample")
model1 = scvi.model.SCVI(adata1)
model1.train()
scvi.model.SCVI.setup_anndata(adata2, layer="counts", batch_key="sample")
model2 = scvi.model.SCVI(adata2)
model2.train()
# Get latent spaces
adata1.obsm["X_scVI"] = model1.get_latent_representation()
adata2.obsm["X_scVI"] = model2.get_latent_representation()
# Align with CCA or Harmony
# ... additional alignment stepEvaluating Cross-System Integration
Visual Assessment
import matplotlib.pyplot as plt
fig, axes = plt.subplots(1, 3, figsize=(15, 4))
# Color by system
sc.pl.umap(adata, color="system", ax=axes[0], show=False, title="By System")
# Color by cell type
sc.pl.umap(adata, color="cell_type", ax=axes[1], show=False, title="By Cell Type")
# Color by expression of marker
sc.pl.umap(adata, color="CD3D", ax=axes[2], show=False, title="CD3D Expression")
plt.tight_layout()Quantitative Metrics
# Using scib-metrics
from scib_metrics.benchmark import Benchmarker
bm = Benchmarker(
adata,
batch_key="system",
label_key="cell_type",
embedding_obsm_keys=["X_integrated"]
)
bm.benchmark()
# Key metrics:
# - Batch mixing (ASW_batch, Graph connectivity)
# - Bio conservation (NMI, ARI, ASW_label)LISI Scores
# Local Inverse Simpson's Index
from scib_metrics import lisi
# Batch LISI (higher = better mixing)
batch_lisi = lisi.ilisi_graph(
adata,
batch_key="system",
use_rep="X_integrated"
)
# Cell type LISI (lower = better preservation)
ct_lisi = lisi.clisi_graph(
adata,
label_key="cell_type",
use_rep="X_integrated"
)
print(f"Batch LISI: {batch_lisi.mean():.3f}")
print(f"Cell type LISI: {ct_lisi.mean():.3f}")Handling Specific Challenges
Different Gene Sets
# Find common genes
common_genes = adata1.var_names.intersection(adata2.var_names)
print(f"Common genes: {len(common_genes)}")
# If too few, use gene mapping
# Or impute missing genesDifferent Sequencing Depths
# Add depth as continuous covariate
adata.obs["log_counts"] = np.log1p(adata.obs["total_counts"])
scvi.model.SCVI.setup_anndata(
adata,
layer="counts",
batch_key="sample",
continuous_covariate_keys=["log_counts"]
)Unbalanced Cell Types
# Check cell type distribution per system
import pandas as pd
ct_dist = pd.crosstab(adata.obs["system"], adata.obs["cell_type"], normalize="index")
print(ct_dist)
# If very unbalanced, consider:
# 1. Subsample to balance
# 2. Use scANVI with labels to preserve rare typesComplete Pipeline
def integrate_cross_system(
adatas: dict,
system_key: str = "system",
batch_key: str = "batch",
cell_type_key: str = "cell_type",
n_top_genes: int = 4000,
n_latent: int = 30
):
"""
Integrate datasets from different technological systems.
Parameters
----------
adatas : dict
Dictionary of {system_name: AnnData}
system_key : str
Key for system annotation
batch_key : str
Key for within-system batch
cell_type_key : str
Key for cell type labels (optional)
n_top_genes : int
Number of HVGs
n_latent : int
Latent dimensions
Returns
-------
Integrated AnnData with model
"""
import scvi
import scanpy as sc
# Add system labels and concatenate
for system_name, adata in adatas.items():
adata.obs[system_key] = system_name
adata = sc.concat(list(adatas.values()))
# Find common genes
for name, ad in adatas.items():
if name == list(adatas.keys())[0]:
common_genes = set(ad.var_names)
else:
common_genes = common_genes.intersection(ad.var_names)
adata = adata[:, list(common_genes)].copy()
print(f"Common genes: {len(common_genes)}")
# Store counts
adata.layers["counts"] = adata.X.copy()
# HVG selection
sc.pp.highly_variable_genes(
adata,
n_top_genes=n_top_genes,
flavor="seurat_v3",
batch_key=system_key,
layer="counts"
)
adata = adata[:, adata.var["highly_variable"]].copy()
# Setup with system as covariate
scvi.model.SCVI.setup_anndata(
adata,
layer="counts",
batch_key=batch_key if batch_key in adata.obs else None,
categorical_covariate_keys=[system_key]
)
# Train
model = scvi.model.SCVI(adata, n_latent=n_latent, n_layers=2)
model.train(max_epochs=300, early_stopping=True)
# Get representation
adata.obsm["X_integrated"] = model.get_latent_representation()
# Clustering
sc.pp.neighbors(adata, use_rep="X_integrated")
sc.tl.umap(adata)
sc.tl.leiden(adata)
return adata, model
# Usage
adatas = {
"10x_v3": sc.read_h5ad("10x_v3_data.h5ad"),
"Smart-seq2": sc.read_h5ad("smartseq_data.h5ad"),
"Drop-seq": sc.read_h5ad("dropseq_data.h5ad")
}
adata_integrated, model = integrate_cross_system(adatas)
# Visualize
sc.pl.umap(adata_integrated, color=["system", "leiden"])Troubleshooting
| Issue | Cause | Solution |
|---|---|---|
| Systems don't mix | Effects too strong | Use more genes, increase n_latent |
| Over-correction | Model too aggressive | Reduce n_layers, use scANVI |
| Few common genes | Different platforms | Use gene name mapping |
| One system dominates | Unbalanced sizes | Subsample larger dataset |
Key References
Lopez et al. (2018) "Deep generative modeling for single-cell transcriptomics"
Luecken et al. (2022) "Benchmarking atlas-level data integration in single-cell genomics"
Requirements and compatibility
Written for: Claude Code, Claude apps
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs Python
Security
What our scanner noticed· Low risk
- Instructions that use the network
- Scripts that your agent may run
This skill includes scripts that your agent may run. Read them before you use it.
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Anthropic
- Publisher
- Anthropic (Official)
- Source
- anthropics/knowledge-work-plugins · bio-research/skills/scvi-tools · commit e050c2e
- Licence
- Apache License 2.0 (redistribution allowed)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Anthropic or Anthropic.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download scvi-tools.zip