documentation about scvi-tools HOT 2 CLOSED

See also how Pytorch does their documentation. It's good -- let's make ours like that.

As an example, here is their documentation for a particular class appears on the web:
https://pytorch.org/docs/stable/_modules/torch/nn/modules/conv.html#Conv2d

And here is their source code, which generates that documentation:
https://pytorch.org/docs/stable/_modules/torch/nn/modules/conv.html#Conv2d

I like that they have links between html showing their source code ([source]) and the html showing their documentation ([docs]). I like that they use :attr: whenever they mention an argument.

from scvi-tools.

For documenting the dataset classes (e.g. CbmcDataset), you might add docstrings to them that include the descriptions of each dataset from section 4.5 of the article: https://www.biorxiv.org/content/biorxiv/early/2018/03/30/292037.full.pdf

The Sphinx will include these descriptions in our readthedocs site.

from scvi-tools.