From 5ea15db1cb5370a80acbda8baf5109ea17d3633a Mon Sep 17 00:00:00 2001 From: MeeseeksMachine <39504233+meeseeksmachine@users.noreply.github.com> Date: Fri, 19 Aug 2022 10:48:04 +0200 Subject: [PATCH] Backport PR #1637: Update doctrings for continuous and categorical covariate docstrings (#1642) Co-authored-by: Valeh Valiollah Pour Amiri <4193454+watiss@users.noreply.github.com> --- scvi/utils/_docstrings.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/scvi/utils/_docstrings.py b/scvi/utils/_docstrings.py index f00730662b..1f4512b8c1 100644 --- a/scvi/utils/_docstrings.py +++ b/scvi/utils/_docstrings.py @@ -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