scvi.dataloaders.ConcatDataLoader#

class scvi.dataloaders.ConcatDataLoader(adata_manager, indices_list, shuffle=False, batch_size=128, data_and_attributes=None, drop_last=False, distributed_sampler=False, **data_loader_kwargs)[source]#

Bases: DataLoader

DataLoader that supports a list of list of indices to load.

Parameters:
adata_manager AnnDataManager

AnnDataManager object that has been created via setup_anndata.

indices_list list[list[int]]

List where each element is a list of indices in the adata to load

shuffle bool (default: False)

Whether the data should be shuffled

batch_size int (default: 128)

minibatch size to load each iteration

data_and_attributes dict | None (default: None)

Dictionary with keys representing keys in data registry (adata_manager.data_registry) and value equal to desired numpy loading type (later made into torch tensor). If None, defaults to all registered data.

drop_last bool | int (default: False)

If True and the dataset is not evenly divisible by batch_size, the last incomplete batch is dropped. If False and the dataset is not evenly divisible by batch_size, then the last batch will be smaller than batch_size.

distributed_sampler bool (default: False)

EXPERIMENTAL Whether to use BatchDistributedSampler as the sampler. If True, sampler must be None.

data_loader_kwargs

Keyword arguments for DataLoader

Attributes table#

Methods table#

Attributes#

ConcatDataLoader.dataset#
ConcatDataLoader.batch_size#
ConcatDataLoader.num_workers#
ConcatDataLoader.pin_memory#
ConcatDataLoader.drop_last#
ConcatDataLoader.timeout#
ConcatDataLoader.sampler#
ConcatDataLoader.pin_memory_device#
ConcatDataLoader.prefetch_factor#

Methods#