scvi.external.VELOVI#
- class scvi.external.VELOVI(adata, n_hidden=256, n_latent=10, n_layers=1, dropout_rate=0.1, gamma_init_data=False, linear_decoder=False, **model_kwargs)[source]#
Velocity Variational Inference [Gayoso et al., 2023].
- Parameters:
- adata
AnnData AnnData object that has been registered via
setup_anndata().- n_hidden
int(default:256) Number of nodes per hidden layer.
- n_latent
int(default:10) Dimensionality of the latent space.
- n_layers
int(default:1) Number of hidden layers used for encoder and decoder NNs.
- dropout_rate
float(default:0.1) Dropout rate for neural networks.
- gamma_init_data
bool(default:False) Initialize gamma using the data-driven technique.
- linear_decoder
bool(default:False) Use a linear decoder from latent space to time.
- **model_kwargs
Keyword args for
VELOVAE
- adata
Attributes table#
Data attached to model instance. |
|
Manager instance associated with self.adata. |
|
The current device that the module's params are on. |
|
What the get normalized functions name is |
|
Returns computed metrics during training. |
|
Whether the model has been trained. |
|
Data attached to model instance. |
|
Returns the run id of the model. |
|
Returns the run name of the model. |
|
Summary string of the model. |
|
Observations that are in test set. |
|
Observations that are in train set. |
|
Observations that are in validation set. |
Methods table#
|
Converts a legacy saved model (<v0.15.0) to the updated save format. |
|
Returns the object in AnnData associated with the key in the data registry. |
|
Deregisters the |
|
Compute the differential abundance between samples. |
|
Compute the aggregated posterior over the |
|
Retrieves the |
|
Compute directional uncertainty of RNA velocity. |
|
Compute the evidence lower bound (ELBO) on the data. |
|
Returns the fitted spliced and unspliced abundance (s(t) and u(t)). |
|
Returns the object in AnnData associated with the key in the data registry. |
|
Returns the likelihood per gene. |
|
Compute the latent representation of the data. |
|
Returns the cells by genes latent time. |
|
Compute the marginal log-likehood of the data. |
|
Not implemented for this model class. |
|
Compute permutation scores. |
Return the learned splicing, degradation, and transcription rates. |
|
|
Compute the reconstruction error on the data. |
|
Returns the string provided to setup of a specific setup_arg. |
|
Returns cells by genes by states probabilities. |
|
Returns the state registry for the AnnDataField registered with this instance. |
|
Variable names of input data. |
|
Returns cells by genes velocity estimates. |
|
Instantiate a model from the saved output. |
|
Return the full registry saved with the model. |
|
Registers an |
|
Save the state of the model. |
|
Set up a model from on-disk AnnData files via the annbatch streaming loader. |
|
Sets up the |
|
Move the model to the device. |
|
Train the model. |
|
Transfer fields from a model to an AnnData object. |
|
Update setup method args. |
|
Print summary of the setup for the initial AnnData or a given AnnData object. |
|
Prints summary of the registry. |
|
Print args used to setup a saved model. |
Prints setup kwargs used to produce a given registry. |
Attributes#
- VELOVI.adata#
Data attached to model instance.
- VELOVI.adata_manager#
Manager instance associated with self.adata.
- VELOVI.device#
The current device that the module’s params are on.
- VELOVI.get_normalized_function_name#
What the get normalized functions name is
- VELOVI.history#
Returns computed metrics during training.
- VELOVI.is_trained#
Whether the model has been trained.
- VELOVI.registry#
Data attached to model instance.
- VELOVI.run_id#
Returns the run id of the model. Used in MLFlow
- VELOVI.run_name#
Returns the run name of the model. Used in MLFlow
- VELOVI.summary_string#
Summary string of the model.
- VELOVI.test_indices#
Observations that are in test set.
- VELOVI.train_indices#
Observations that are in train set.
- VELOVI.validation_indices#
Observations that are in validation set.
Methods#
- classmethod VELOVI.convert_legacy_save(dir_path, output_dir_path, overwrite=False, prefix=None, **save_kwargs)[source]#
Converts a legacy saved model (<v0.15.0) to the updated save format.
- Parameters:
- dir_path
str Path to the directory where the legacy model is saved.
- output_dir_path
str Path to save converted save files.
- overwrite
bool(default:False) Overwrite existing data or not. If
Falseand directory already exists atoutput_dir_path, an error will be raised.- prefix
str|None(default:None) Prefix of saved file names.
- **save_kwargs
Keyword arguments passed into
save().
- dir_path
- Return type:
- VELOVI.data_registry(registry_key)[source]#
Returns the object in AnnData associated with the key in the data registry.
- VELOVI.deregister_manager(adata=None)[source]#
Deregisters the
AnnDataManagerinstance associated withadata.If
adataisNone, deregisters allAnnDataManagerinstances in both the class and instance-specific manager stores, except for the one associated with this model instance.
- VELOVI.differential_abundance(adata=None, adata_sub=None, sample_key=None, batch_size=128, num_cells_posterior=None, dof=None, dataloader=None)[source]#
Compute the differential abundance between samples.
Computes the log probabilities of each sample conditioned on the estimated aggregate posterior distribution of each cell.
- Parameters:
- adata
AnnData|MuData|None(default:None) The full data object used to compute each aggregated posterior. Defaults to the AnnData object used to initialize the model.
- adata_sub
AnnData|MuData|None(default:None) The data object to compute the differential abundance for. For very large datasets, this should be used to pass in a subset of the full data object. The aggregated posteriors are still computed from the full data object. The resulting log_probs matrix is stored in adata_sub.obsm
- sample_key
str|None(default:None) Key for the sample covariate.
- batch_size
int(default:128) Minibatch size for computing the differential abundance.
- num_cells_posterior
int|None(default:None) Maximum number of cells used to compute aggregated posterior for each sample.
- dof
float|None(default:None) Degrees of freedom for the Student’s t-distribution components for aggregated posterior. If
None, components are Normal.- dataloader
Iterator[dict[str, torch.Tensor |None]] |None(default:None) Inference dataloader to materialize when the model was initialized without AnnData.
- adata
- VELOVI.get_aggregated_posterior(adata=None, indices=None, batch_size=None, dof=3.0)[source]#
Compute the aggregated posterior over the
ulatent representations.- Parameters:
- adata
AnnData|MuData|None(default:None) AnnData object to use. Defaults to the AnnData object used to initialize the model.
- indices
Sequence[int] |None(default:None) Indices of cells to use.
- batch_size
int|None(default:None) Batch size to use for computing the latent representation.
- dof
float|None(default:3.0) Degrees of freedom for the Student’s t-distribution components. If
None, components are Normal.
- adata
- Return type:
- Returns:
A mixture distribution of the aggregated posterior.
- VELOVI.get_anndata_manager(adata, required=False)[source]#
Retrieves the
AnnDataManagerfor a given AnnData object.Requires
self.idhas been set. Checks for anAnnDataManagerspecific to this model instance.- Parameters:
- Return type:
- VELOVI.get_directional_uncertainty(adata=None, n_samples=50, gene_list=None, n_jobs=-1)[source]#
Compute directional uncertainty of RNA velocity.
Estimates the uncertainty of the velocity vector direction for each cell by sampling from the posterior and computing pairwise cosine similarities.
- Parameters:
- adata anndata.AnnData |
None(default:None) AnnData object. If
None, uses the AnnData passed during model initialization.- n_samples
int(default:50) Number of posterior samples for estimating uncertainty.
- gene_list
Iterable[str] (default:None) List of genes to use. If
None, uses all genes.- n_jobs
int(default:-1) Number of parallel jobs for cosine similarity computation.
-1uses all available cores.
- adata anndata.AnnData |
- Returns:
Tuple of (DataFrame of directional statistics per cell, cosine similarity matrix).
- VELOVI.get_elbo(adata=None, indices=None, batch_size=None, dataloader=None, return_mean=True, data_loader_kwargs=None, **kwargs)[source]#
Compute the evidence lower bound (ELBO) on the data.
The ELBO is the reconstruction error plus the Kullback-Leibler (KL) divergences between the variational distributions and the priors. It is different from the marginal log-likelihood; specifically, it is a lower bound on the marginal log-likelihood plus a term that is constant with respect to the variational distribution. It still gives good insights on the modeling of the data and is fast to compute.
- Parameters:
- adata anndata.AnnData |
None(default:None) AnnDataobject withvar_namesin the same order as the ones used to train the model. IfNoneanddataloaderis alsoNone, it defaults to the object used to initialize the model.- indices
Sequence[int] |None(default:None) Indices of observations in
adatato use. IfNone, defaults to all observations. Ignored ifdataloaderis notNone.- batch_size
int|None(default:None) Minibatch size for the forward pass. If
None, defaults toscvi.settings.batch_size. Ignored ifdataloaderis notNone.- dataloader
Iterator[dict[str, torch.Tensor |None]] |None(default:None) An iterator over minibatches of data on which to compute the metric. The minibatches should be formatted as a dictionary of
Tensorwith keys as expected by the model. IfNone, a dataloader is created fromadata.- return_mean
bool(default:True) Whether to return the mean of the ELBO or the ELBO for each observation.
- data_loader_kwargs
dict|None(default:None) Keyword args for data loader, in dict form.
- **kwargs
Additional keyword arguments to pass into the forward method of the module.
- adata anndata.AnnData |
- Return type:
- Returns:
Evidence lower bound (ELBO) of the data.
Notes
This is not the negative ELBO, so higher is better.
- VELOVI.get_expression_fit(adata=None, indices=None, gene_list=None, n_samples=1, batch_size=None, return_mean=True, return_numpy=None, restrict_to_latent_dim=None)[source]#
Returns the fitted spliced and unspliced abundance (s(t) and u(t)).
- Parameters:
- adata anndata.AnnData |
None(default:None) AnnData object with equivalent structure to initial AnnData. If
None, defaults to the AnnData object used to initialize the model.- indices
Sequence[int] |None(default:None) Indices of cells in adata to use. If
None, all cells are used.- gene_list
Sequence[str] |None(default:None) Return frequencies of expression for a subset of genes. This can save memory when working with large datasets, and few genes are of interest.
- n_samples
int(default:1) Number of posterior samples to use for estimation.
- batch_size
int|None(default:None) Minibatch size for data loading into the model. Defaults to
scvi.settings.batch_size.- return_mean
bool(default:True) Whether to return the mean of the samples.
- return_numpy
bool|None(default:None) Return a
ndarrayinstead of aDataFrame. DataFrame includes gene names as columns. If eithern_samples=1orreturn_mean=True, defaults toFalse. Otherwise, it defaults toTrue.
- adata anndata.AnnData |
- Return type:
- Returns:
If
n_samples> 1 andreturn_meanisFalse, then the shape is(samples, cells, genes). Otherwise, the shape is(cells, genes). In this case, the return type isDataFrameunlessreturn_numpyisTrue.
- VELOVI.get_from_registry(adata, registry_key)[source]#
Returns the object in AnnData associated with the key in the data registry.
AnnData object should be registered with the model prior to calling this function via the
self._validate_anndatamethod.
- VELOVI.get_gene_likelihood(adata=None, indices=None, gene_list=None, n_samples=1, batch_size=None, return_mean=True, return_numpy=None)[source]#
Returns the likelihood per gene. Higher is better.
This is denoted as \(\rho_n\) in the scVI paper.
- Parameters:
- adata anndata.AnnData |
None(default:None) AnnData object with equivalent structure to initial AnnData. If
None, defaults to the AnnData object used to initialize the model.- indices
Sequence[int] |None(default:None) Indices of cells in adata to use. If
None, all cells are used.- transform_batch
Batch to condition on. One of the following:
None: the real observed batch is used.int: batch transform_batch is used.
- gene_list
Sequence[str] |None(default:None) Return frequencies of expression for a subset of genes. This can save memory when working with large datasets, and few genes are of interest.
- library_size
Scale the expression frequencies to a common library size. This allows gene expression levels to be interpreted on a common scale of relevant magnitude. If set to
"latent", use the latent library size.- n_samples
int(default:1) Number of posterior samples to use for estimation.
- batch_size
int|None(default:None) Minibatch size for data loading into the model. Defaults to
scvi.settings.batch_size.- return_mean
bool(default:True) Whether to return the mean of the samples.
- return_numpy
bool|None(default:None) Return a
ndarrayinstead of aDataFrame. DataFrame includes gene names as columns. If eithern_samples=1orreturn_mean=True, defaults toFalse. Otherwise, it defaults toTrue.
- adata anndata.AnnData |
- Return type:
- Returns:
If
n_samples> 1 andreturn_meanisFalse, then the shape is(samples, cells, genes). Otherwise, the shape is(cells, genes). In this case, the return type isDataFrameunlessreturn_numpyisTrue.
- VELOVI.get_latent_representation(adata=None, indices=None, give_mean=True, mc_samples=5000, batch_size=None, return_dist=False, dataloader=None, **data_loader_kwargs)[source]#
Compute the latent representation of the data.
This is typically denoted as \(z_n\).
- Parameters:
- adata anndata.AnnData |
None(default:None) AnnDataobject withvar_namesin the same order as the ones used to train the model. IfNoneanddataloaderis alsoNone, it defaults to the object used to initialize the model.- indices
Sequence[int] |None(default:None) Indices of observations in
adatato use. IfNone, defaults to all observations. Ignored ifdataloaderis notNone- give_mean
bool(default:True) If
True, returns the mean of the latent distribution. IfFalse, returns an estimate of the mean usingmc_samplesMonte Carlo samples.- mc_samples
int(default:5000) Number of Monte Carlo samples to use for the estimator for distributions with no closed-form mean (e.g., the logistic normal distribution). Not used if
give_meanisTrueor ifreturn_distisTrue.- batch_size
int|None(default:None) Minibatch size for the forward pass. If
None, defaults toscvi.settings.batch_size. Ignored ifdataloaderis notNone- return_dist
bool(default:False) If
True, returns the mean and variance of the latent distribution. Otherwise, returns the mean of the latent distribution.- dataloader
Iterator[dict[str, torch.Tensor |None]] (default:None) An iterator over minibatches of data on which to compute the metric. The minibatches should be formatted as a dictionary of
Tensorwith keys as expected by the model. IfNone, a dataloader is created fromadata.- **data_loader_kwargs
Keyword args for data loader.
- adata anndata.AnnData |
- Return type:
- Returns:
An array of shape
(n_obs, n_latent)ifreturn_distisFalse. Otherwise, returns a tuple of arrays(n_obs, n_latent)with the mean and variance of the latent distribution.
- VELOVI.get_latent_time(adata=None, indices=None, gene_list=None, time_statistic='mean', n_samples=1, n_samples_overall=None, batch_size=None, return_mean=True, return_numpy=None)[source]#
Returns the cells by genes latent time.
- Parameters:
- adata anndata.AnnData |
None(default:None) AnnData object with equivalent structure to initial AnnData. If
None, defaults to the AnnData object used to initialize the model.- indices
Sequence[int] |None(default:None) Indices of cells in adata to use. If
None, all cells are used.- gene_list
Sequence[str] |None(default:None) Return frequencies of expression for a subset of genes. This can save memory when working with large datasets, and few genes are of interest.
- time_statistic
Literal['mean','max'] (default:'mean') Whether to compute expected time over states or maximum a posteriori time over maximal probability state.
- n_samples
int(default:1) Number of posterior samples to use for estimation.
- n_samples_overall
int|None(default:None) Number of overall samples to return. Setting this forces n_samples=1.
- batch_size
int|None(default:None) Minibatch size for data loading into model. Defaults to
scvi.settings.batch_size.- return_mean
bool(default:True) Whether to return the mean of the samples.
- return_numpy
bool|None(default:None) Return a
ndarrayinstead of aDataFrame. DataFrame includes gene names as columns. If eithern_samples=1orreturn_mean=True, defaults toFalse. Otherwise, it defaults toTrue.
- adata anndata.AnnData |
- Return type:
- Returns:
If
n_samples> 1 andreturn_meanisFalse, then the shape is(samples, cells, genes). Otherwise, the shape is(cells, genes). In this case, the return type isDataFrameunlessreturn_numpyisTrue.
- VELOVI.get_marginal_ll(adata=None, indices=None, n_mc_samples=1000, batch_size=None, return_mean=True, dataloader=None, data_loader_kwargs=None, **kwargs)[source]#
Compute the marginal log-likehood of the data.
The computation here is a biased estimator of the marginal log-likelihood of the data.
- Parameters:
- adata anndata.AnnData |
None(default:None) AnnDataobject withvar_namesin the same order as the ones used to train the model. IfNoneanddataloaderis alsoNone, it defaults to the object used to initialize the model.- indices
Sequence[int] |None(default:None) Indices of observations in
adatato use. IfNone, defaults to all observations. Ignored ifdataloaderis notNone.- n_mc_samples
int(default:1000) Number of Monte Carlo samples to use for the estimator. Passed into the module’s
marginal_llmethod.- batch_size
int|None(default:None) Minibatch size for the forward pass. If
None, defaults toscvi.settings.batch_size. Ignored ifdataloaderis notNone.- return_mean
bool(default:True) Whether to return the mean of the marginal log-likelihood or the marginal-log likelihood for each observation.
- dataloader
Iterator[dict[str, torch.Tensor |None]] (default:None) An iterator over minibatches of data on which to compute the metric. The minibatches should be formatted as a dictionary of
Tensorwith keys as expected by the model. IfNone, a dataloader is created fromadata.- data_loader_kwargs
dict|None(default:None) Keyword args for data loader, in dict form.
- **kwargs
Additional keyword arguments to pass into the module’s
marginal_llmethod.
- adata anndata.AnnData |
- Return type:
float| torch.Tensor- Returns:
If
True, returns the mean marginal log-likelihood. Otherwise returns a tensor of shape(n_obs,)with the marginal log-likelihood for each observation.
Notes
This is not the negative log-likelihood, so higher is better.
- VELOVI.get_normalized_expression(*args, **kwargs)[source]#
Not implemented for this model class.
Available in RNA models that inherit from
RNASeqMixin.- Raises:
- VELOVI.get_permutation_scores(labels_key, adata=None)[source]#
Compute permutation scores.
- Parameters:
- Return type:
- Returns:
Tuple of DataFrame and AnnData. DataFrame is genes by cell types with the score per cell type. AnnData is the permutated version of the original AnnData.
- VELOVI.get_rates()[source]#
Return the learned splicing, degradation, and transcription rates.
- Returns:
dict with keys
"beta"(splicing),"gamma"(degradation),"alpha"(transcription on-state),"alpha_1"(transcription off-state), and"lambda_alpha"(switching rate), each as a numpy array of shape(n_genes,).
- VELOVI.get_reconstruction_error(adata=None, indices=None, batch_size=None, dataloader=None, return_mean=True, data_loader_kwargs=None, **kwargs)[source]#
Compute the reconstruction error on the data.
The reconstruction error is the negative log likelihood of the data given the latent variables. It is different from the marginal log-likelihood, but still gives good insights on the modeling of the data and is fast to compute. This is typically written as \(p(x \mid z)\), the likelihood term given one posterior sample.
- Parameters:
- adata anndata.AnnData |
None(default:None) AnnDataobject withvar_namesin the same order as the ones used to train the model. IfNoneanddataloaderis alsoNone, it defaults to the object used to initialize the model.- indices
Sequence[int] |None(default:None) Indices of observations in
adatato use. IfNone, defaults to all observations. Ignored ifdataloaderis notNone- batch_size
int|None(default:None) Minibatch size for the forward pass. If
None, defaults toscvi.settings.batch_size. Ignored ifdataloaderis notNone- dataloader
Iterator[dict[str, torch.Tensor |None]] |None(default:None) An iterator over minibatches of data on which to compute the metric. The minibatches should be formatted as a dictionary of
Tensorwith keys as expected by the model. IfNone, a dataloader is created fromadata.- return_mean
bool(default:True) Whether to return the mean reconstruction loss or the reconstruction loss for each observation.
- data_loader_kwargs
dict|None(default:None) Keyword args for data loader, in dict form.
- **kwargs
Additional keyword arguments to pass into the forward method of the module.
- adata anndata.AnnData |
- Return type:
- Returns:
Reconstruction error for the data.
Notes
This is not the negative reconstruction error, so higher is better.
- VELOVI.get_setup_arg(setup_arg)[source]#
Returns the string provided to setup of a specific setup_arg.
- Return type:
- VELOVI.get_state_assignment(adata=None, indices=None, gene_list=None, hard_assignment=False, n_samples=20, batch_size=None, return_mean=True, return_numpy=None)[source]#
Returns cells by genes by states probabilities.
- Parameters:
- adata anndata.AnnData |
None(default:None) AnnData object with equivalent structure to initial AnnData. If
None, defaults to the AnnData object used to initialize the model.- indices
Sequence[int] |None(default:None) Indices of cells in adata to use. If
None, all cells are used.- gene_list
Sequence[int] |None(default:None) Return frequencies of expression for a subset of genes. This can save memory when working with large datasets, and few genes are of interest.
- hard_assignment
bool(default:False) Return a hard state assignment
- n_samples
int(default:20) Number of posterior samples to use for estimation.
- batch_size
int|None(default:None) Minibatch size for data loading into the model. Defaults to
scvi.settings.batch_size.- return_mean
bool(default:True) Whether to return the mean of the samples.
- return_numpy
bool|None(default:None) Return a
ndarrayinstead of aDataFrame. DataFrame includes gene names as columns. If eithern_samples=1orreturn_mean=True, defaults toFalse. Otherwise, it defaults toTrue.
- adata anndata.AnnData |
- Return type:
- Returns:
If
n_samples> 1 andreturn_meanisFalse, then the shape is(samples, cells, genes). Otherwise, the shape is(cells, genes). In this case, the return type isDataFrameunlessreturn_numpyisTrue.
- VELOVI.get_state_registry(registry_key)[source]#
Returns the state registry for the AnnDataField registered with this instance.
- Return type:
- VELOVI.get_var_names(legacy_mudata_format=False)[source]#
Variable names of input data.
- Return type:
- VELOVI.get_velocity(adata=None, indices=None, gene_list=None, n_samples=1, n_samples_overall=None, batch_size=None, return_mean=True, return_numpy=None, velo_statistic='mean', velo_mode='spliced', clip=True)[source]#
Returns cells by genes velocity estimates.
- Parameters:
- adata anndata.AnnData |
None(default:None) AnnData object with equivalent structure to initial AnnData. If
None, defaults to the AnnData object used to initialize the model.- indices
Sequence[int] |None(default:None) Indices of cells in adata to use. If
None, all cells are used.- gene_list
Sequence[str] |None(default:None) Return velocities for a subset of genes. This can save memory when working with large datasets, and few genes are of interest.
- n_samples
int(default:1) Number of posterior samples to use for estimation for each cell.
- n_samples_overall
int|None(default:None) Number of overall samples to return. Setting this forces
n_samples=1.- batch_size
int|None(default:None) Minibatch size for data loading into the model. Defaults to
scvi.settings.batch_size.- return_mean
bool(default:True) Whether to return the mean of the samples.
- return_numpy
bool|None(default:None) Return a
ndarrayinstead of aDataFrame. DataFrame includes gene names as columns. If eithern_samples=1orreturn_mean=True, defaults toFalse. Otherwise, it defaults toTrue.- velo_statistic
str(default:'mean') Whether to compute expected velocity over the states or maximum a posteriori velocity over maximal probability state.
- velo_mode
Literal['spliced','unspliced'] (default:'spliced') Compute ds/dt or du/dt.
- clip
bool(default:True) Clip to minus spliced value
- adata anndata.AnnData |
- Return type:
- Returns:
If
n_samples> 1 andreturn_meanisFalse, then the shape is(samples, cells, genes). Otherwise, the shape is(cells, genes). In this case, the return type isDataFrameunlessreturn_numpyisTrue.
- classmethod VELOVI.load(dir_path, adata=None, accelerator='auto', device='auto', prefix=None, backup_url=None, datamodule=None, allowed_classes_names_list=None)[source]#
Instantiate a model from the saved output.
- Parameters:
- dir_path
str Path to saved outputs.
- adata
AnnData|MuData|None(default:None) AnnData organized in the same way as data used to train model. It is not necessary to run setup_anndata, as AnnData is validated against the saved
scvisetup dictionary. If None, will check for and load anndata saved with the model. If False, will load the model without AnnData.- accelerator
str(default:'auto') Supports passing different accelerator types
("cpu", "gpu", "tpu", "ipu", "hpu", "mps, "auto")as well as custom accelerator instances.- device
int|str(default:'auto') The device to use. Can be set to a non-negative index (
intorstr) or"auto"for automatic selection based on the chosen accelerator. If set to"auto"andacceleratoris not determined to be"cpu", thendevicewill be set to the first available device.- prefix
str|None(default:None) Prefix of saved file names.
- backup_url
str|None(default:None) URL to retrieve saved outputs from if not present on disk.
- datamodule
LightningDataModule|None(default:None) EXPERIMENTALALightningDataModuleinstance to use for training in place of the defaultDataSplitter. Can only be passed in if the model was not initialized withAnnData.- allowed_classes_names_list
list[str] |None(default:None) list of allowed classes names to be loaded (besides the original class name)
- dir_path
- Returns:
Model with loaded state dictionaries.
Examples
>>> model = ModelClass.load(save_path, adata) >>> model.get_....
- static VELOVI.load_registry(dir_path, prefix=None)[source]#
Return the full registry saved with the model.
- classmethod VELOVI.register_manager(adata_manager)[source]#
Registers an
AnnDataManagerinstance with this model class.Stores the
AnnDataManagerreference in a class-specific manager store. Intended for use in thesetup_anndata()class method followed up by retrieval of theAnnDataManagervia the_get_most_recent_anndata_manager()method in the model init method.Notes
Subsequent calls to this method with an
AnnDataManagerinstance referring to the same underlying AnnData object will overwrite the reference to previousAnnDataManager.
- VELOVI.save(dir_path, prefix=None, overwrite=False, save_anndata=False, save_kwargs=None, legacy_mudata_format=False, datamodule=None, **anndata_write_kwargs)[source]#
Save the state of the model.
Neither the trainer optimizer state nor the trainer history are saved. Model files are not expected to be reproducibly saved and loaded across versions until we reach version 1.0.
- Parameters:
- dir_path
str Path to a directory.
- prefix
str|None(default:None) Prefix to prepend to saved file names.
- overwrite
bool(default:False) Overwrite existing data or not. If
Falseand directory already exists atdir_path, an error will be raised.- save_anndata
bool(default:False) If True, also saves the anndata
- save_kwargs
dict|None(default:None) Keyword arguments passed into
save().- legacy_mudata_format
bool(default:False) If
True, saves the modelvar_namesin the legacy format if the model was trained with aMuDataobject. The legacy format is a flat array with variable names across all modalities concatenated, while the new format is a dictionary with keys corresponding to the modality names and values corresponding to the variable names for each modality.- datamodule
LightningDataModule|None(default:None) EXPERIMENTALALightningDataModuleinstance to use for training in place of the defaultDataSplitter. Can only be passed in if the model was not initialized withAnnData.- anndata_write_kwargs
Kwargs for
write()
- dir_path
- classmethod VELOVI.setup_annbatch(collection_path=None, paths=None, batch_key=None, labels_key=None, sample_key=None, unlabeled_category='Unknown', layer=None, categorical_covariate_keys=None, continuous_covariate_keys=None, rebuild=True, batch_size=4096, chunk_size=256, preload_nchunks=32, preload_to_gpu=True, dataset_size='20GB', shuffle=False, var_subset=None, merge=None, adatas=None, use_class_sampler=False, class_sampler_key=None, class_weights=None)[source]#
Set up a model from on-disk AnnData files via the annbatch streaming loader.
Builds (or reuses) a zarr-backed
DatasetCollectionfrom the supplied h5ad file paths, then wraps it in aAnnbatchDataModuleready for training.- Parameters:
- collection_path
str|None(default:None) Directory where the zarr collection is written (or already exists). If
None(default), a path is auto-generated as"./{ModelName}_annbatch.zarr"in the current working directory.- paths
list[str] |None(default:None) Paths to h5ad files that make up the training dataset. If
None, an existing collection atcollection_pathis opened without rebuilding — useful when the zarr store was created by a previous call. Must be provided when the store does not exist yet.- batch_key
str|None(default:None) Column in
obsto use as the batch variable.- labels_key
str|None(default:None) Column in
obsto use as the cell-type / label variable.- sample_key
str|None(default:None) Column in
obsto use as the sample variable. Used by models like MrVI.- unlabeled_category
str(default:'Unknown') Value used to mark unlabeled cells in
labels_key. Required by semi-supervised models such as SCANVI. Defaults to"Unknown".- layer
str|None(default:None) Layer in the h5ad files to use as the count matrix.
Noneusesadata.X(falling back toadata.raw.Xwhen a raw slot exists).- categorical_covariate_keys
list[str] |None(default:None) Additional categorical covariate columns in
obs.- continuous_covariate_keys
list[str] |None(default:None) Additional continuous covariate columns in
obs.- rebuild
bool(default:True) If
True, always rebuild the zarr collection even if it already exists on disk. IfFalse(default), reuse an existing collection and skip the (potentially expensive)add_adatasstep.- batch_size
int(default:4096) Number of cells per batch yielded by the
Loader.- chunk_size
int(default:256) Number of cells loaded from disk contiguously per read.
- preload_nchunks
int(default:32) Number of chunks to preload and shuffle in memory.
- preload_to_gpu
bool(default:True) Whether the loader should move data to GPU before yielding.
- dataset_size
int|str(default:'20GB') Number of observations to load into memory for shuffling / pre-processing when building the collection, or annbatch’s human-readable size strings, e.g.
"20GB".- shuffle
bool(default:False) Whether to pre-shuffle cells when building the collection.
- var_subset
list[str] |None(default:None) Optional list of gene names to restrict the collection to (passed as
var_subsettoadd_adatas).- merge
Literal['same','unique','first','only'] |None(default:None) How annbatch should merge
varmetadata across inputs. Passed through toannbatch.DatasetCollection.add_adatas().
- collection_path
- Returns:
AnnbatchDataModuleA configured datamodule whoseregistrycan be passed directly to the model constructor, e.g.model = SCVI(registry=dm.registry).
Notes
After training, saving and reloading the model requires reconstructing the datamodule manually and passing it to
load()via thedatamoduleargument — the same pattern used by all custom datamodules.
- classmethod VELOVI.setup_anndata(adata, spliced_layer, unspliced_layer, **kwargs)[source]#
Sets up the
AnnDataobject for this model.A mapping will be created between data fields used by this model to their respective locations in adata. None of the data in adata are modified. Only adds fields to adata.
- Parameters:
- Return type:
anndata.AnnData |
None- Returns:
None. Adds the following fields:
- .uns[‘_scvi’]
scvisetup dictionary- .obs[‘_scvi_labels’]
labels encoded as integers
- .obs[‘_scvi_batch’]
batch encoded as integers
- VELOVI.to_device(device)[source]#
Move the model to the device.
- Parameters:
Examples
>>> adata = scvi.data.synthetic_iid() >>> model = scvi.model.SCVI(adata) >>> model.to_device("cpu") # moves model to CPU >>> model.to_device("cuda:0") # moves model to GPU 0 >>> model.to_device(0) # also moves model to GPU 0
- VELOVI.train(max_epochs=500, lr=0.01, weight_decay=0.01, accelerator='auto', devices='auto', train_size=None, validation_size=None, batch_size=256, early_stopping=True, gradient_clip_val=10, plan_kwargs=None, external_indexing=None, **trainer_kwargs)[source]#
Train the model.
- Parameters:
- max_epochs
int|None(default:500) Number of passes through the dataset. If
None, defaults tonp.min([round((20000 / n_cells) * 400), 400])- lr
float(default:0.01) Learning rate for optimization.
- weight_decay
float(default:0.01) Weight decay for optimization.
- accelerator
str(default:'auto') Supports passing different accelerator types
("cpu", "gpu", "tpu", "ipu", "hpu", "mps, "auto")as well as custom accelerator instances.- devices
int|list[int] |str(default:'auto') The devices to use. Can be set to a non-negative index (
intorstr), a sequence of device indices (listor comma-separatedstr), the value-1to indicate all available devices, or"auto"for automatic selection based on the chosenaccelerator. If set to"auto"andacceleratoris not determined to be"cpu", thendeviceswill be set to the first available device.- train_size
float|None(default:None) Size of the training set in the range
[0.0, 1.0].- validation_size
float|None(default:None) Size of the test set. If
None, defaults to1 - train_size. Iftrain_size + validation_size < 1, the remaining cells belong to a test set.- batch_size
int(default:256) Minibatch size to use during training.
- early_stopping
bool(default:True) Perform early stopping. Additional arguments can be passed in
**kwargs. SeeTrainerfor further options.- gradient_clip_val
float(default:10) Value for gradient clipping.
- plan_kwargs
dict|None(default:None) Keyword args for
TrainingPlan. Keyword arguments passed to this method will overwrite values present inplan_kwargs, when appropriate.- external_indexing
list[ndarray] (default:None) A list of data split indices in the order of training, validation, and test sets. Validation and test set are not required and can be left empty.
- **trainer_kwargs
Other keyword args for
Trainer.
- max_epochs
- VELOVI.transfer_fields(adata, **kwargs)[source]#
Transfer fields from a model to an AnnData object.
- Return type:
- VELOVI.update_setup_method_args(setup_method_args)[source]#
Update setup method args.
- Parameters:
- setup_method_args
dict This is a bit of a misnomer, this is a dict representing kwargs of the setup method that will be used to update the existing values in the registry of this instance.
- setup_method_args
- VELOVI.view_anndata_setup(adata=None, hide_state_registries=False)[source]#
Print summary of the setup for the initial AnnData or a given AnnData object.