base_sampler#

基础采样器组件。用作所有采样器组件的基类。

模块内容#

类概要#

BaseSampler

基础采样器组件。用作所有采样器组件的基类。

内容#

class evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler(parameters=None, component_obj=None, random_seed=0, **kwargs)[源码]#

基础采样器组件。用作所有采样器组件的基类。

参数

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

属性

modifies_features	True
modifies_target	True
training_only	True

方法

`clone`	使用相同的参数和随机状态构建新组件。
`default_parameters`	返回此组件的默认参数。
`describe`	描述组件及其参数。
`fit`	使采样器适应数据。
`fit_transform`	使用采样器组件拟合和转换数据。
`load`	从文件路径加载组件。
`name`	返回此组件的字符串名称。
`needs_fitting`	返回布尔值，确定组件在调用 predict、predict_proba、transform 或 feature_importances 之前是否需要拟合。
`parameters`	返回用于初始化组件的参数。
`save`	将组件保存到文件路径。
`transform`	通过对数据进行采样来转换输入数据。
`update_parameters`	更新组件的参数字典。

clone(self)#

使用相同的参数和随机状态构建新组件。

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

default_parameters(cls)#

返回此组件的默认参数。

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

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

describe(self, print_name=False, return_dict=False)#

描述组件及其参数。

参数

print_name (bool, optional) – 是否打印组件名称
return_dict (bool, optional) – 是否将描述作为字典返回，格式为 {"name": name, "parameters": parameters}

返回

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

返回类型

None or dict

fit(self, X, y)[源码]#

使采样器适应数据。

参数

X (pd.DataFrame) – 输入特征。
y (pd.Series) – 目标。

返回

self

抛出

ValueError – 如果 y 为 None。

fit_transform(self, X, y)[源码]#

使用采样器组件拟合和转换数据。

参数

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

返回

转换后的数据。

返回类型

(pd.DataFrame, pd.Series)

static load(file_path)#

从文件路径加载组件。

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

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

needs_fitting(self)#

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

对于不需要拟合或其拟合方法不起作用的组件，可以将其覆盖为 False。

返回: True。

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

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

将组件保存到文件路径。

参数

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

transform(self, X, y)[源码]#

通过对数据进行采样来转换输入数据。

参数

X (pd.DataFrame) – 训练特征。
y (pd.Series) – 目标。

返回

转换后的特征和目标。

返回类型

pd.DataFrame, pd.Series

update_parameters(self, update_dict, reset_fit=True)#

更新组件的参数字典。

参数

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