acreeca commited on
Commit
9bcd101
·
verified ·
1 Parent(s): f76dd97

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +7 -28
README.md CHANGED
@@ -25,7 +25,7 @@ Recommended defaults: **QuantEM for mitochondria; OmniEM for ER, nucleus and lip
25
 
26
  ## Use
27
 
28
- These files are not loaded directly. Install the library, which resolves, downloads, verifies and
29
  assembles them for you:
30
 
31
  ```bash
@@ -39,32 +39,12 @@ model = load_model("quantem/mito") # downloads on first use, then cache
39
  labels = segment(model, image, pixel_size_nm=8.0)
40
  ```
41
 
42
- For a GUI, install the napari plugin instead it wraps the same library with segmentation,
43
- proofreading, head-only fine-tuning, batch mode and morphometrics:
44
-
45
- ```bash
46
- pip install napari-quantem
47
- ```
48
-
49
- Pre-seed a shared or air-gapped cache with:
50
-
51
- ```bash
52
- python -m quantem_em.weights download --all
53
- QUANTEM_MODEL_DIR=/srv/quantem python -m quantem_em.weights verify
54
- ```
55
 
56
  ## Files
57
 
58
- Encoders are split so nothing is downloaded twice. **The split is not uniform**, because the
59
- families adapt their encoders differently:
60
-
61
- * **OmniEM** uses LoRA, which never touches the base weights — so `omniem-vitl` is a complete
62
- encoder genuinely shared by all four heads, and each head is only ~26 MB.
63
- * **QuantEM** mito/nucleus/LD fine-tune the **last four blocks**, which therefore differ per
64
- organelle. `quantem-vitb-trunk` is blocks 0–7 plus embeddings and the final norm; blocks 8–11
65
- ship inside each organelle file.
66
- * **`quantem-er` is self-contained.** It was adapted with `full`, replacing the whole encoder, so
67
- it needs no trunk.
68
 
69
  | File | Size | Contents | SHA-256 |
70
  |---|--:|---|---|
@@ -79,14 +59,13 @@ families adapt their encoders differently:
79
  | `omniem-ld.safetensors` | 25.7 MB | model | `ae5b0c356e0fb48d…` |
80
  | `omniem-er.safetensors` | 135.2 MB | model | `3e3a693ea757d500…` |
81
 
82
- Every file is verified against the SHA-256 above on download **and on every subsequent load**, so a
83
- truncated or altered file is detected rather than trusted.
84
 
85
  ## Licence
86
 
87
  **The weights are released under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).**
88
- Commercial use, redistribution and modification are permitted; the only condition is attribution
89
- credit the QuantEM authors, link to the licence, and indicate if you made changes.
90
 
91
  ## Attribution
92
 
 
25
 
26
  ## Use
27
 
28
+ These files are not loaded directly. Install the core library, which resolves, downloads, verifies and
29
  assembles them for you:
30
 
31
  ```bash
 
39
  labels = segment(model, image, pixel_size_nm=8.0)
40
  ```
41
 
42
+ For a GUI, install the napari plugin or the application instead they incorporate segmentation, fine-tuning,
43
+ and downstream metrics. See https://github.com/ArrojoDrigoLab/QuantEM
 
 
 
 
 
 
 
 
 
 
 
44
 
45
  ## Files
46
 
47
+ Encoders are split to avoid inefficient duplicate weight downloads.
 
 
 
 
 
 
 
 
 
48
 
49
  | File | Size | Contents | SHA-256 |
50
  |---|--:|---|---|
 
59
  | `omniem-ld.safetensors` | 25.7 MB | model | `ae5b0c356e0fb48d…` |
60
  | `omniem-er.safetensors` | 135.2 MB | model | `3e3a693ea757d500…` |
61
 
62
+ Every file is verified against the SHA-256 above on download.
 
63
 
64
  ## Licence
65
 
66
  **The weights are released under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).**
67
+ If using OmniEM-based models, you should cite its original publication in addition to ours:
68
+ https://www.biorxiv.org/content/10.1101/2025.04.13.648639
69
 
70
  ## Attribution
71