Update README.md
Browse files
README.md
CHANGED
|
@@ -6,5 +6,70 @@ colorTo: blue
|
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 9 |
|
| 10 |
-
|
|
|
|
| 6 |
sdk: static
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
+
---
|
| 10 |
+
title: CellMap
|
| 11 |
+
emoji: 🔬
|
| 12 |
+
colorFrom: blue
|
| 13 |
+
colorTo: green
|
| 14 |
+
---
|
| 15 |
+
|
| 16 |
+
<img src="https://raw.githubusercontent.com/janelia-cellmap/cellmap-models/main/assets/CellMapLogo2.png" alt="CellMap logo" width="60%">
|
| 17 |
+
|
| 18 |
+
# CellMap - HHMI Janelia
|
| 19 |
+
|
| 20 |
+
The [CellMap](https://www.janelia.org/project-team/cellmap) project team at **HHMI Janelia Research Campus** develops machine learning models for segmentation of cellular structures in volume electron microscopy (vEM) data.
|
| 21 |
+
|
| 22 |
+
## Models
|
| 23 |
+
|
| 24 |
+
We provide pre-trained deep learning models for 3D organelle segmentation, available in multiple formats:
|
| 25 |
+
|
| 26 |
+
| Format | Extension | Use Case |
|
| 27 |
+
|---|---|---|
|
| 28 |
+
| PyTorch | `.pt` | Full model for Python workflows |
|
| 29 |
+
| TorchScript | `.ts` | Deployment without Python dependencies |
|
| 30 |
+
| ONNX | `.onnx` | Cross-framework inference |
|
| 31 |
+
|
| 32 |
+
### Available Segmentation Targets
|
| 33 |
+
|
| 34 |
+
- Mitochondria
|
| 35 |
+
- Endoplasmic Reticulum (ER)
|
| 36 |
+
- Nucleus
|
| 37 |
+
- Peroxisomes
|
| 38 |
+
- Plasma Membrane
|
| 39 |
+
- Vesicles
|
| 40 |
+
- And more...
|
| 41 |
+
|
| 42 |
+
## Quick Start
|
| 43 |
+
|
| 44 |
+
```bash
|
| 45 |
+
pip install cellmap-models
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
```python
|
| 49 |
+
from cellmap_models.model_export.cellmap_model import CellmapModel
|
| 50 |
+
from huggingface_hub import snapshot_download
|
| 51 |
+
|
| 52 |
+
# Download and load any model
|
| 53 |
+
path = snapshot_download(repo_id="cellmap/your-model-name")
|
| 54 |
+
model = CellmapModel(path)
|
| 55 |
+
|
| 56 |
+
# Inference
|
| 57 |
+
output = model.ts_model(input_tensor)
|
| 58 |
+
|
| 59 |
+
# Finetuning
|
| 60 |
+
trainable_model = model.train()
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
## Resources
|
| 64 |
+
|
| 65 |
+
- [cellmap-models (GitHub)](https://github.com/janelia-cellmap/cellmap-models) - Model architectures, weights, and export tools
|
| 66 |
+
- [CellMap Project Page](https://www.janelia.org/project-team/cellmap)
|
| 67 |
+
- [OpenOrganelle](https://openorganelle.janelia.org/) - Browse our EM datasets
|
| 68 |
+
|
| 69 |
+
## Publications
|
| 70 |
+
|
| 71 |
+
- Heinrich, L. et al. [Whole-cell organelle segmentation in volume electron microscopy](https://doi.org/10.1038/s41586-021-03977-3). *Nature* (2021)
|
| 72 |
+
|
| 73 |
+
## Contact
|
| 74 |
|
| 75 |
+
For questions or collaborations, visit our [GitHub](https://github.com/janelia-cellmap) or reach out through the [Janelia CellMap](https://www.janelia.org/project-team/cellmap) project page.
|