data_check_message
===============================================

.. py:module:: evalml.data_checks.data_check_message

.. autoapi-nested-parse::

   Messages returned by a DataCheck, tagged by name.



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

Classes Summary
~~~~~~~~~~~~~~~

.. autoapisummary::

   evalml.data_checks.data_check_message.DataCheckError
   evalml.data_checks.data_check_message.DataCheckMessage
   evalml.data_checks.data_check_message.DataCheckWarning





Contents
~~~~~~~~~~~~~~~~~~~
.. py:class:: DataCheckError(message, data_check_name, message_code=None, details=None, action_options=None)



   DataCheckMessage subclass for errors returned by data checks.


   **Attributes**

   .. list-table::
      :widths: 15 85
      :header-rows: 0

      * - **message_type**
        - DataCheckMessageType.ERROR


   **Methods**

   .. autoapisummary::
      :nosignatures:

      evalml.data_checks.data_check_message.DataCheckError.to_dict

   .. py:method:: to_dict(self)

      Return a dictionary form of the data check message.



.. py:class:: DataCheckMessage(message, data_check_name, message_code=None, details=None, action_options=None)

   Base class for a message returned by a DataCheck, tagged by name.

   :param message: Message string.
   :type message: str
   :param data_check_name: Name of the associated data check.
   :type data_check_name: str
   :param message_code: Message code associated with the message. Defaults to None.
   :type message_code: DataCheckMessageCode, optional
   :param details: Additional useful information associated with the message. Defaults to None.
   :type details: dict, optional
   :param action_options: A list of `DataCheckActionOption`s associated with the message. Defaults to None.
   :type action_options: list, optional


   **Attributes**

   .. list-table::
      :widths: 15 85
      :header-rows: 0

      * - **message_type**
        - None


   **Methods**

   .. autoapisummary::
      :nosignatures:

      evalml.data_checks.data_check_message.DataCheckMessage.to_dict

   .. py:method:: to_dict(self)

      Return a dictionary form of the data check message.



.. py:class:: DataCheckWarning(message, data_check_name, message_code=None, details=None, action_options=None)



   DataCheckMessage subclass for warnings returned by data checks.


   **Attributes**

   .. list-table::
      :widths: 15 85
      :header-rows: 0

      * - **message_type**
        - DataCheckMessageType.WARNING


   **Methods**

   .. autoapisummary::
      :nosignatures:

      evalml.data_checks.data_check_message.DataCheckWarning.to_dict

   .. py:method:: to_dict(self)

      Return a dictionary form of the data check message.