dacapo.experiments.datasplits.dummy_datasplit_config
====================================================

.. py:module:: dacapo.experiments.datasplits.dummy_datasplit_config


Classes
-------

.. autoapisummary::

   dacapo.experiments.datasplits.dummy_datasplit_config.DummyDataSplitConfig


Module Contents
---------------

.. py:class:: DummyDataSplitConfig



   A simple class representing config for Dummy DataSplit.

   This class is derived from 'DataSplitConfig' and is initialized with
   'DatasetConfig' for training dataset.

   .. attribute:: datasplit_type

      Class of dummy data split functionality.

   .. attribute:: train_config

      Config for the training dataset. Defaults to DummyDatasetConfig.

   .. method:: verify()

      
      A method for verification. This method always return 'False' plus
      a string indicating the condition.

   .. rubric:: Notes

   This class is used to represent the configuration for Dummy DataSplit.


   .. py:attribute:: datasplit_type


   .. py:attribute:: train_config
      :type:  dacapo.experiments.datasplits.datasets.DatasetConfig


   .. py:method:: verify() -> Tuple[bool, str]

      A method for verification. This method always return 'False' plus
      a string indicating the condition.

      :returns: A tuple contains a boolean 'False' and a string.
      :rtype: Tuple[bool, str]

      .. rubric:: Examples

      >>> dummy_datasplit_config = DummyDataSplitConfig(train_config)
      >>> dummy_datasplit_config.verify()
      (False, "This is a DummyDataSplit and is never valid")

      .. rubric:: Notes

      This method is used to verify the configuration of DummyDataSplit.