scvi.model.base.BaseModelClass#
- class scvi.model.base.BaseModelClass(adata=None)[source]#
Abstract class for scvi-tools models.
Notes
See further usage examples in the following tutorials:
Attributes table#
Data attached to model instance. |
|
Manager instance associated with self.adata. |
|
The current device that the module's params are on. |
|
Returns computed metrics during training. |
|
Whether the model has been trained. |
|
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. |
|
Deregisters the |
|
Retrieves the |
|
Returns the object in AnnData associated with the key in the data registry. |
|
Instantiate a model from the saved output. |
|
Return the full registry saved with the model. |
|
Registers an |
|
Save the state of the model. |
|
Sets up the |
|
Move model to device. |
|
Trains the model. |
|
Print summary of the setup for the initial AnnData or a given AnnData object. |
|
Print args used to setup a saved model. |
Attributes#
Methods#
- classmethod BaseModelClass.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 directory where legacy model is saved.output_dir_path (
str
) – Path to save converted save files.overwrite (
bool
(default:False
)) – Overwrite existing data or not. IfFalse
and directory already exists atoutput_dir_path
, error will be raised.prefix (
str
|None
(default:None
)) – Prefix of saved file names.**save_kwargs – Keyword arguments passed into
save()
.
- Return type:
- BaseModelClass.deregister_manager(adata=None)[source]#
Deregisters the
AnnDataManager
instance associated with adata.If adata is None, deregisters all
AnnDataManager
instances in both the class and instance-specific manager stores, except for the one associated with this model instance.
- BaseModelClass.get_anndata_manager(adata, required=False)[source]#
Retrieves the
AnnDataManager
for a given AnnData object.Requires
self.id
has been set. Checks for anAnnDataManager
specific to this model instance.- Parameters:
- Return type:
- BaseModelClass.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_anndata
method.
- classmethod BaseModelClass.load(dir_path, adata=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 (
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 scvi setup dictionary. If None, will check for and load anndata saved with the model.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 (int or str) or “auto” for automatic selection based on the chosen accelerator. If set to “auto” and accelerator is not determined to be “cpu”, then device will 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.
- Returns:
Model with loaded state dictionaries.
Examples
>>> model = ModelClass.load(save_path, adata) >>> model.get_....
- static BaseModelClass.load_registry(dir_path, prefix=None)[source]#
Return the full registry saved with the model.
- classmethod BaseModelClass.register_manager(adata_manager)[source]#
Registers an
AnnDataManager
instance with this model class.Stores the
AnnDataManager
reference in a class-specific manager store. Intended for use in thesetup_anndata()
class method followed up by retrieval of theAnnDataManager
via the_get_most_recent_anndata_manager()
method in the model init method.Notes
Subsequent calls to this method with an
AnnDataManager
instance referring to the same underlying AnnData object will overwrite the reference to previousAnnDataManager
.
- BaseModelClass.save(dir_path, prefix=None, overwrite=False, save_anndata=False, save_kwargs=None, legacy_mudata_format=False, **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 False and directory already exists at dir_path, error will be raised.save_anndata (
bool
(default:False
)) – If True, also saves the anndatasave_kwargs (
dict
|None
(default:None
)) – Keyword arguments passed intosave()
.legacy_mudata_format (
bool
(default:False
)) – IfTrue
, saves the modelvar_names
in the legacy format if the model was trained with aMuData
object. 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.anndata_write_kwargs – Kwargs for
write()
- abstract classmethod BaseModelClass.setup_anndata(adata, *args, **kwargs)[source]#
Sets up the
AnnData
object 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.
Each model class deriving from this class provides parameters to this method according to its needs. To operate correctly with the model initialization, the implementation must call
register_manager()
on a model-specific instance ofAnnDataManager
.
- BaseModelClass.to_device(device)[source]#
Move model to device.
- Parameters:
device (
str
|int
) – Device to move model to. Options: ‘cpu’ for CPU, integer GPU index (eg. 0), or ‘cuda:X’ where X is the GPU index (eg. ‘cuda:0’). See torch.device for more info.
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