anndata.experimental.AnnLoader#

class anndata.experimental.AnnLoader(*args, **kwargs)[source]#

PyTorch DataLoader for AnnData objects.

Deprecated: The class AnnLoader is deprecated and will be removed in the future. Use :class:`annbatch.Loader` instead of `AnnLoader`

Deprecated since version 0.12.17: Use annbatch.Loader instead of AnnLoader

Builds DataLoader from a sequence of AnnData objects, from an AnnCollection object or from an AnnCollectionView object. Takes care of the required conversions.

Parameters:
adatas

AnnData objects or an AnnCollection object from which to load the data.

batch_size

How many samples per batch to load.

shuffle

Set to True to have the data reshuffled at every epoch.

use_default_converter

Use the default converter to convert arrays to pytorch tensors, transfer to the default cuda device (if use_cuda=True), do memory pinning (if pin_memory=True). If you pass an AnnCollection object with prespecified converters, the default converter won’t overwrite these converters but will be applied on top of them.

use_cuda

Transfer pytorch tensors to the default cuda device after conversion. Only works if use_default_converter=True

**kwargs Any

Arguments for PyTorch DataLoader. If adatas is not an AnnCollection object, then also arguments for AnnCollection initialization.