data_check_action#

Recommended action returned by a DataCheck.

Module Contents#

Classes Summary#

DataCheckAction

A recommended action returned by a DataCheck.

Contents#

class evalml.data_checks.data_check_action.DataCheckAction(action_code, data_check_name, metadata=None)[source]#

A recommended action returned by a DataCheck.

Parameters

  • action_code (str, DataCheckActionCode) – Action code associated with the action.

  • data_check_name (str) – Name of data check.

  • metadata (dict, optional) – Additional useful information associated with the action. Defaults to None.

Methods

convert_dict_to_action

Convert a dictionary into a DataCheckAction.

to_dict

Return a dictionary form of the data check action.
static convert_dict_to_action(action_dict)[source]#

Convert a dictionary into a DataCheckAction.

Parameters

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.

to_dict(self)[source]#

Return a dictionary form of the data check action.