scvi.dataloaders.AnnbatchDataModule
===================================

.. currentmodule:: scvi.dataloaders

.. add toctree option to make autodoc generate the pages

.. autoclass:: AnnbatchDataModule



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

.. autosummary::

    ~scvi.dataloaders.AnnbatchDataModule.CHECKPOINT_HYPER_PARAMS_KEY
    ~scvi.dataloaders.AnnbatchDataModule.CHECKPOINT_HYPER_PARAMS_NAME
    ~scvi.dataloaders.AnnbatchDataModule.CHECKPOINT_HYPER_PARAMS_TYPE
    ~scvi.dataloaders.AnnbatchDataModule.batch_labels
    ~scvi.dataloaders.AnnbatchDataModule.extra_categorical_covs
    ~scvi.dataloaders.AnnbatchDataModule.extra_continuous_covs
    ~scvi.dataloaders.AnnbatchDataModule.hparams
    ~scvi.dataloaders.AnnbatchDataModule.hparams_initial
    ~scvi.dataloaders.AnnbatchDataModule.labels_mapping
    ~scvi.dataloaders.AnnbatchDataModule.n_batch
    ~scvi.dataloaders.AnnbatchDataModule.n_labels
    ~scvi.dataloaders.AnnbatchDataModule.n_obs
    ~scvi.dataloaders.AnnbatchDataModule.n_obs_per_sample
    ~scvi.dataloaders.AnnbatchDataModule.n_samples
    ~scvi.dataloaders.AnnbatchDataModule.n_vars
    ~scvi.dataloaders.AnnbatchDataModule.name
    ~scvi.dataloaders.AnnbatchDataModule.registry
    ~scvi.dataloaders.AnnbatchDataModule.samples_mapping
    ~scvi.dataloaders.AnnbatchDataModule.train_size
    ~scvi.dataloaders.AnnbatchDataModule.unlabeled_category





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

.. autosummary::

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





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



.. autoattribute:: AnnbatchDataModule.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: AnnbatchDataModule.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: AnnbatchDataModule.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: AnnbatchDataModule.batch_labels

.. autoattribute:: AnnbatchDataModule.extra_categorical_covs

.. autoattribute:: AnnbatchDataModule.extra_continuous_covs

.. autoattribute:: AnnbatchDataModule.hparams

.. autoattribute:: AnnbatchDataModule.hparams_initial

.. autoattribute:: AnnbatchDataModule.labels_mapping

.. autoattribute:: AnnbatchDataModule.n_batch

.. autoattribute:: AnnbatchDataModule.n_labels

.. autoattribute:: AnnbatchDataModule.n_obs

.. autoattribute:: AnnbatchDataModule.n_obs_per_sample

.. autoattribute:: AnnbatchDataModule.n_samples

.. autoattribute:: AnnbatchDataModule.n_vars

.. autoattribute:: AnnbatchDataModule.name

.. autoattribute:: AnnbatchDataModule.registry

.. autoattribute:: AnnbatchDataModule.samples_mapping

.. autoattribute:: AnnbatchDataModule.train_size

.. autoattribute:: AnnbatchDataModule.unlabeled_category






Methods
~~~~~~~



.. automethod:: AnnbatchDataModule.from_datasets

.. automethod:: AnnbatchDataModule.inference_dataloader

.. automethod:: AnnbatchDataModule.load_from_checkpoint

.. automethod:: AnnbatchDataModule.load_state_dict

.. automethod:: AnnbatchDataModule.on_after_batch_transfer

.. automethod:: AnnbatchDataModule.on_before_batch_transfer

.. automethod:: AnnbatchDataModule.on_exception

.. automethod:: AnnbatchDataModule.predict_dataloader

.. automethod:: AnnbatchDataModule.prepare_data

.. automethod:: AnnbatchDataModule.remove_ignored_hparams

.. automethod:: AnnbatchDataModule.save_hyperparameters

.. automethod:: AnnbatchDataModule.set_batch_size

.. automethod:: AnnbatchDataModule.set_split

.. automethod:: AnnbatchDataModule.setup

.. automethod:: AnnbatchDataModule.state_dict

.. automethod:: AnnbatchDataModule.teardown

.. automethod:: AnnbatchDataModule.test_dataloader

.. automethod:: AnnbatchDataModule.train_dataloader

.. automethod:: AnnbatchDataModule.transfer_batch_to_device

.. automethod:: AnnbatchDataModule.val_dataloader