data_check_message#

Messages returned by a DataCheck, tagged by name.

Module Contents#

Classes Summary#

`DataCheckError`	DataCheckMessage subclass for errors returned by data checks.
`DataCheckMessage`	Base class for a message returned by a DataCheck, tagged by name.
`DataCheckWarning`	DataCheckMessage subclass for warnings returned by data checks.

Contents#

class evalml.data_checks.data_check_message.DataCheckError(message, data_check_name, message_code=None, details=None, action_options=None)[source]#

DataCheckMessage subclass for errors returned by data checks.

Attributes

message_type

DataCheckMessageType.ERROR

Methods

to_dict

Return a dictionary form of the data check message.

to_dict(self)#: Return a dictionary form of the data check message.

class evalml.data_checks.data_check_message.DataCheckMessage(message, data_check_name, message_code=None, details=None, action_options=None)[source]#

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

Parameters

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

Attributes

message_type

None

Methods

to_dict

Return a dictionary form of the data check message.

to_dict(self)[source]#: Return a dictionary form of the data check message.

class evalml.data_checks.data_check_message.DataCheckWarning(message, data_check_name, message_code=None, details=None, action_options=None)[source]#

DataCheckMessage subclass for warnings returned by data checks.

Attributes

message_type

DataCheckMessageType.WARNING

Methods

to_dict

Return a dictionary form of the data check message.

to_dict(self)#: Return a dictionary form of the data check message.