Backport PR #2189: Add docstring for scanvi unlabeled category (#2190)

Co-authored-by: Martin Kim <[email protected]>

docs/release_notes/index.md

@@ -27,6 +27,8 @@ is available in the [commit logs](https://github.com/YosefLab/scvi-tools/commits
 
 -   Fix bug in {class}`scvi.model.base.PyroSviTrainMixin` where `training_plan`
     argument is ignored {pr}`2162`.
+-   Fix missing docstring for `unlabeled_category` in
+    {class}`scvi.model.SCANVI.setup_anndata` and reorder arguments {pr}`2189`.
 
 ### 1.0.2 (2023-07-05)
 

scvi/model/_scanvi.py

@@ -457,9 +457,10 @@ def setup_anndata(
         Parameters
         ----------
         %(param_adata)s
+        %(param_labels_key)s
+        %(param_unlabeled_category)s
         %(param_layer)s
         %(param_batch_key)s
-        %(param_labels_key)s
         %(param_size_factor_key)s
         %(param_cat_cov_keys)s
         %(param_cont_cov_keys)s

scvi/utils/_docstrings.py

@@ -145,6 +145,10 @@
     (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_unlabeled_category = """\
+unlabeled_category
+    value in `adata.obs[labels_key]` that indicates unlabeled observations."""
+
 param_modalities = """\
 modalities
     Dictionary mapping parameters to modalities."""
@@ -175,6 +179,7 @@
     param_cat_cov_keys=param_cat_cov_keys,
     param_cont_cov_keys=param_cont_cov_keys,
     param_size_factor_key=param_size_factor_key,
+    param_unlabeled_category=param_unlabeled_category,
     param_modalities=param_modalities,
     param_copy=param_copy,
     returns=returns,