Skip to content

Commit

Permalink
Backport PR scverse#1231: Add the codebase overview schematic to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
watiss authored and meeseeksmachine committed Nov 15, 2021
1 parent f627aaa commit 12ab994
Show file tree
Hide file tree
Showing 4 changed files with 8,545 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ scvi-tools contains the building blocks to develop and deploy novel probablistic
models. These building blocks are powered by popular probabilistic and
machine learning frameworks such as [PyTorch
Lightning](https://www.pytorchlightning.ai/) and
[Pyro](https://pyro.ai/).
[Pyro](https://pyro.ai/). For an overview of how the scvi-tools package
is structured, you may refer to [this](https://docs.scvi-tools.org/en/stable/user_guide/background/codebase_overview.html) page.

We recommend checking out the [skeleton
repository](https://github.com/YosefLab/scvi-tools-skeleton) as a
Expand Down
11 changes: 11 additions & 0 deletions docs/user_guide/background/codebase_overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
===================================
Overview of the scvi-tools codebase
===================================

Below is a static view of the scvi-tools codebase shown at the abstraction of discrete layers of components. Only select
components are shown for each layer and only a single model is presented (scVI).

.. figure:: figures/codebase_overview.svg
:class: img-fluid
:align: center
:alt: Codebase overview figure
Loading

0 comments on commit 12ab994

Please sign in to comment.