﻿scvi.dataloaders.DataSplitter
=============================

.. currentmodule:: scvi.dataloaders

.. add toctree option to make autodoc generate the pages

.. autoclass:: DataSplitter



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

.. autosummary::

    ~scvi.dataloaders.DataSplitter.CHECKPOINT_HYPER_PARAMS_KEY
    ~scvi.dataloaders.DataSplitter.CHECKPOINT_HYPER_PARAMS_NAME
    ~scvi.dataloaders.DataSplitter.CHECKPOINT_HYPER_PARAMS_TYPE
    ~scvi.dataloaders.DataSplitter.hparams
    ~scvi.dataloaders.DataSplitter.hparams_initial
    ~scvi.dataloaders.DataSplitter.name





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

.. autosummary::

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





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



.. autoattribute:: DataSplitter.CHECKPOINT_HYPER_PARAMS_KEY

.. autoattribute:: DataSplitter.CHECKPOINT_HYPER_PARAMS_NAME

.. autoattribute:: DataSplitter.CHECKPOINT_HYPER_PARAMS_TYPE

.. autoattribute:: DataSplitter.hparams

.. autoattribute:: DataSplitter.hparams_initial

.. autoattribute:: DataSplitter.name






Methods
~~~~~~~



.. automethod:: DataSplitter.from_datasets

.. automethod:: DataSplitter.load_from_checkpoint

.. automethod:: DataSplitter.load_state_dict

.. automethod:: DataSplitter.on_after_batch_transfer

.. automethod:: DataSplitter.on_before_batch_transfer

.. automethod:: DataSplitter.on_exception

.. automethod:: DataSplitter.predict_dataloader

.. automethod:: DataSplitter.prepare_data

.. automethod:: DataSplitter.save_hyperparameters

.. automethod:: DataSplitter.setup

.. automethod:: DataSplitter.state_dict

.. automethod:: DataSplitter.teardown

.. automethod:: DataSplitter.test_dataloader

.. automethod:: DataSplitter.train_dataloader

.. automethod:: DataSplitter.transfer_batch_to_device

.. automethod:: DataSplitter.val_dataloader


