component_base#

所有组件的基类。

模块内容#

类摘要#

ComponentBase

所有组件的基类。

内容#

class evalml.pipelines.components.component_base.ComponentBase(parameters=None, component_obj=None, random_seed=0, **kwargs)[source]#

所有组件的基类。

参数

parameters (dict) – 组件参数的字典。默认为 None。
component_obj (obj) – 在组件实现中有用的第三方对象。默认为 None。
random_seed (int) – 随机数生成器的种子。默认为 0。

方法

`clone`	构造一个具有相同参数和随机状态的新组件。
`default_parameters`	返回此组件的默认参数。
`describe`	描述一个组件及其参数。
`fit`	将组件拟合到数据。
`load`	从文件路径加载组件。
`modifies_features`	返回此组件在转换过程中是否修改（子集化或转换）特征变量。
`modifies_target`	返回此组件在转换过程中是否修改（子集化或转换）目标变量。
`name`	返回此组件的字符串名称。
`needs_fitting`	返回一个布尔值，表示组件在调用 predict、predict_proba、transform 或 feature_importances 之前是否需要拟合。
`parameters`	返回用于初始化组件的参数。
`save`	将组件保存到文件路径。
`training_only`	返回此组件是仅应在训练时评估，还是在训练和预测时都应评估。
`update_parameters`	更新组件的参数字典。

clone(self)[source]#

构造一个具有相同参数和随机状态的新组件。

返回: 此组件的一个新实例，具有相同的参数和随机状态。

default_parameters(cls)#

返回此组件的默认参数。

我们的约定是 Component.default_parameters == Component().parameters。

返回: 此组件的默认参数。
返回类型: dict

describe(self, print_name=False, return_dict=False)[source]#

描述一个组件及其参数。

参数

print_name (bool, optional) – 是否打印组件名称
return_dict (bool, optional) – 是否以 {“name”: name, “parameters”: parameters} 的字典格式返回描述

返回

如果 return_dict 为 True，则返回字典，否则返回 None。

返回类型

None or dict

fit(self, X, y=None)[source]#

将组件拟合到数据。

参数

X (pd.DataFrame) – 输入训练数据，形状为 [n_samples, n_features]
y (pd.Series, optional) – 目标训练数据，长度为 [n_samples]

返回

self

引发

MethodPropertyNotFoundError – 如果组件没有 fit 方法或 component_obj 没有实现 fit 方法。

static load(file_path)[source]#

从文件路径加载组件。

参数: file_path (str) – 加载文件的位置。
返回: ComponentBase 对象

property modifies_features(cls)#

返回此组件在转换过程中是否修改（子集化或转换）特征变量。

对于 Estimator 对象，此属性决定了 predict 或 predict_proba 的返回值是否应作为特征或目标使用。

property modifies_target(cls)#

返回此组件在转换过程中是否修改（子集化或转换）目标变量。

对于 Estimator 对象，此属性决定了 predict 或 predict_proba 的返回值是否应作为特征或目标使用。

property name(cls)#: 返回此组件的字符串名称。

needs_fitting(self)#

返回一个布尔值，表示组件在调用 predict、predict_proba、transform 或 feature_importances 之前是否需要拟合。

对于不需要拟合或其 fit 方法不做任何事情的组件，此属性可以被覆盖为 False。

返回: True。

property parameters(self)#: 返回用于初始化组件的参数。

save(self, file_path, pickle_protocol=cloudpickle.DEFAULT_PROTOCOL)[source]#

将组件保存到文件路径。

参数

file_path (str) – 保存文件的位置。
pickle_protocol (int) – pickle 数据流格式。

property training_only(cls)#: 返回此组件是仅应在训练时评估，还是在训练和预测时都应评估。

update_parameters(self, update_dict, reset_fit=True)[source]#

更新组件的参数字典。

参数

update_dict (dict) – 要更新的参数字典。
reset_fit (bool, optional) – 如果为 True，将设置 _is_fitted 为 False。