Add experimental tags

scverse · Aug 16, 2023 · efecee7 · efecee7
1 parent f2ab131
commit efecee7
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/scvi/model/base/_vaemixin.py b/scvi/model/base/_vaemixin.py
@@ -149,7 +149,7 @@ def get_latent_representation(
         batch_size: int | None = None,
         return_dist: bool = False,
     ) -> np.ndarray | tuple[np.ndarray, np.ndarray]:
-        """Return the latent representation for each cell.
+        """``EXPERIMENTAL`` Return the latent representation for each cell.
 
         This is typically denoted as :math:`z_n`.
 

diff --git a/scvi/module/_vae.py b/scvi/module/_vae.py
@@ -71,11 +71,11 @@ class VAE(BaseMinifiedModeModuleClass):
         Whether to concatenate covariates into output of hidden layers in encoder/decoder. This option
         only applies when `n_layers` > 1. The covariates are concatenated to the input of subsequent hidden layers.
     use_batch_embedding
-        If ``True``, encodes batch indexes using an embedding layer. Otherwise,
-        uses one-hot encodings.
+        ``EXPERIMENTAL`` If ``True``, encodes batch indexes using an embedding
+        layer. Otherwise, uses one-hot encodings.
     batch_embedding_dim
-        If ``use_batch_embedding`` is ``True``, specifies the dimensionality of
-        the batch embedding layer.
+        ``EXPERIMENTAL`` If ``use_batch_embedding`` is ``True``, specifies the
+        dimensionality of the batch embedding layer.
     use_batch_norm
         Whether to use batch norm in layers.
     use_layer_norm