Commit fa3a7b8
feat: Add JointEmbeddingSCVI model (#3883)
Hi!
I curated the code from "Improving SCVI for low-count cells through
self-supervised augmentation" into a pull request to add the new model
class in scvi-tools.
I am working on a tutorial (that is a bit more visual and intuitive than
the metrics I used in the paper). I'll PR that to the tutorials repo in
a bit.
The summary below was generated by GitHub, and summarizes it nicely:
> Add JointEmbeddingSCVI, a self-supervised SCVI variant that augments
the standard ELBO with a cross-correlation objective (CCO) between the
embedding of the data and a binomially-thinned view of it, encouraging
embeddings that are robust to count dropout/noise. A VICReg-style
variance term guards against dimension collapse.
>
> The joint-embedding loss is active only during training; evaluation
(get_elbo / get_marginal_ll / get_reconstruction_error) falls back to
the standard reweighted ELBO, and so does any minibatch with fewer than
two cells.
>
> Contents:
> - src/scvi/module/_joint_embedding_utils.py: binomial thinning,
per-cell thinning-probability sampling, cross-correlation and variance
losses
> - src/scvi/module/_joint_embedding_vae.py: JointEmbeddingVAE module
> - src/scvi/model/_joint_embedding_scvi.py: JointEmbeddingSCVI model
> - tests/model/test_joint_embedding_scvi.py,
tests/module/test_joint_embedding_utils.py
> - docs/api (user + developer) and CHANGELOG entries
>
>
---------
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: ori-kron-wis <ori.kronfeld@weizmann.ac.il>1 parent f34d577 commit fa3a7b8
15 files changed
Lines changed: 800 additions & 1 deletion
File tree
- docs
- api
- tutorials
- user_guide
- models
- src/scvi/external
- joint_embedding_scvi
- tests/external/joint_embedding_scvi
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
| 18 | + | |
17 | 19 | | |
18 | 20 | | |
19 | 21 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
197 | 197 | | |
198 | 198 | | |
199 | 199 | | |
200 | | - | |
| 200 | + | |
201 | 201 | | |
202 | 202 | | |
203 | 203 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
67 | 67 | | |
68 | 68 | | |
69 | 69 | | |
| 70 | + | |
70 | 71 | | |
71 | 72 | | |
72 | 73 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
386 | 386 | | |
387 | 387 | | |
388 | 388 | | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| 21 | + | |
21 | 22 | | |
22 | 23 | | |
23 | 24 | | |
| |||
126 | 127 | | |
127 | 128 | | |
128 | 129 | | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
129 | 137 | | |
130 | 138 | | |
131 | 139 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
57 | 60 | | |
58 | 61 | | |
59 | 62 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| 15 | + | |
15 | 16 | | |
16 | 17 | | |
17 | 18 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
7 | 8 | | |
8 | 9 | | |
9 | 10 | | |
| |||
22 | 23 | | |
23 | 24 | | |
24 | 25 | | |
| 26 | + | |
| 27 | + | |
25 | 28 | | |
26 | 29 | | |
27 | 30 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
0 commit comments