Skip to content

Commit

Permalink
Backport PR #1637: Update doctrings for continuous and categorical co…
Browse files Browse the repository at this point in the history
…variate docstrings (#1642)

Co-authored-by: Valeh Valiollah Pour Amiri <[email protected]>
  • Loading branch information
meeseeksmachine and watiss authored Aug 19, 2022
1 parent 7b5ba60 commit 5ea15db
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions scvi/utils/_docstrings.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,17 @@ class SetupAnnDataDocstringProcessor(DocstringProcessor):

param_cat_cov_keys = """\
categorical_covariate_keys
keys in `adata.obs` that correspond to categorical data."""
keys in `adata.obs` that correspond to categorical data.
These covariates can be added in addition to the batch covariate and are also treated as nuisance factors
(i.e., the model tries to minimize their effects on the latent space). Thus, these should not be used for
biologically-relevant factors that you do _not_ want to correct for."""

param_cont_cov_keys = """\
continuous_covariate_keys
keys in `adata.obs` that correspond to continuous data."""
keys in `adata.obs` that correspond to continuous data.
These covariates can be added in addition to the batch covariate and are also treated as nuisance factors
(i.e., the model tries to minimize their effects on the latent space). Thus, these should not be used for
biologically-relevant factors that you do _not_ want to correct for."""

param_copy = """\
copy
Expand Down

0 comments on commit 5ea15db

Please sign in to comment.