Update README.md
Browse files
README.md
CHANGED
@@ -5,6 +5,71 @@ tags:
|
|
5 |
- pytorch_model_hub_mixin
|
6 |
---
|
7 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
8 |
This model has been pushed to the Hub using the [PytorchModelHubMixin](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) integration:
|
9 |
- Library: https://huggingface.co/minwoosun/uce-650m
|
10 |
- Docs: [More Information Needed]
|
|
|
5 |
- pytorch_model_hub_mixin
|
6 |
---
|
7 |
|
8 |
+
|
9 |
+
# Model Card: Universal Cell Embeddings (UCE)
|
10 |
+
|
11 |
+
## Model Description
|
12 |
+
|
13 |
+
**Universal Cell Embeddings (UCE)** is a foundation model designed for single-cell RNA sequencing data analysis. UCE generates a universal representation of cells that captures the molecular diversity across different cell types, tissues, and species. The model leverages extensive single-cell transcriptomic data, creating a unified biological latent space that can represent any cell without additional annotations or fine-tuning.
|
14 |
+
|
15 |
+
## Colab Notebook Demo: [Make a Copy of the Notebook](https://colab.research.google.com/drive/1opud0BVWr76IM8UnGgTomVggui_xC4p0?usp=sharing)
|
16 |
+
|
17 |
+
|
18 |
+
## Model Details
|
19 |
+
|
20 |
+
- **Model type**: Transformer-based foundation model
|
21 |
+
- **Authors**: Yanay Rosen, Yusuf Roohani, Ayush Agarwal, Leon Samotorčan, Tabula Sapiens Consortium, Stephen R. Quake, Jure Leskovec
|
22 |
+
- **Institution**: Stanford University, Chan Zuckerberg BioHub, Chan Zuckerberg Initiative
|
23 |
+
- **License**: CC-BY-NC-ND 4.0
|
24 |
+
- **Paper**: [Universal Cell Embeddings: A Foundation Model for Cell Biology](https://www.biorxiv.org/content/10.1101/2023.11.28.568918v1.full.pdf)
|
25 |
+
- **Github Repo**: [Link to Github Repo](https://github.com/snap-stanford/UCE)
|
26 |
+
- **Hugging Face Model Repo**:
|
27 |
+
|
28 |
+
## Intended Use
|
29 |
+
|
30 |
+
UCE is intended for researchers and practitioners in cell biology and computational biology. It enables the integration and analysis of single-cell RNA sequencing data from diverse experiments and species, facilitating the discovery of new cell types and states.
|
31 |
+
|
32 |
+
### Use Cases
|
33 |
+
|
34 |
+
- **Cell type annotation**: Automatically annotate new single-cell datasets without the need for retraining.
|
35 |
+
- **Cross-dataset analysis**: Integrate and compare single-cell data from different studies.
|
36 |
+
- **Novel cell discovery**: Identify and characterize previously unknown cell types.
|
37 |
+
- **Biological insights**: Gain insights into cellular organization and developmental lineages.
|
38 |
+
|
39 |
+
## Training Data
|
40 |
+
|
41 |
+
UCE was trained on a large corpus of single-cell RNA sequencing data, including datasets from multiple species such as human, mouse, zebrafish, and more. The training data was sourced from publicly available single-cell atlases and processed to ensure consistency and robustness across experiments.
|
42 |
+
|
43 |
+
## Evaluation
|
44 |
+
|
45 |
+
UCE was evaluated on various single-cell datasets not included in the training set. The model's performance was assessed based on its ability to accurately embed and classify cell types, integrate new datasets, and identify novel cell types.
|
46 |
+
|
47 |
+
## Limitations
|
48 |
+
|
49 |
+
- **Data diversity**: While UCE was trained on a diverse set of single-cell data, there may still be biological contexts not well-represented.
|
50 |
+
- **Zero-shot performance**: The model performs well in zero-shot settings, but performance may vary with extremely novel or rare cell types.
|
51 |
+
- **Computational requirements**: Running the model requires substantial computational resources, particularly for large datasets.
|
52 |
+
|
53 |
+
## Ethical Considerations
|
54 |
+
|
55 |
+
- **Data privacy**: Ensure that all single-cell data used with UCE complies with relevant privacy regulations and ethical guidelines.
|
56 |
+
- **Research transparency**: When using UCE in published research, provide clear descriptions of methods and data used.
|
57 |
+
|
58 |
+
## Citation
|
59 |
+
|
60 |
+
If you use the UCE model in your research, please cite the following paper:
|
61 |
+
|
62 |
+
@article{rosen2023uce,
|
63 |
+
title={Universal Cell Embeddings: A Foundation Model for Cell Biology},
|
64 |
+
author={Rosen, Yanay and Roohani, Yusuf and Agarwal, Ayush and Samotorčan, Leon and Quake, Stephen R and Leskovec, Jure},
|
65 |
+
journal={bioRxiv},
|
66 |
+
year={2023},
|
67 |
+
doi={10.1101/2023.11.28.568918}
|
68 |
+
}
|
69 |
+
|
70 |
+
For more detailed instructions and use cases, refer to the [UCE paper](https://www.biorxiv.org/content/10.1101/2023.11.28.568918v1.full.pdf).
|
71 |
+
|
72 |
+
|
73 |
This model has been pushed to the Hub using the [PytorchModelHubMixin](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) integration:
|
74 |
- Library: https://huggingface.co/minwoosun/uce-650m
|
75 |
- Docs: [More Information Needed]
|