diff --git a/.github/misc/concept.svg b/.github/misc/concept.svg new file mode 100644 index 0000000..70f836c --- /dev/null +++ b/.github/misc/concept.svg @@ -0,0 +1,3 @@ + + +
$$x$$
$$c$$
$$\h...
Measured
variables
Measured...
$$z$$
Parameters of the generative distribution
Parameters of t...
$$f_1$$
$$f_2$$
$$f_3$$
$$f_k$$
Disentangled latent representation
Disentangled latent r...
Pooling
Pooling
$$c$$
$$g$$
Latent encoder
Latent encoder
Additive decoder
Additive decoder
$$\D...
$$z$$
$$f_1$$
$$f_2$$
$$f_k$$
Pooling
Pooling
$$c$$
Traverse 
Traverse 
$$z_i$$
for
for
$$ \...
Indirect identification 
of relevant genes
Indirect identificati...
Direct correlation / DE with genes
Direct correlation /...
Discover / validate
new programs
Discover / validate...
Identify programs with known gene sets
Identify programs wit...
Identify programs for known Cell types
Identify programs for...
$$(f)$$
$$\h...
$$\h...
$$\h...
$$\h...
Split
Split
$$f_3$$
Interpretability
Interpretability
Identification
Identification
Additive decoder
Additive decoder
$$(f)$$
Z
Z2 
 Z
 Z3 
 Z
 Z1 
Gene scores
per dimension
Gene scores...
Interpretability
Interpretability
Disentangled
Representation
Disentangled...
Z
Z1 
Z
Z2 
Z
Z3 
$$z_...
$$z_...
diff --git a/README.md b/README.md index 16ef345..875fd9a 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,19 @@ Unsupervised Deep Disentangled Representation of Single-Cell Omics +

+ + + DRVI concept + +

+ ## Getting started Please refer to the [documentation][link-docs]. In particular, the - [API documentation][link-api]. +- [Tutorials][link-tutorials] ## Installation @@ -42,23 +50,22 @@ See the [changelog][changelog]. ## Contact -[//]: # (TODO: make clear where to ask questions:) -[//]: # (For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse].) +[//]: # "TODO: make clear where to ask questions:" +[//]: # "For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse]." + If you found a bug, please use the [issue tracker][issue-tracker]. ## Citation -> t.b.a - -## Contributing +If DRVI is helpful in your research, please consider citing the following paper: -## Authors and acknowledgment +> t.b.a ## License - [issue-tracker]: https://github.com/theislab/drvi/issues [changelog]: https://drvi.readthedocs.io/latest/changelog.html [link-docs]: https://drvi.readthedocs.io [link-api]: https://drvi.readthedocs.io/latest/api.html +[link-tutorials]: https://drvi.readthedocs.io/latest/tutorials.html [link-pypi]: https://pypi.org/project/drvi-py diff --git a/docs/index.md b/docs/index.md index a884d1b..1f4ea2b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,6 +10,5 @@ api/index.md changelog.md contributing.md references.md - -notebooks/general_pipeline +tutorials.md ``` diff --git a/docs/references.md b/docs/references.md index 00ad6a6..e7c7548 100644 --- a/docs/references.md +++ b/docs/references.md @@ -1,5 +1,7 @@ # References +If DRVI is helpful in your research, please consider citing the following paper: + ```{bibliography} :cited: ``` diff --git a/docs/tutorials.md b/docs/tutorials.md new file mode 100644 index 0000000..d071e94 --- /dev/null +++ b/docs/tutorials.md @@ -0,0 +1,7 @@ +# Tutorials + +```{toctree} +:maxdepth: 2 + +notebooks/general_pipeline +```