README.md

---
library_name: scvi-tools
license: cc-by-4.0
tags:
- biology
- genomics
- single-cell
- model_cls_name:TOTALVI
- scvi_version:1.4.2
- anndata_version:0.12.7
- modality:rna
- modality:protein
- tissue:thymus
- annotated:True
---


TotalVI is a variational inference model for single-cell RNA-seq as well as protein data that can
learn an underlying latent space, integrate technical batches, impute dropouts,
and predict protein expression given gene expression or missing protein data given gene expression
and protein data for a subset of proteins.
The learned low-dimensional latent representation of the data can be used for visualization and
clustering.

TotalVI takes as input a scRNA-seq gene expression and protein expression matrix with cells and
genes.
We provide an extensive [user guide](https://docs.scvi-tools.org/en/stable/user_guide/models/totalvi.html).

- See our original manuscript for further details of the model:
[TotalVI manuscript](https://www.nature.com/articles/s41592-020-01050-x).
- See our manuscript on [scvi-hub](https://www.biorxiv.org/content/10.1101/2024.03.01.582887v2)
how to leverage pre-trained models.

This model can be used for fine tuning on new data using our Arches framework:
[Arches tutorial](https://docs.scvi-tools.org/en/stable/tutorials/notebooks/scrna/scarches_scvi_tools.html).


# Model Description

CITE-seq to measure RNA and surface proteins in thymocytes from wild-type and T cell lineage-restricted mice to generate a comprehensive timeline of cell state for each T cell lineage.

# Metrics

We provide here key performance metrics for the uploaded model, if provided by the data uploader.

<details>
<summary><strong>Coefficient of variation</strong></summary>

The cell-wise coefficient of variation summarizes how well variation between different cells is
preserved by the generated model expression. Below a squared Pearson correlation coefficient of 0.4
, we would recommend not to use generated data for downstream analysis, while the generated latent
space might still be useful for analysis.

**Cell-wise Coefficient of Variation**:

Not provided by uploader

The gene-wise coefficient of variation summarizes how well variation between different genes is
preserved by the generated model expression. This value is usually quite high.

**Gene-wise Coefficient of Variation**:

Not provided by uploader

</details>

<details>
<summary><strong>Differential expression metric</strong></summary>

The differential expression metric provides a summary of the differential expression analysis
between cell types or input clusters. We provide here the F1-score, Pearson Correlation
Coefficient of Log-Foldchanges, Spearman Correlation Coefficient, and Area Under the Precision
Recall Curve (AUPRC) for the differential expression analysis using Wilcoxon Rank Sum test for each
cell-type.

**Differential expression**:

Not provided by uploader

</details>

# Model Properties

We provide here key parameters used to setup and train the model.

<details>
<summary><strong>Model Parameters</strong></summary>

These provide the settings to setup the original model:
```json
{
    "n_latent": 20,
    "gene_dispersion": "gene",
    "protein_dispersion": "protein",
    "gene_likelihood": "nb",
    "latent_distribution": "normal",
    "empirical_protein_background_prior": null,
    "override_missing_proteins": false
}
```

</details>

<details>
<summary><strong>Setup Data Arguments</strong></summary>

Arguments passed to setup_anndata of the original model:
```json
{
    "rna_layer": "counts",
    "protein_layer": null,
    "batch_key": "sample_id",
    "panel_key": null,
    "size_factor_key": null,
    "categorical_covariate_keys": null,
    "continuous_covariate_keys": null,
    "modalities": {
        "rna_layer": "rna",
        "protein_layer": "protein",
        "batch_key": "rna"
    }
}
```

</details>

<details>
<summary><strong>Data Registry</strong></summary>

Registry elements for AnnData manager:
| Registry Key             | scvi-tools Location                  |
|--------------------------|--------------------------------------|
| X                         | adata.mod['rna'].layers['counts']    |
| batch                     | adata.mod['rna'].obs['_scvi_batch']  |
| labels                    | adata.obs['_scvi_labels']            |
| latent_qzm                | adata.obsm['totalvi_latent_qzm']     |
| latent_qzv                | adata.obsm['totalvi_latent_qzv']     |
| minify_type               | adata.uns['_scvi_adata_minify_type'] |
| observed_lib_size         | adata.obs['observed_lib_size']       |
| proteins                  | adata.mod['protein'].X               |

- **Data is Minified**: False

</details>

<details>
<summary><strong>Summary Statistics</strong></summary>

| Summary Stat Key          | Value |
|--------------------------|-------|
| n_batch                   | 17 |
| n_cells                   | 72042 |
| n_extra_categorical_covs  | 0 |
| n_extra_continuous_covs   | 0 |
| n_labels                  | 1 |
| n_latent_qzm              | 20 |
| n_latent_qzv              | 20 |
| n_proteins                | 111 |
| n_vars                    | 4000 |

</details>


<details>
<summary><strong>Training</strong></summary>

<!-- If your model is not uploaded with any data (e.g., minified data) on the Model Hub, then make
sure to provide this field if you want users to be able to access your training data. See the
scvi-tools documentation for details. -->
**Training data url**: Not provided by uploader

If provided by the original uploader, for those interested in understanding or replicating the
training process, the code is available at the link below.

**Training Code URL**: https://github.com/YosefLab/Thymus_CITE-seq/blob/main/totalVI_AllData/totalVI_thymus111.ipynb

</details>


# References

Steier, Z., Aylard, D.A., McIntyre, L.L. et al. Single-cell multiomic analysis of thymocyte development reveals drivers of CD4+ T cell and CD8+ T cell lineage commitment. Nat Immunol 24, 1579–1590 (2023). https://doi.org/10.1038/s41590-023-01584-0.