dacapo.experiments.architectures.dummy_architecture_config
==========================================================

.. py:module:: dacapo.experiments.architectures.dummy_architecture_config


Classes
-------

.. autoapisummary::

   dacapo.experiments.architectures.dummy_architecture_config.DummyArchitectureConfig


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

.. py:class:: DummyArchitectureConfig



   A dummy architecture configuration class used for testing purposes.

   It extends the base class "ArchitectureConfig". This class contains dummy attributes and always
   returns that the configuration is invalid when verified.

   .. attribute:: architecture_type

      A class attribute assigning
      the DummyArchitecture class to this configuration.

      :type: :obj:`DummyArchitecture`

   .. attribute:: num_in_channels

      The number of input channels. This is a dummy attribute and has no real
      functionality or meaning.

      :type: int

   .. attribute:: num_out_channels

      The number of output channels. This is also a dummy attribute and
      has no real functionality or meaning.

      :type: int

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

      This method is used to check whether this is a valid architecture configuration.

   .. note:: This class is used to represent a DummyArchitectureConfig object in the system.


   .. py:attribute:: architecture_type


   .. py:attribute:: num_in_channels
      :type:  int


   .. py:attribute:: num_out_channels
      :type:  int


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

      Verifies the configuration validity.

      Since this is a dummy configuration for testing purposes, this method always returns False
      indicating that the configuration is invalid.

      :returns: A tuple containing a boolean validity flag and a reason message string.
      :rtype: tuple

      :raises NotImplementedError: This method is not implemented in this class.

      .. rubric:: Examples

      >>> dummy_architecture_config = DummyArchitectureConfig(num_in_channels=1, num_out_channels=1)
      >>> dummy_architecture_config.verify()
      (False, "This is a DummyArchitectureConfig and is never valid")

      .. note:: This method is used to check whether this is a valid architecture configuration.