canergen commited on
Commit
fa82595
·
verified ·
1 Parent(s): 02170c9

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -17
README.md CHANGED
@@ -10,15 +10,16 @@ short_description: Probabilistic modeling and analysis of single-cell omics dat
10
  ---
11
  # **scvi-tools**
12
 
13
- Welcome to the **scvi-tools** Model Card. This repository contains state-of-the-art probabilistic models tailored for analyzing single-cell omics data, enabling researchers to gain meaningful biological insights through cutting-edge machine learning techniques.
14
- **scvi-tools** is a member of the [scverse ecosystem](https://scverse.org).
 
15
 
16
  ---
17
 
18
  ## **Model Overview**
19
- scvi-tools offers a comprehensive suite of models designed to address various challenges in single-cell data analysis. These models are scalable and extensively documented.
20
 
21
- ### **Key Models**
22
  - **[scVI](https://docs.scvi-tools.org/en/stable/user_guide/models.html#scvi)**:
23
  - A variational autoencoder for dimensionality reduction, batch correction, and clustering.
24
  - Ideal for processing single-cell RNA-seq data.
@@ -33,8 +34,8 @@ scvi-tools offers a comprehensive suite of models designed to address various ch
33
  - **[Stereoscope](https://docs.scvi-tools.org/en/stable/user_guide/models.html#stereoscope)**:
34
  - A deconvolution model for prediction of cell-type composition given subcellular spatial transcriptomics data. We provide here pre-trained single cell models.
35
 
36
- Explore the full list of models in our **[documentation](https://docs.scvi-tools.org/en/stable/user_guide/index.html)**.
37
- Please reach out on [discourse](https://discourse.scverse.org) if you want to add additional models to scvi-hub.
38
 
39
  ---
40
 
@@ -42,12 +43,13 @@ Please reach out on [discourse](https://discourse.scverse.org) if you want to ad
42
  These models have been applied to a wide array of biological questions, such as:
43
  - Batch correction across experiments.
44
  - Identification of rare cell populations.
45
- - Multi-modal integration of single-cell RNA and protein data.
46
- - Differential expression analysis in disease contexts.
47
 
48
- For hands-on examples, refer to our **[tutorials](https://docs.scvi-tools.org/en/stable/tutorials/index.html)**.
 
 
49
 
50
- To learn how to
51
 
52
  ---
53
 
@@ -65,15 +67,8 @@ To learn how to
65
  2. Follow our **[tutorials](https://docs.scvi-tools.org/en/stable/tutorials/index.html)** for step-by-step guides on using scvi-tools effectively.
66
  3. Dive into our **[models](https://docs.scvi-tools.org/en/stable/user_guide/index.html)** to see how they can transform your single-cell analysis.
67
 
68
- Learn how to apply scvi-hub for analysis of query datasets in our [HLCA tutorial](https://docs.scvi-tools.org/en/stable/tutorials/notebooks/scrna/query_hlca_knn.html)
69
- Discover how to efficiently access CELLxGENE census using our minified models in our [CELLxGENE census tutorial](https://docs.scvi-tools.org/en/stable/tutorials/notebooks/hub/cellxgene_census_model.html)
70
-
71
  ---
72
 
73
- ## **Contributing**
74
- scvi-tools is an open-source initiative. Contributions are welcome! Join us on GitHub to submit issues, suggest features, or collaborate.
75
- Contribute your own models to allow the single-cell community to leverage your reference datasets.
76
-
77
  ---
78
 
79
  ## **Contact**
 
10
  ---
11
  # **scvi-tools**
12
 
13
+ Welcome to the **scvi-tools** organization. We provide state-of-the-art probabilistic models tailored for analyzing single-cell omics data, enabling researchers to gain meaningful biological insights with scalable algorithms.
14
+ These models provide a consistent API making it easy to integrate it into your current analysis pipeline. **scvi-tools** is part of [scverse](https://scverse.org).
15
+ This is an open science initiative, please contribute your own models to allow the single-cell community to leverage your reference datasets. Learn how to upload your model in our [HubModel tutorials](https://docs.scvi-tools.org/en/stable/tutorials/notebooks/hub/scvi_hub_upload_and_large_files.html).
16
 
17
  ---
18
 
19
  ## **Model Overview**
20
+ scvi-tools offers a comprehensive suite of models designed to address various challenges in single-cell data analysis.
21
 
22
+ ### **Current HubModels**
23
  - **[scVI](https://docs.scvi-tools.org/en/stable/user_guide/models.html#scvi)**:
24
  - A variational autoencoder for dimensionality reduction, batch correction, and clustering.
25
  - Ideal for processing single-cell RNA-seq data.
 
34
  - **[Stereoscope](https://docs.scvi-tools.org/en/stable/user_guide/models.html#stereoscope)**:
35
  - A deconvolution model for prediction of cell-type composition given subcellular spatial transcriptomics data. We provide here pre-trained single cell models.
36
 
37
+ Explore the full list of models in scvi-tools in our **[user guide](https://docs.scvi-tools.org/en/stable/user_guide/index.html)**.
38
+ Please reach out on [discourse](https://discourse.scverse.org), if you want to add additional models to HuggingFace.
39
 
40
  ---
41
 
 
43
  These models have been applied to a wide array of biological questions, such as:
44
  - Batch correction across experiments.
45
  - Identification of rare cell populations.
46
+ - Multi-modal integration of single-cell RNA, ATAC and protein data.
47
+ - Differential expression and abundance analysis in disease contexts.
48
 
49
+ For hands-on examples, refer to our **[tutorials](https://docs.scvi-tools.org/en/stable/tutorials/index.html)**.
50
+ Learn how to apply scvi-hub for analysis of query datasets in our [HLCA tutorial](https://docs.scvi-tools.org/en/stable/tutorials/notebooks/scrna/query_hlca_knn.html).
51
+ Discover how to efficiently access CELLxGENE census using our minified models in our [CELLxGENE census tutorial](https://docs.scvi-tools.org/en/stable/tutorials/notebooks/hub/cellxgene_census_model.html).
52
 
 
53
 
54
  ---
55
 
 
67
  2. Follow our **[tutorials](https://docs.scvi-tools.org/en/stable/tutorials/index.html)** for step-by-step guides on using scvi-tools effectively.
68
  3. Dive into our **[models](https://docs.scvi-tools.org/en/stable/user_guide/index.html)** to see how they can transform your single-cell analysis.
69
 
 
 
 
70
  ---
71
 
 
 
 
 
72
  ---
73
 
74
  ## **Contact**