scvi.dataloaders.MappedCollectionDataModule
===========================================

.. currentmodule:: scvi.dataloaders

.. add toctree option to make autodoc generate the pages

.. autoclass:: MappedCollectionDataModule



Attributes table
~~~~~~~~~~~~~~~~~~

.. autosummary::

    ~scvi.dataloaders.MappedCollectionDataModule.CHECKPOINT_HYPER_PARAMS_KEY
    ~scvi.dataloaders.MappedCollectionDataModule.CHECKPOINT_HYPER_PARAMS_NAME
    ~scvi.dataloaders.MappedCollectionDataModule.CHECKPOINT_HYPER_PARAMS_TYPE
    ~scvi.dataloaders.MappedCollectionDataModule.batch_labels
    ~scvi.dataloaders.MappedCollectionDataModule.extra_categorical_covs
    ~scvi.dataloaders.MappedCollectionDataModule.extra_continuous_covs
    ~scvi.dataloaders.MappedCollectionDataModule.hparams
    ~scvi.dataloaders.MappedCollectionDataModule.hparams_initial
    ~scvi.dataloaders.MappedCollectionDataModule.label_keys
    ~scvi.dataloaders.MappedCollectionDataModule.labels
    ~scvi.dataloaders.MappedCollectionDataModule.n_batch
    ~scvi.dataloaders.MappedCollectionDataModule.n_labels
    ~scvi.dataloaders.MappedCollectionDataModule.n_obs
    ~scvi.dataloaders.MappedCollectionDataModule.n_samples
    ~scvi.dataloaders.MappedCollectionDataModule.n_vars
    ~scvi.dataloaders.MappedCollectionDataModule.name
    ~scvi.dataloaders.MappedCollectionDataModule.registry
    ~scvi.dataloaders.MappedCollectionDataModule.sample_keys
    ~scvi.dataloaders.MappedCollectionDataModule.samples
    ~scvi.dataloaders.MappedCollectionDataModule.unlabeled_category
    ~scvi.dataloaders.MappedCollectionDataModule.var_names





Methods table
~~~~~~~~~~~~~

.. autosummary::

    ~scvi.dataloaders.MappedCollectionDataModule.close
    ~scvi.dataloaders.MappedCollectionDataModule.from_datasets
    ~scvi.dataloaders.MappedCollectionDataModule.inference_dataloader
    ~scvi.dataloaders.MappedCollectionDataModule.load_from_checkpoint
    ~scvi.dataloaders.MappedCollectionDataModule.load_state_dict
    ~scvi.dataloaders.MappedCollectionDataModule.on_after_batch_transfer
    ~scvi.dataloaders.MappedCollectionDataModule.on_before_batch_transfer
    ~scvi.dataloaders.MappedCollectionDataModule.on_exception
    ~scvi.dataloaders.MappedCollectionDataModule.predict_dataloader
    ~scvi.dataloaders.MappedCollectionDataModule.prepare_data
    ~scvi.dataloaders.MappedCollectionDataModule.remove_ignored_hparams
    ~scvi.dataloaders.MappedCollectionDataModule.save_hyperparameters
    ~scvi.dataloaders.MappedCollectionDataModule.setup
    ~scvi.dataloaders.MappedCollectionDataModule.state_dict
    ~scvi.dataloaders.MappedCollectionDataModule.teardown
    ~scvi.dataloaders.MappedCollectionDataModule.test_dataloader
    ~scvi.dataloaders.MappedCollectionDataModule.train_dataloader
    ~scvi.dataloaders.MappedCollectionDataModule.transfer_batch_to_device
    ~scvi.dataloaders.MappedCollectionDataModule.val_dataloader





Attributes
~~~~~~~~~~~



.. autoattribute:: MappedCollectionDataModule.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: MappedCollectionDataModule.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: MappedCollectionDataModule.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: MappedCollectionDataModule.batch_labels

.. autoattribute:: MappedCollectionDataModule.extra_categorical_covs

.. autoattribute:: MappedCollectionDataModule.extra_continuous_covs

.. autoattribute:: MappedCollectionDataModule.hparams

.. autoattribute:: MappedCollectionDataModule.hparams_initial

.. autoattribute:: MappedCollectionDataModule.label_keys

.. autoattribute:: MappedCollectionDataModule.labels

.. autoattribute:: MappedCollectionDataModule.n_batch

.. autoattribute:: MappedCollectionDataModule.n_labels

.. autoattribute:: MappedCollectionDataModule.n_obs

.. autoattribute:: MappedCollectionDataModule.n_samples

.. autoattribute:: MappedCollectionDataModule.n_vars

.. autoattribute:: MappedCollectionDataModule.name

.. autoattribute:: MappedCollectionDataModule.registry

.. autoattribute:: MappedCollectionDataModule.sample_keys

.. autoattribute:: MappedCollectionDataModule.samples

.. autoattribute:: MappedCollectionDataModule.unlabeled_category

.. autoattribute:: MappedCollectionDataModule.var_names






Methods
~~~~~~~



.. automethod:: MappedCollectionDataModule.close

.. automethod:: MappedCollectionDataModule.from_datasets

.. automethod:: MappedCollectionDataModule.inference_dataloader

.. automethod:: MappedCollectionDataModule.load_from_checkpoint

.. automethod:: MappedCollectionDataModule.load_state_dict

.. automethod:: MappedCollectionDataModule.on_after_batch_transfer

.. automethod:: MappedCollectionDataModule.on_before_batch_transfer

.. automethod:: MappedCollectionDataModule.on_exception

.. automethod:: MappedCollectionDataModule.predict_dataloader

.. automethod:: MappedCollectionDataModule.prepare_data

.. automethod:: MappedCollectionDataModule.remove_ignored_hparams

.. automethod:: MappedCollectionDataModule.save_hyperparameters

.. automethod:: MappedCollectionDataModule.setup

.. automethod:: MappedCollectionDataModule.state_dict

.. automethod:: MappedCollectionDataModule.teardown

.. automethod:: MappedCollectionDataModule.test_dataloader

.. automethod:: MappedCollectionDataModule.train_dataloader

.. automethod:: MappedCollectionDataModule.transfer_batch_to_device

.. automethod:: MappedCollectionDataModule.val_dataloader