scvi.data.AnnDataManager#
- class scvi.data.AnnDataManager(fields=None, setup_method_args=None, validation_checks=None)[source]#
Provides an interface to validate and process an AnnData object for use in scvi-tools.
A class which wraps a collection of AnnDataField instances and provides an interface to validate and process an AnnData object with respect to the fields.
- Parameters:
- fields
list[type[BaseAnnDataField]] |None(default:None) List of AnnDataFields to initialize with.
- setup_method_args
dict|None(default:None) Dictionary describing the model and arguments passed in by the user to setup this AnnDataManager.
- validation_checks
AnnDataManagerValidationCheck|None(default:None) DataClass specifying which global validation checks to run on the data object.
- fields
Examples
>>> fields = [LayerField("counts", "raw_counts")] >>> adata_manager = AnnDataManager(fields=fields) >>> adata_manager.register_fields(adata)
Notes
This class is not initialized with a specific AnnData object, but later sets
self.adataviaregister_fields(). This decouples the generalized definition of the scvi-tools interface with the registration of an instance of data.See further usage examples in the following tutorials:
Attributes table#
Returns the UUID for the AnnData object registered with this instance. |
|
Returns the data registry for the AnnData object registered with this instance. |
|
Returns the top-level registry dictionary for the AnnData object. |
|
Returns the summary stats for the AnnData object registered with this instance. |
Methods table#
|
Creates a torch dataset from the AnnData object registered with this instance. |
|
Returns the object in AnnData associated with the key in the data registry. |
|
Returns the state registry for the AnnDataField registered with this instance. |
|
Registers each field associated with this instance with the AnnData object. |
|
Register new fields to a manager instance. |
|
Transfers an existing setup to each field associated with this instance. |
|
Update setup method args. |
|
Checks if AnnData was last setup with this AnnDataManager instance. |
|
Prints summary of the registry. |
|
Prints setup kwargs used to produce a given registry. |
Attributes#
- AnnDataManager.adata_uuid#
Returns the UUID for the AnnData object registered with this instance.
- AnnDataManager.data_registry#
Returns the data registry for the AnnData object registered with this instance.
- AnnDataManager.registry#
Returns the top-level registry dictionary for the AnnData object.
- AnnDataManager.summary_stats#
Returns the summary stats for the AnnData object registered with this instance.
Methods#
- AnnDataManager.create_torch_dataset(indices=None, data_and_attributes=None, load_sparse_tensor=False)[source]#
Creates a torch dataset from the AnnData object registered with this instance.
- Parameters:
- indices
Sequence[int] |Sequence[bool] (default:None) The indices of the observations in the adata to use
- data_and_attributes
list[str] |dict[str,dtype] |None(default:None) Dictionary with keys representing keys in data registry (
adata_manager.data_registry) and value equal to the desired numpy loading type (later made into torch tensor) or list of such keys. A list can be used to subset to certain keys in the event that more tensors than needed have been registered. IfNone, defaults to all registered data.- load_sparse_tensor
bool(default:False) EXPERIMENTALIfTrue, loads data with sparse CSR or CSC layout as aTensorwith the same layout. Can lead to speedups in data transfers to GPUs, depending on the sparsity of the data.
- indices
- Return type:
- Returns:
- AnnDataManager.get_from_registry(registry_key)[source]#
Returns the object in AnnData associated with the key in the data registry.
- AnnDataManager.get_state_registry(registry_key)[source]#
Returns the state registry for the AnnDataField registered with this instance.
- Return type:
- AnnDataManager.register_fields(adata, source_registry=None, **transfer_kwargs)[source]#
Registers each field associated with this instance with the AnnData object.
Either registers or transfers the setup from
source_setup_dictif passed in. Setsself.adata.- Parameters:
- adata
AnnData|MuData AnnData object to be registered.
- source_registry
dict|None(default:None) Registry created after registering an AnnData using an
AnnDataManagerobject.- transfer_kwargs
Additional keywords, which modify transfer behavior. Only applicable if
source_registryis set.
- adata
- AnnDataManager.register_new_fields(fields)[source]#
Register new fields to a manager instance.
This is useful to augment the functionality of an existing manager.
- Parameters:
- fields
list[type[BaseAnnDataField]] List of AnnDataFields to register
- fields
- AnnDataManager.transfer_fields(adata_target, **kwargs)[source]#
Transfers an existing setup to each field associated with this instance.
Creates a new
AnnDataManagerinstance with the same set of fields. Then, registers the fields with a target AnnData object, incorporating details of the source registry where necessary (e.g., for validation or modified data setup).- Parameters:
- Return type:
- AnnDataManager.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
- AnnDataManager.validate()[source]#
Checks if AnnData was last setup with this AnnDataManager instance.
Reregisters it if not.
- Return type: