scviva.model.GIMVI#
- class scviva.model.GIMVI(adata_seq, adata_spatial, generative_distributions=None, model_library_size=None, n_latent=10, **model_kwargs)[source]#
Joint VAE for imputing missing genes in spatial data [Lopez et al., 2019].
Learns a joint latent space for paired scRNA-seq and spatial transcriptomics data, enabling imputation of spatially unmeasured genes.
- Parameters:
- adata_seq
AnnData AnnData object registered via
setup_anndata()containing scRNA-seq data.- adata_spatial
AnnData AnnData object registered via
setup_anndata()containing spatial transcriptomics data.- generative_distributions
list[str] |None List of generative distributions for seq and spatial data. Defaults to
['zinb', 'nb'].- model_library_size
list[bool] |None Whether to model library size per dataset. Defaults to
[True, False].- n_latent
int Dimensionality of the latent space.
- **model_kwargs
Keyword args for
JVAE.
- adata_seq
Examples
>>> adata_seq = anndata.read_h5ad(path_to_seq) >>> adata_spatial = anndata.read_h5ad(path_to_spatial) >>> scviva.model.GIMVI.setup_anndata(adata_seq) >>> scviva.model.GIMVI.setup_anndata(adata_spatial) >>> model = scviva.model.GIMVI(adata_seq, adata_spatial) >>> model.train(max_epochs=200)
Notes
See further usage examples in the following tutorial:
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
|
Convert a legacy saved GIMVI model (<v0.15.0) to the updated save format. |
|
Returns the object in AnnData associated with the key in the data registry. |
|
Deregisters the |
|
Not implemented for this model class. |
|
Convenience constructor from a SpatialData object. |
|
Retrieves the |
|
Returns the object in AnnData associated with the key in the data registry. |
|
Return imputed values for all genes for each dataset. |
|
Return the latent space embedding for each dataset. |
|
Not implemented for this model class. |
|
Returns the string provided to setup of a specific setup_arg. |
|
Returns the state registry for the AnnDataField registered with this instance. |
|
Variable names of input data. |
|
Instantiate a model from the saved output. |
|
Return the full registry saved with the model. |
|
Plot latent embedding overlaid on tissue spatial coordinates. |
|
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 |
|
Register the spatial adata component from a SpatialData object. |
|
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
- GIMVI.adata#
Data attached to model instance.
- GIMVI.adata_manager#
Manager instance associated with self.adata.
- GIMVI.device#
The current device that the module’s params are on.
- GIMVI.get_normalized_function_name#
What the get normalized functions name is
- GIMVI.history#
Returns computed metrics during training.
- GIMVI.is_trained#
Whether the model has been trained.
- GIMVI.registry#
Data attached to model instance.
- GIMVI.run_id#
Returns the run id of the model. Used in MLFlow
- GIMVI.run_name#
Returns the run name of the model. Used in MLFlow
- GIMVI.summary_string#
Summary string of the model.
- GIMVI.test_indices#
Observations that are in test set.
- GIMVI.train_indices#
Observations that are in train set.
- GIMVI.validation_indices#
Observations that are in validation set.
Methods
- classmethod GIMVI.convert_legacy_save(dir_path, output_dir_path, overwrite=False, prefix=None, **save_kwargs)[source]#
Convert a legacy saved GIMVI model (<v0.15.0) to the updated save format.
- Parameters:
- dir_path
str Path to directory where legacy model is saved.
- output_dir_path
str Path to save converted save files.
- overwrite
bool Overwrite existing data or not. If
Falseand directory already exists atoutput_dir_path, error will be raised.- prefix
str|None Prefix of saved file names.
- **save_kwargs
Keyword arguments passed into
save().
- dir_path
- Return type:
- GIMVI.data_registry(registry_key)[source]#
Returns the object in AnnData associated with the key in the data registry.
- GIMVI.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.
- GIMVI.differential_abundance(*args, **kwargs)[source]#
Not implemented for this model class.
Available in models that inherit from
VAEMixin.- Raises:
- classmethod GIMVI.from_spatialdata(sdata, table_key='table', region=None, **model_kwargs)[source]#
Convenience constructor from a SpatialData object.
Calls
setup_spatialdata()then constructs and returns the model.- Parameters:
- sdata
A
spatialdata.SpatialDataobject.- table_key
str Key in
sdatapointing to the AnnData table.- region
str|None Region name to subset.
- **model_kwargs
Passed to the model constructor.
- Returns:
Instantiated model.
- GIMVI.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:
- GIMVI.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.
- GIMVI.get_imputed_values(adatas=None, deterministic=True, normalized=True, decode_mode=None, batch_size=128)[source]#
Return imputed values for all genes for each dataset.
- Parameters:
- Return type:
- GIMVI.get_latent_representation(adatas=None, deterministic=True, batch_size=128, backend='cpu')[source]#
Return the latent space embedding for each dataset.
- Parameters:
- adatas
list[AnnData] List of [adata_seq, adata_spatial]. If None, uses the training adatas.
- deterministic
bool If True, use the encoder mean instead of a Gaussian sample.
- batch_size
int Minibatch size for data loading.
- backend
str "cpu"returns numpy arrays."rapids"transfers each latent array to a cupy array for GPU downstream processing (requirespip install cuml).
- adatas
- Return type:
- Returns:
List of arrays, one per dataset (seq then spatial).
- GIMVI.get_normalized_expression(*args, **kwargs)[source]#
Not implemented for this model class.
Available in RNA models that inherit from
RNASeqMixin.- Raises:
- GIMVI.get_setup_arg(setup_arg)[source]#
Returns the string provided to setup of a specific setup_arg.
- Return type:
- GIMVI.get_state_registry(registry_key)[source]#
Returns the state registry for the AnnDataField registered with this instance.
- Return type:
- classmethod GIMVI.load(dir_path, adata_seq=None, adata_spatial=None, accelerator='auto', device='auto', prefix=None, backup_url=None)[source]#
Instantiate a model from the saved output.
- Parameters:
- dir_path
str Path to saved outputs.
- adata_seq
AnnData|None scRNA-seq AnnData. If None, will check for saved anndata.
- adata_spatial
AnnData|None Spatial AnnData. If None, will check for saved anndata.
- accelerator
str Supports passing different accelerator types
("cpu", "gpu", "tpu", "ipu", "hpu", "mps, "auto")as well as custom accelerator instances.- device
int|str 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 Prefix of saved file names.
- backup_url
str|None URL to retrieve saved outputs from if not present on disk.
- dir_path
- Returns:
Model with loaded state dictionaries.
- static GIMVI.load_registry(dir_path, prefix=None)[source]#
Return the full registry saved with the model.
- GIMVI.plot_spatial_embedding(adata=None, basis='spatial', color=None, **kwargs)[source]#
Plot latent embedding overlaid on tissue spatial coordinates.
A thin wrapper around
scanpy.pl.embedding()that defaultsbasisto the spatial coordinate key so cells are displayed in tissue space.- Parameters:
- adata
AnnData object. If None, uses the model’s registered adata.
- basis
str Key in
adata.obsmcontaining 2D spatial coordinates.- color
Keys to color cells by (obs columns, gene names, etc.).
- **kwargs
Forwarded to
scanpy.pl.embedding().
- classmethod GIMVI.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.
- GIMVI.save(dir_path, prefix=None, overwrite=False, save_anndata=False, save_kwargs=None, **anndata_write_kwargs)[source]#
Save the state of the model.
- Parameters:
- dir_path
str Path to a directory.
- prefix
str|None Prefix to prepend to saved file names.
- overwrite
bool Overwrite existing data or not.
- save_anndata
bool If True, also saves the anndata objects.
- save_kwargs
dict|None Keyword arguments passed into
save().- **anndata_write_kwargs
Keyword arguments passed into
write()whensave_anndata=True.
- dir_path
- classmethod GIMVI.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 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 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 Column in
obsto use as the batch variable.- labels_key
str|None Column in
obsto use as the cell-type / label variable.- sample_key
str|None Column in
obsto use as the sample variable. Used by models like MrVI.- unlabeled_category
str Value used to mark unlabeled cells in
labels_key. Required by semi-supervised models such as SCANVI. Defaults to"Unknown".- layer
str|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 Additional categorical covariate columns in
obs.- continuous_covariate_keys
list[str] |None Additional continuous covariate columns in
obs.- rebuild
bool 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 Number of cells per batch yielded by the
Loader.- chunk_size
int Number of cells loaded from disk contiguously per read.
- preload_nchunks
int Number of chunks to preload and shuffle in memory.
- preload_to_gpu
bool Whether the loader should move data to GPU before yielding.
- dataset_size
int|str 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 Whether to pre-shuffle cells when building the collection.
- var_subset
list[str] |None Optional list of gene names to restrict the collection to (passed as
var_subsettoadd_adatas).- merge
Optional[Literal['same','unique','first','only']] 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 GIMVI.setup_anndata(adata, batch_key=None, labels_key=None, layer=None, **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.
Call once for
adata_seqand once foradata_spatialbefore constructing the model.- Parameters:
- adata
AnnData AnnData object. Rows represent cells, columns represent features.
- batch_key
str|None key in
adata.obsfor batch information. Categories will automatically be converted into integer categories and saved toadata.obs['_scvi_batch']. IfNone, assigns the same batch to all the data.- labels_key
str|None key in
adata.obsfor label information. Categories will automatically be converted into integer categories and saved toadata.obs['_scvi_labels']. IfNone, assigns the same label to all the data.- layer
str|None if not
None, uses this as the key inadata.layersfor raw count data.- **kwargs
Keyword args for
register_fields().
- adata
- classmethod GIMVI.setup_spatialdata(sdata, table_key='table', region=None, **kwargs)[source]#
Register the spatial adata component from a SpatialData object.
Calls
setup_anndata()on the extracted table. The scRNA-seq component must always be registered viasetup_anndata()directly.- Parameters:
- sdata
A
spatialdata.SpatialDataobject.- table_key
str Key in
sdatapointing to the spatial AnnData table.- region
str|None Region name to subset (stored in
sdata[table_key].obs).- **kwargs
Passed to
setup_anndata().
- Return type:
- GIMVI.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
- GIMVI.train(max_epochs=200, accelerator='auto', devices='auto', kappa=5, train_size=None, validation_size=None, shuffle_set_split=True, batch_size=128, datasplitter_kwargs=None, plan_kwargs=None, **kwargs)[source]#
Train the model.
- Parameters:
- max_epochs
int Number of passes through the dataset.
- accelerator
str Supports passing different accelerator types
("cpu", "gpu", "tpu", "ipu", "hpu", "mps, "auto")as well as custom accelerator instances.- devices
int|list[int] |str 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.- kappa
int Scaling parameter for the discriminator loss.
- train_size
float|None Size of training set in the range [0.0, 1.0].
- validation_size
float|None Size of the test set.
- shuffle_set_split
bool Whether to shuffle indices before splitting.
- batch_size
int Minibatch size.
- datasplitter_kwargs
dict|None Additional kwargs for
DataSplitter.- plan_kwargs
dict|None Keyword args for the training plan.
- **kwargs
Other keyword args for
Trainer.
- max_epochs
- GIMVI.transfer_fields(adata, **kwargs)[source]#
Transfer fields from a model to an AnnData object.
- Return type:
- GIMVI.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
- GIMVI.view_anndata_setup(adata=None, hide_state_registries=False)[source]#
Print summary of the setup for the initial AnnData or a given AnnData object.