data_check_action_option#

DataCheck 返回的推荐动作。

模块内容#

类摘要#

`DataCheckActionOption`	DataCheck 返回的推荐动作选项。
`DCAOParameterAllowedValuesType`	数据检查动作选项参数允许值类型的枚举。
`DCAOParameterType`	数据检查动作选项参数类型的枚举。

目录#

class evalml.data_checks.data_check_action_option.DataCheckActionOption(action_code, data_check_name, parameters=None, metadata=None)[source]#

DataCheck 返回的推荐动作选项。

它包含一个指示动作内容的代码（action code）、一个指示用于生成此动作的数据检查的名称（data check name），以及可用于进一步细化动作的参数（parameters）和元数据（metadata）。

参数

action_code (DataCheckActionCode) – 与动作选项关联的动作代码。
data_check_name (str) – 生成此选项的数据检查的名称。
parameters (dict) – 与动作选项关联的参数。默认为 None。
metadata (dict, optional) – 与动作选项关联的额外有用信息。默认为 None。

示例

>>> parameters = {
...     "global_parameter_name": {
...         "parameter_type": "global",
...         "type": "float",
...         "default_value": 0.0,
...     },
...     "column_parameter_name": {
...         "parameter_type": "column",
...         "columns": {
...             "a": {
...                 "impute_strategy": {
...                     "categories": ["mean", "most_frequent"],
...                     "type": "category",
...                     "default_value": "mean",
...                 },
...             "constant_fill_value": {"type": "float", "default_value": 0},
...             },
...         },
...     },
... }
>>> data_check_action = DataCheckActionOption(DataCheckActionCode.DROP_COL, None, metadata={}, parameters=parameters)

方法

`convert_dict_to_option`	将字典转换为 DataCheckActionOption。
`get_action_from_defaults`	根据默认参数返回一个动作。
`to_dict`	返回数据检查动作选项的字典形式。

static convert_dict_to_option(action_dict)[source]#

将字典转换为 DataCheckActionOption。

参数: action_dict – 要转换为动作选项的字典。应包含键“code”、“data_check_name”和“metadata”。
引发: ValueError – 如果输入字典不包含键 code 和 metadata，或者如果 metadata 字典不包含键 columns 和 rows。
返回: 由输入字典生成的 DataCheckActionOption 对象。

get_action_from_defaults(self)[source]#

根据默认参数返回一个动作。

返回: 基于选项的默认参数返回的动作。
返回类型: DataCheckAction

to_dict(self)[source]#: 返回数据检查动作选项的字典形式。

class evalml.data_checks.data_check_action_option.DCAOParameterAllowedValuesType[source]#

数据检查动作选项参数允许值类型的枚举。

属性

CATEGORICAL	分类允许值类型。具有一组允许值的参数。
NUMERICAL	数值允许值类型。具有一定范围允许值的参数。

方法

`name`	枚举成员的名称。
`value`	枚举成员的值。

name(self)#: 枚举成员的名称。

value(self)#: 枚举成员的值。

class evalml.data_checks.data_check_action_option.DCAOParameterType[source]#

数据检查动作选项参数类型的枚举。

属性

COLUMN	列参数类型。应用于数据集中特定列的参数。
GLOBAL	全局参数类型。应用于整个数据集的参数。

方法

`all_parameter_types`	获取所有已定义参数类型的列表。
`handle_dcao_parameter_type`	处理数据检查动作选项参数类型，返回 DCAOParameterType 枚举或从字符串转换。
`name`	枚举成员的名称。
`value`	枚举成员的值。

all_parameter_types(cls)#

获取所有已定义参数类型的列表。

返回: 所有已定义参数类型的列表。
返回类型: list(DCAOParameterType)

static handle_dcao_parameter_type(dcao_parameter_type)[source]#

处理数据检查动作选项参数类型，返回 DCAOParameterType 枚举或从字符串转换。

参数

dcao_parameter_type (str or DCAOParameterType) – 需要处理的数据检查动作选项参数类型。

返回

DCAOParameterType 枚举

引发

KeyError – 如果输入不是有效的 DCAOParameterType 枚举值。
ValueError – 如果输入不是字符串或 DCAOParameterType 对象。

name(self)#: 枚举成员的名称。

value(self)#: 枚举成员的值。