Upload README.md with huggingface_hub

README.md

@@ -1,27 +1,111 @@
 ---
-license: cc-by-4.0
 library_name: scvi-tools
+license: cc-by-4.0
 tags:
 - biology
 - genomics
 - single-cell
 - model_cls_name:CondSCVI
-- scvi_version:1.1.0
-- anndata_version:0.10.3
+- scvi_version:1.2.0
+- anndata_version:0.11.1
 - modality:rna
-- tissue:Liver
+- tissue:various
 - annotated:True
 ---
 
-# Description
+
+CondSCVI is a variational inference model for single-cell RNA-seq data that can learn an underlying
+latent space. The predictions of the model are meant to be afterward
+used for deconvolution of a second spatial transcriptomics dataset in DestVI. DestVI predicts the
+cell-type proportions as well as cell type-specific activation state
+in the spatial data.
+
+CondSCVI takes as input a scRNA-seq gene expression matrix with cells and genes as well as a
+cell-type annotation for all cells.
+We provide an extensive [user guide](https://docs.scvi-tools.org/en/1.2.0/user_guide/models/destvi.html)
+for DestVI including a description of CondSCVI.
+
+- See our original manuscript for further details of the model:
+[DestVI manuscript](https://www.nature.com/articles/s41587-022-01272-8).
+- See our manuscript on [scvi-hub](https://www.biorxiv.org/content/10.1101/2024.03.01.582887v2)
+how to leverage pre-trained models.
+
+
+# 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 | 4.33  | 4.63           |
+| Pearson Correlation | 0.00  | -0.05  |
+| Spearman Correlation | 0.09 | 0.07  |
+| R² (R-Squared) | -147.02  | -183.16      |
+
+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 | 18.04   |
+| Pearson Correlation | 0.15  |
+| Spearman Correlation | 0.14 |
+| R² (R-Squared) | -15651.21  |
+
+</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**:
 
-Many model properties are in the model tags. Some more are listed below.
+| Index | gene_f1 | lfc_mae | lfc_pearson | lfc_spearman | roc_auc | pr_auc | n_cells |
+| --- | --- | --- | --- | --- | --- | --- | --- |
+| macrophage | 0.06 | 2.48 | 0.01 | 0.04 | 0.50 | 0.80 | 1379.00 |
+| monocyte | 0.04 | 3.31 | 0.02 | 0.09 | 0.50 | 0.76 | 605.00 |
+| endothelial cell of hepatic sinusoid | 0.03 | 3.50 | 0.06 | 0.04 | 0.49 | 0.69 | 341.00 |
+| mature NK T cell | 0.08 | 5.02 | 0.00 | 0.01 | 0.52 | 0.78 | 231.00 |
+| neutrophil | 0.02 | 6.40 | -0.01 | 0.04 | 0.61 | 0.75 | 81.00 |
+| fibroblast | 0.02 | 5.19 | -0.04 | -0.04 | 0.49 | 0.63 | 70.00 |
+| hepatocyte | 0.16 | 7.69 | 0.01 | 0.01 | 0.52 | 0.81 | 67.00 |
+| liver dendritic cell | 0.08 | 8.56 | 0.10 | 0.03 | 0.48 | 0.51 | 34.00 |
+| T cell | 0.03 | 10.88 | -0.05 | -0.03 | 0.50 | 0.55 | 20.00 |
+| plasma cell | 0.03 | 11.84 | 0.02 | -0.02 | 0.48 | 0.63 | 19.00 |
+| intrahepatic cholangiocyte | 0.05 | 9.51 | -0.00 | 0.00 | 0.50 | 0.56 | 11.00 |
+| erythrocyte | 0.07 | 24.40 | 0.01 | -0.01 | 0.43 | 0.87 | 2.00 |
 
-**model_init_params**:
+</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,
@@ -32,48 +116,63 @@ 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",
-    "layer": null
+    "layer": null,
+    "batch_key": null
 }
 ```
 
-**model_summary_stats**:
-| Summary Stat Key | Value |
-|------------------|-------|
-|     n_cells      | 2860  |
-|     n_labels     |  12   |
-|      n_vars      | 4000  |
+</details>
+
+<details>
+<summary><strong>Data Registry</strong></summary>
 
-**model_data_registry**:
+Registry elements for AnnData manager:
 | Registry Key |    scvi-tools Location    |
 |--------------|---------------------------|
 |      X       |          adata.X          |
 |    labels    | adata.obs['_scvi_labels'] |
 
-**model_parent_module**: scvi.model
+- **Data is Minified**: False
+
+</details>
+
+<details>
+<summary><strong>Summary Statistics</strong></summary>
+
+| Summary Stat Key | Value |
+|------------------|-------|
+|     n_cells      | 2860  |
+|     n_labels     |  12   |
+|      n_vars      | 3000  |
 
-**data_is_minified**: False
+</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/Liver_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**: https://github.com/YosefLab/scvi-hub-models/blob/main/src/scvi_hub_models/TS_train_all_tissues.ipynb
 
-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