data_check_action
==============================================

.. py:module:: evalml.data_checks.data_check_action

.. autoapi-nested-parse::

   Recommended action returned by a DataCheck.



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

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

.. autoapisummary::

   evalml.data_checks.data_check_action.DataCheckAction





Contents
~~~~~~~~~~~~~~~~~~~
.. py:class:: DataCheckAction(action_code, data_check_name, metadata=None)

   A recommended action returned by a DataCheck.

   :param action_code: Action code associated with the action.
   :type action_code: str, DataCheckActionCode
   :param data_check_name: Name of data check.
   :type data_check_name: str
   :param metadata: Additional useful information associated with the action. Defaults to None.
   :type metadata: dict, optional




   **Methods**

   .. autoapisummary::
      :nosignatures:

      evalml.data_checks.data_check_action.DataCheckAction.convert_dict_to_action
      evalml.data_checks.data_check_action.DataCheckAction.to_dict

   .. py:method:: convert_dict_to_action(action_dict)
      :staticmethod:

      Convert a dictionary into a DataCheckAction.

      :param action_dict: Dictionary to convert into action. Should have keys "code", "data_check_name", and "metadata".

      :raises ValueError: If input dictionary does not have keys `code` and `metadata` and if the `metadata` dictionary does not have keys `columns` and `rows`.

      :returns: DataCheckAction object from the input dictionary.


   .. py:method:: to_dict(self)

      Return a dictionary form of the data check action.