Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs #5

Merged
merged 2 commits into from
Nov 11, 2024
Merged

Improve docs #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aab870e
Improve docs
moinfar Nov 11, 2024
a134d4e
Improve docs
moinfar Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@
:toctree: generated

model.DRVI
model.DRVIModule
```
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ dev = [
"twine>=4.0.2",
]
doc = [
"merlin-dataloader==23.8.0",
"docutils>=0.8,!=0.18.*,!=0.19.*",
"sphinx>=4",
"sphinx-book-theme>=1.0.0",
Expand Down
3 changes: 2 additions & 1 deletion src/drvi/model/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
from drvi.scvi_tools_based.model import DRVI
from drvi.scvi_tools_based.module import DRVIModule

__all__ = ["DRVI"]
__all__ = ["DRVI", "DRVIModule"]
2 changes: 1 addition & 1 deletion src/drvi/scvi_tools_based/model/_drvi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class DRVI(VAEMixin, DRVIArchesMixin, UnsupervisedTrainingMixin, BaseModelClass,
categorical_covariates
Categorical Covariates as a list of texts. You can specify emb dimension by appending @dim to each cpvariate.
**model_kwargs
Keyword args for :class:`~drvi.model.DRVI`
Keyword args for :class:`~drvi.model.DRVIModule`

Examples
--------
Expand Down
Loading