Upload README.md with huggingface_hub

README.md

@@ -1,27 +1,116 @@
 ---
-license: cc-by-4.0
 library_name: scvi-tools
+license: cc-by-4.0
 tags:
 - biology
 - genomics
 - single-cell
 - model_cls_name:SCANVI
-- scvi_version:1.1.0
-- anndata_version:0.10.3
+- scvi_version:1.2.0
+- anndata_version:0.11.1
 - modality:rna
-- tissue:Bone_Marrow
+- tissue:various
 - annotated:True
 ---
 
-# Description
+
+ScANVI is a variational inference model for single-cell RNA-seq data that can learn an underlying
+latent space, integrate technical batches and impute dropouts.
+In addition, to scVI, ScANVI is a semi-supervised model that can leverage labeled data to learn a
+cell-type classifier in the latent space and afterward predict cell types of new data.
+The learned low-dimensional latent representation of the data can be used for visualization and
+clustering.
+
+scANVI takes as input a scRNA-seq gene expression matrix with cells and genes as well as a
+cell-type annotation for a subset of cells.
+We provide an extensive [user guide](https://docs.scvi-tools.org/en/1.2.0/user_guide/models/scanvi.html).
+
+- See our original manuscript for further details of the model:
+[scANVI manuscript](https://www.embopress.org/doi/full/10.15252/msb.20209620).
+- 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/1.0.0/tutorials/notebooks/scarches_scvi_tools.html).
+
+
+# Model Description
 
 Tabula Sapiens is a benchmark, first-draft human cell atlas of nearly 500,000 cells from 24 organs of 15 normal human subjects.
 
-# Model properties
+# 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**:
+
+| Metric                  | Training Value | Validation Value |
+|-------------------------|----------------|------------------|
+| Mean Absolute Error | 2.28  | 2.26           |
+| Pearson Correlation | 0.85  | 0.85  |
+| Spearman Correlation | 0.86 | 0.86  |
+| R² (R-Squared) | 0.54  | 0.55      |
+
+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**:
+
+| Metric                  | Training Value |
+|-------------------------|----------------|
+| Mean Absolute Error | 12.58   |
+| Pearson Correlation | 0.61  |
+| Spearman Correlation | 0.68 |
+| R² (R-Squared) | -0.87  |
+
+</details>
 
-Many model properties are in the model tags. Some more are listed below.
+<details>
+<summary><strong>Differential expression metric</strong></summary>
 
-**model_init_params**:
+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**:
+
+| Index | gene_f1 | lfc_mae | lfc_pearson | lfc_spearman | roc_auc | pr_auc | n_cells |
+| --- | --- | --- | --- | --- | --- | --- | --- |
+| neutrophil | 0.94 | 2.13 | 0.68 | 0.89 | 0.18 | 0.84 | 2911.00 |
+| CD4-positive, alpha-beta T cell | 0.93 | 1.95 | 0.62 | 0.91 | 0.34 | 0.79 | 2025.00 |
+| monocyte | 0.88 | 1.76 | 0.65 | 0.90 | 0.39 | 0.78 | 1389.00 |
+| CD8-positive, alpha-beta T cell | 0.87 | 3.04 | 0.55 | 0.84 | 0.32 | 0.74 | 1147.00 |
+| granulocyte | 0.77 | 2.38 | 0.64 | 0.89 | 0.45 | 0.83 | 853.00 |
+| plasma cell | 0.79 | 2.25 | 0.73 | 0.92 | 0.19 | 0.85 | 825.00 |
+| erythroid progenitor cell | 0.59 | 2.34 | 0.70 | 0.93 | 0.48 | 0.89 | 757.00 |
+| mature NK T cell | 0.78 | 3.76 | 0.58 | 0.78 | 0.33 | 0.69 | 678.00 |
+| hematopoietic stem cell | 0.90 | 2.20 | 0.67 | 0.89 | 0.53 | 0.85 | 617.00 |
+| memory B cell | 0.87 | 4.15 | 0.61 | 0.72 | 0.32 | 0.69 | 310.00 |
+| common myeloid progenitor | 0.70 | 2.72 | 0.70 | 0.89 | 0.55 | 0.88 | 287.00 |
+| macrophage | 0.85 | 4.31 | 0.64 | 0.71 | 0.34 | 0.78 | 265.00 |
+| naive B cell | 0.88 | 5.38 | 0.59 | 0.67 | 0.26 | 0.66 | 142.00 |
+| erythrocyte | 0.90 | 4.94 | 0.57 | 0.52 | 0.31 | 0.90 | 87.00 |
+
+</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_hidden": 128,
@@ -38,7 +127,12 @@ Many model properties are in the model tags. Some more are listed below.
 }
 ```
 
-**model_setup_anndata_args**:
+</details>
+
+<details>
+<summary><strong>Setup Data Arguments</strong></summary>
+
+Arguments passed to setup_anndata of the original model:
 ```json
 {
     "labels_key": "cell_ontology_class",
@@ -47,11 +141,34 @@ Many model properties are in the model tags. Some more are listed below.
     "batch_key": "donor_assay",
     "size_factor_key": null,
     "categorical_covariate_keys": null,
-    "continuous_covariate_keys": null
+    "continuous_covariate_keys": null,
+    "use_minified": false
 }
 ```
 
-**model_summary_stats**:
+</details>
+
+<details>
+<summary><strong>Data Registry</strong></summary>
+
+Registry elements for AnnData manager:
+|   Registry Key    |         scvi-tools Location          |
+|-------------------|--------------------------------------|
+|         X         |               adata.X                |
+|       batch       |       adata.obs['_scvi_batch']       |
+|      labels       |      adata.obs['_scvi_labels']       |
+|    latent_qzm     |   adata.obsm['scanvi_latent_qzm']    |
+|    latent_qzv     |   adata.obsm['scanvi_latent_qzv']    |
+|    minify_type    | adata.uns['_scvi_adata_minify_type'] |
+| observed_lib_size |    adata.obs['observed_lib_size']    |
+
+- **Data is Minified**: False
+
+</details>
+
+<details>
+<summary><strong>Summary Statistics</strong></summary>
+
 |     Summary Stat Key     | Value |
 |--------------------------|-------|
 |         n_batch          |   7   |
@@ -61,40 +178,27 @@ Many model properties are in the model tags. Some more are listed below.
 |         n_labels         |  15   |
 |       n_latent_qzm       |  20   |
 |       n_latent_qzv       |  20   |
-|          n_vars          | 4000  |
-
-**model_data_registry**:
-|   Registry Key    |          scvi-tools Location           |
-|-------------------|----------------------------------------|
-|         X         |                adata.X                 |
-|       batch       |        adata.obs['_scvi_batch']        |
-|      labels       |       adata.obs['_scvi_labels']        |
-|    latent_qzm     |    adata.obsm['_scanvi_latent_qzm']    |
-|    latent_qzv     |    adata.obsm['_scanvi_latent_qzv']    |
-|    minify_type    |  adata.uns['_scvi_adata_minify_type']  |
-| observed_lib_size | adata.obs['_scanvi_observed_lib_size'] |
-
-**model_parent_module**: scvi.model
+|          n_vars          | 3000  |
 
-**data_is_minified**: True
+</details>
 
-# Training data
 
-This is an optional link to where the training data is stored if it is too large
-to host on the huggingface Model hub.
+<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. -->
+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
 
-Training data url: https://zenodo.org/records/7608635/files/Bone_Marrow_training_data.h5ad
+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
+**Training Code URL**: Not provided by uploader
 
-This is an optional link to the code used to train the model.
+</details>
 
-Training code url: N/A
 
 # References
 
-The Tabula Sapiens Consortium. The Tabula Sapiens: A multiple-organ, single-cell transcriptomic atlas of humans. Science, May 2022. doi:10.1126/science.abl4896
+The Tabula Sapiens Consortium. The Tabula Sapiens: A multiple-organ, single-cell transcriptomic atlas of humans. Science, May 2022. doi:10.1126/science.abl4896