Upload README.md with huggingface_hub

README.md

@@ -12,15 +12,99 @@ tags:
 - annotated:False
 ---
 
-# Description
+
+ScVI is a variational inference model for single-cell RNA-seq data that can learn an underlying
+latent space, integrate technical batches and impute dropouts.
+The learned low-dimensional latent representation of the data can be used for visualization and
+clustering.
+
+scVI takes as input a scRNA-seq gene expression matrix with cells and genes.
+We provide an extensive [user guide](https://docs.scvi-tools.org/en/1.2.0/user_guide/models/scvi.html).
+
+- See our original manuscript for further details of the model:
+[scVI manuscript](https://www.nature.com/articles/s41592-018-0229-2).
+- 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
 
 scVI model trained on synthetic IID data and uploaded with the full training data.
 
-# 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 | 1.00  | 0.98           |
+| Pearson Correlation | 0.00  | -0.15  |
+| Spearman Correlation | 0.05 | 0.01  |
+| R² (R-Squared) | -16.10  | -19.17      |
+
+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 | 1.06   |
+| Pearson Correlation | -0.09  |
+| Spearman Correlation | 0.01 |
+| R² (R-Squared) | -2.47  |
+
+</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 |
+| --- | --- | --- | --- | --- | --- | --- | --- |
+| 0 | 0.00 | 0.88 | 0.13 | 0.07 | 0.52 | 0.35 | 50.00 |
+| 1 | 0.20 | 0.75 | 0.17 | 0.20 | 0.52 | 0.23 | 48.00 |
+| 2 | 0.20 | 0.92 | 0.08 | 0.11 | 0.49 | 0.35 | 41.00 |
+| 3 | 0.20 | 0.85 | 0.09 | 0.08 | 0.57 | 0.31 | 39.00 |
+| 4 | 0.00 | 0.89 | 0.12 | 0.10 | 0.47 | 0.23 | 37.00 |
+| 5 | 0.00 | 1.08 | -0.15 | -0.17 | 0.40 | 0.16 | 37.00 |
+| 6 | 0.10 | 0.87 | 0.09 | 0.09 | 0.36 | 0.12 | 32.00 |
+| 7 | 0.00 | 1.25 | -0.22 | -0.26 | 0.55 | 0.24 | 31.00 |
+| 8 | 0.20 | 0.97 | 0.11 | 0.12 | 0.56 | 0.25 | 28.00 |
+| 9 | 0.10 | 1.03 | 0.21 | 0.18 | 0.49 | 0.31 | 26.00 |
+| 10 | 0.10 | 1.17 | 0.05 | 0.10 | 0.50 | 0.24 | 19.00 |
+| 11 | 0.20 | 1.26 | 0.25 | 0.30 | 0.62 | 0.36 | 12.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,
@@ -33,7 +117,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
 {
     "layer": null,
@@ -45,44 +134,53 @@ Many model properties are in the model tags. Some more are listed below.
 }
 ```
 
-**model_summary_stats**:
-|     Summary Stat Key     | Value |
-|--------------------------|-------|
-|         n_batch          |   1   |
-|         n_cells          |  400  |
-| n_extra_categorical_covs |   0   |
-| n_extra_continuous_covs  |   0   |
-|         n_labels         |   1   |
-|          n_vars          |  100  |
+</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']            |
 
-**model_data_registry**:
-| Registry Key |    scvi-tools Location    |
-|--------------|---------------------------|
-|      X       |          adata.X          |
-|    batch     | adata.obs['_scvi_batch']  |
-|    labels    | adata.obs['_scvi_labels'] |
+- **Data is Minified**: False
 
-**model_parent_module**: scvi.model
+</details>
+
+<details>
+<summary><strong>Summary Statistics</strong></summary>
+
+| Summary Stat Key          | Value |
+|--------------------------|-------|
+| n_batch                   | 1 |
+| n_cells                   | 400 |
+| n_extra_categorical_covs  | 0 |
+| n_extra_continuous_covs   | 0 |
+| n_labels                  | 1 |
+| n_vars                    | 100 |
 
-**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. -->
+**Training data url**: Not provided by uploader
 
-Training data url: N/A
+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
 
-To be added...
+To be added...