ElasticEnsemble#

class ElasticEnsemble(distance_measures='all', proportion_of_param_options=1.0, proportion_train_in_param_finding=1.0, proportion_train_for_test=1.0, n_jobs=1, random_state=0, verbose=0, majority_vote=False)[source]#

弹性集成(EE)。

Elastic Ensemble (EE) 如 [1] 所述。

概述

  • 输入 n 个长度为 m 的序列

  • EE 是弹性最近邻分类器的集成

参数:
distance_measures字符串列表,可选(默认值=”all”)

一个字符串列表,用于指定要包含哪些距离度量。有效值是一个或多个:euclidean, dtw, wdtw, ddtw, dwdtw, lcss, erp, msm

proportion_of_param_options浮点数,可选(默认值=1)

要搜索的参数网格空间的比例,可选。

proportion_train_in_param_finding浮点数,可选(默认值=1)

在参数搜索中使用的训练集比例,可选。

proportion_train_for_test浮点数,可选(默认值=1)

在分类新案例时使用的训练集比例,可选。

n_jobs整数,可选(默认值=1)

用于并行运行 fitpredict 的作业数。-1 表示使用所有处理器。

random_state整数,默认值=0

随机种子。

verbose整数,默认值=0

如果 >0,则打印调试信息。

属性:
estimators_列表

一个存储所有分类器的列表

train_accs_by_classifierndarray

存储分类器的训练准确率

注意

..[1] Jason Lines 和 Anthony Bagnall,
“使用弹性距离度量集成进行时间序列分类”,

《数据挖掘与知识发现》(Data Mining and Knowledge Discovery),29(3),2015。

https://link.springer.com/article/10.1007/s10618-014-0361-2

示例

>>> from sktime.classification.distance_based import ElasticEnsemble
>>> from sktime.datasets import load_unit_test  
>>> X_train, y_train = load_unit_test(split="train")  
>>> X_test, y_test = load_unit_test(split="test")  
>>> clf = ElasticEnsemble(
...     proportion_of_param_options=0.1,
...     proportion_train_for_test=0.1,
...     distance_measures = ["dtw","ddtw"],
...     majority_vote=True,
... )  
>>> clf.fit(X_train, y_train)  
ElasticEnsemble(...)
>>> y_pred = clf.predict(X_test)  

方法

check_is_fitted([method_name])

检查评估器是否已拟合。

clone()

获取具有相同超参数和配置的对象的克隆。

clone_tags(estimator[, tag_names])

将其他对象的标签克隆为动态覆盖。

create_test_instance([parameter_set])

使用第一个测试参数集构造类的实例。

create_test_instances_and_names([parameter_set])

创建所有测试实例的列表及其名称列表。

fit(X, y)

使用训练数据拟合时间序列分类器。

fit_predict(X, y[, cv, change_state])

拟合并预测 X 中序列的标签。

fit_predict_proba(X, y[, cv, change_state])

拟合并预测 X 中序列的标签概率。

get_class_tag(tag_name[, tag_value_default])

从类中获取类标签值,并继承父类的标签级别。

get_class_tags()

从类中获取类标签,并继承父类的标签级别。

get_config()

获取自身的配置标志。

get_fitted_params([deep])

获取拟合参数。

get_metric_params()

返回使用的距离度量的参数。

get_param_defaults()

获取对象的默认参数。

get_param_names([sort])

获取对象的参数名称。

get_params([deep])

获取此对象的参数值字典。

get_tag(tag_name[, tag_value_default, ...])

从实例获取标签值,并包含标签级别的继承和覆盖。

get_tags()

从实例获取标签,并包含标签级别的继承和覆盖。

get_test_params([parameter_set])

返回评估器的测试参数设置。

is_composite()

检查对象是否由其他 BaseObjects 组成。

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

从序列化的内存容器加载对象。

predict(X)

预测 X 中序列的标签。

predict_proba(X)

预测 X 中序列的标签概率。

reset()

将对象重置到干净的初始化后状态。

save([path, serialization_format])

将序列化的对象保存到字节类对象或 (.zip) 文件中。

score(X, y)

根据 X 上的真实标签对预测标签进行评分。

set_config(**config_dict)

将配置标志设置为给定值。

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为自身设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

将实例级别标签覆盖设置为给定值。

get_metric_params()[source]#

返回使用的距离度量的参数。

check_is_fitted(method_name=None)[source]#

检查评估器是否已拟合。

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时,应将 is_fitted 属性设置为 True

如果不是,则引发 NotFittedError

参数:
method_name字符串,可选

调用此函数的方法的名称。如果提供,错误消息将包含此信息。

引发:
NotFittedError

如果评估器尚未拟合。

clone()[source]#

获取具有相同超参数和配置的对象的克隆。

克隆是一个没有共享引用,处于初始化后状态的不同对象。此函数等同于返回 sklearn.cloneself

等同于构造 type(self) 的新实例,使用 self 的参数,即 type(self)(**self.get_params(deep=False))

如果配置设置在 self 上,克隆也将具有与原始对象相同的配置,等同于调用 cloned_self.set_config(**self.get_config())

在值上,也等同于调用 self.reset,不同之处在于 clone 返回一个新对象,而不是像 reset 那样修改 self

引发:
如果克隆不符合要求,由于错误的 __init__,则会引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

将其他对象的标签克隆为动态覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会改变的静态标志。

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

clone_tags 方法只能在对象的 __init__ 方法中调用,在构造期间,或通过 __init__ 构造后直接调用。

动态标签被设置为 estimator 中标签的值,名称在 tag_names 中指定。

tag_names 的默认设置是将 estimator 中的所有标签写入 self

当前的标签值可以通过 get_tagsget_tag 查看。

参数:
estimator:class:BaseObject 或其派生类的实例
tag_names字符串或字符串列表,默认值 = None

要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

返回:
自身

self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

使用第一个测试参数集构造类的实例。

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则将返回 “default” 集。

返回:
instance带有默认参数的类实例
classmethod create_test_instances_and_names(parameter_set='default')[source]#

创建所有测试实例的列表及其名称列表。

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则将返回 “default” 集。

返回:
objscls 实例列表

第 i 个实例是 cls(**cls.get_test_params()[i])

namesstr 列表,与 objs 长度相同

第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定是 {cls.__name__}-{i},否则是 {cls.__name__}

fit(X, y)[source]#

使用训练数据拟合时间序列分类器。

状态变更

将状态更改为“已拟合”。

写入 self

将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype

用于拟合估计器的时间序列。

可以是 Panel scitype 的任何 mtype,例如:

  • pd-multiindex:pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引

  • numpy3D:3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他受支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

有关规范,请参阅 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多元或不等长序列的面板,详情请参阅标签参考

ysktime 兼容的表格数据容器,Table scitype

1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:
self对 self 的引用。
fit_predict(X, y, cv=None, change_state=True)[source]#

拟合并预测 X 中序列的标签。

生成样本内预测和交叉验证的样本外预测的便捷方法。

如果 change_state=True,则写入 self

将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

如果 change_state=False,则不更新状态。

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype

用于拟合和预测标签的时间序列。

可以是 Panel scitype 的任何 mtype,例如:

  • pd-multiindex:pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引

  • numpy3D:3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他受支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

有关规范,请参阅 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多元或不等长序列的面板,详情请参阅标签参考

ysktime 兼容的表格数据容器,Table scitype

1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

cvNone, int, 或 sklearn 交叉验证对象, 可选, default=None
  • None : 预测是样本内预测,等同于 fit(X, y).predict(X)

  • cv : 预测等同于 fit(X_train, y_train).predict(X_test),其中多个 X_trainy_trainX_testcv 折叠中获得。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须互不相交

  • int : 等同于 cv=KFold(cv, shuffle=True, random_state=x),即 K 折交叉验证的样本外预测,并且 random_state x 取自 self(如果存在),否则 x=None

change_statebool, 可选 (default=True)
  • 如果为 False,则不会更改分类器的状态,即使用副本运行 fit/predict 序列,self 不变

  • 如果为 True,则会将 self 拟合到完整的 X 和 y,结束状态将等同于运行 fit(X, y)

返回:
y_predsktime 兼容的表格数据容器,Table scitype

预测的类标签

1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。

1D np.npdarray,如果 y 是单变量(一维);否则,与 fit 中传入的 y 类型相同

fit_predict_proba(X, y, cv=None, change_state=True)[source]#

拟合并预测 X 中序列的标签概率。

生成样本内预测和交叉验证的样本外预测的便捷方法。

如果 change_state=True,则写入 self

将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。

如果 change_state=False,则不更新状态。

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype

用于拟合和预测标签的时间序列。

可以是 Panel scitype 的任何 mtype,例如:

  • pd-multiindex:pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引

  • numpy3D:3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他受支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

有关规范,请参阅 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多元或不等长序列的面板,详情请参阅标签参考

ysktime 兼容的表格数据容器,Table scitype

1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

cvNone, int, 或 sklearn 交叉验证对象, 可选, default=None
  • None : 预测是样本内预测,等同于 fit(X, y).predict(X)

  • cv : 预测等同于 fit(X_train, y_train).predict(X_test),其中多个 X_trainy_trainX_testcv 折叠中获得。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须互不相交

  • int : 等同于 cv=KFold(cv, shuffle=True, random_state=x),即 K 折交叉验证的样本外预测,并且 random_state x 取自 self(如果存在),否则 x=None

change_statebool, 可选 (default=True)
  • 如果为 False,则不会更改分类器的状态,即使用副本运行 fit/predict 序列,self 不变

  • 如果为 True,则会将 self 拟合到完整的 X 和 y,结束状态将等同于运行 fit(X, y)

返回:
y_pred2D np.array,int 类型,形状为 [n_instances, n_classes]

预测的类标签概率 第 0 个索引对应于 X 中的实例索引 第 1 个索引对应于类索引,顺序与 self.classes_ 中的相同 条目为预测的类概率,总和为 1

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类中获取类标签值,并继承父类的标签级别。

每个 scikit-base 兼容对象都有一个标签字典,用于存储关于对象的元数据。

get_class_tag 方法是一个类方法,它仅考虑类级别的标签值和覆盖来检索标签的值。

它返回具有名称 tag_name 的标签值,同时考虑标签覆盖,优先级从高到低如下:

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按照继承顺序。

不考虑在实例上通过 set_tagsclone_tags 设置的动态标签覆盖。

要检索可能包含实例覆盖的标签值,请使用 get_tag 方法。

参数:
tag_namestr

标签值的名称。

tag_value_default任意类型

如果未找到标签,则使用的默认/回退值。

返回:
tag_value

selftag_name 标签的值。如果未找到,则返回 tag_value_default

classmethod get_class_tags()[source]#

从类中获取类标签,并继承父类的标签级别。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会改变的静态标志。

get_class_tags 方法是一个类方法,它仅考虑类级别的标签值和覆盖来检索标签的值。

它返回一个字典,其键是类或其任何父类中设置的 _tags 属性的任何键。

值为相应的标签值,覆盖优先级从高到低如下:

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按照继承顺序。

实例可以根据超参数覆盖这些标签。

要检索可能包含实例覆盖的标签,请使用 get_tags 方法。

不考虑在实例上通过 set_tagsclone_tags 设置的动态标签覆盖。

要包含动态标签的覆盖,请使用 get_tags

collected_tagsdict

标签名 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不会被通过 set_tagsclone_tags 设置的动态标签覆盖。

get_config()[source]#

获取自身的配置标志。

配置是 self 的键值对,通常用作控制行为的瞬时标志。

get_config 返回动态配置,这些配置会覆盖默认配置。

默认配置在类或其父类的类属性 _config 中设置,并通过 set_config 设置的动态配置来覆盖。

配置在 clonereset 调用中保留。

返回:
config_dictdict

配置名称 : 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool, default=True

是否返回组件的已拟合参数。

  • 如果为 True,则返回此对象的参数名称 : 值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。

  • 如果为 False,则返回此对象的参数名称 : 值字典,但不包括组件的已拟合参数。

返回:
fitted_params键为 str 类型的字典

已拟合参数的字典,键值对为 paramname : paramvalue 包括

  • 始终:此对象的所有已拟合参数,通过 get_param_names 获取,值为此对象对应键的已拟合参数值

  • 如果 deep=True,还包含组件参数的键值对,组件的参数索引为 [componentname]__[paramname]componentname 的所有参数显示为 paramname 及其值

  • 如果 deep=True,还包含任意级别的组件递归,例如 [componentname]__[componentcomponentname]__[paramname]

classmethod get_param_defaults()[source]#

获取对象的参数默认值。

返回:
default_dict: dict[str, Any]

键是 cls 中在 __init__ 中定义了默认值的所有参数。值是默认值,如 __init__ 中所定义。

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

参数:
sortbool, default=True

是否按字母顺序排序返回参数名称 (True),或按它们在类的 __init__ 中出现的顺序返回 (False)。

返回:
param_names: list[str]

cls 的参数名称列表。如果 sort=False,则按它们在类的 __init__ 中出现的顺序排列。如果 sort=True,则按字母顺序排列。

get_params(deep=True)[source]#

获取此对象的参数值字典。

参数:
deepbool, default=True

是否返回组件的参数。

  • 如果为 True,将返回此对象的参数名称 : 值 dict,包括组件(= BaseObject 值参数)的参数。

  • 如果为 False,将返回此对象的参数名称 : 值 dict,但不包括组件的参数。

返回:
params键为 str 类型的字典

参数字典,键值对为 paramname : paramvalue 包括

  • 始终:此对象的所有参数,通过 get_param_names 获取,值为此对象对应键的参数值,值始终与构造时传入的值相同

  • 如果 deep=True,还包含组件参数的键值对,组件的参数索引为 [componentname]__[paramname]componentname 的所有参数显示为 paramname 及其值

  • 如果 deep=True,还包含任意级别的组件递归,例如 [componentname]__[componentcomponentname]__[paramname]

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

从实例获取标签值,并包含标签级别的继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会改变的静态标志。

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值,同时考虑标签覆盖,优先级从高到低如下:

  1. 在实例上通过 set_tagsclone_tags 设置的标签,

在实例构造时设置的标签。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按照继承顺序。

参数:
tag_namestr

要检索的标签名称

tag_value_default任意类型, 可选; default=None

如果未找到标签,则使用的默认/回退值

raise_errorbool

未找到标签时是否引发 ValueError

返回:
tag_valueAny

selftag_name 标签的值。如果未找到,则在 raise_error 为 True 时引发错误,否则返回 tag_value_default

引发:
ValueError, 如果 raise_errorTrue

如果 tag_name 不在 self.get_tags().keys() 中,则会引发 ValueError

get_tags()[source]#

从实例获取标签,并包含标签级别的继承和覆盖。

每个 scikit-base 兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。

标签是特定于实例 self 的键值对,它们是对象构造后不会改变的静态标志。

get_tags 方法返回标签字典,其键是类或其任何父类中设置的 _tags 属性的任何键,或通过 set_tagsclone_tags 设置的标签。

值为相应的标签值,覆盖优先级从高到低如下:

  1. 在实例上通过 set_tagsclone_tags 设置的标签,

在实例构造时设置的标签。

  1. 在类的 _tags 属性中设置的标签。

  2. 在父类的 _tags 属性中设置的标签,

按照继承顺序。

返回:
collected_tagsdict

标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集,然后是来自 _tags_dynamic 对象属性的任何覆盖和新标签。

classmethod get_test_params(parameter_set='default')[source]#

返回评估器的测试参数设置。

参数:
parameter_setstr, default=”default”

要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 "default" 集。对于分类器,应提供一组“默认”参数用于一般测试,以及一组“results_comparison”参数用于与先前记录的结果进行比较,如果一般参数集未产生适合比较的概率。

返回:
paramsdict 或 list of dict, default={}

用于创建类测试实例的参数。每个 dict 都是构造一个“有趣”测试实例的参数,即 MyClass(**params)MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典。

is_composite()[source]#

检查对象是否由其他 BaseObjects 组成。

复合对象是作为参数包含其他对象的对象。在实例上调用,因为这可能因实例而异。

返回:
composite: bool

对象是否包含任何值为 BaseObject 后代实例的参数。

property is_fitted[source]#

是否已调用 fit

检查对象的 _is_fitted` 属性,该属性在对象构造期间应初始化为 ``False,并在调用对象的 fit 方法时设置为 True。

返回:
bool

估计器是否已 fit(拟合)。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
反序列化的 self,结果为 cls.save(path)path 处输出
classmethod load_from_serial(serial)[source]#

从序列化的内存容器加载对象。

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的 self,结果为 cls.save(None) 的输出 serial
predict(X)[source]#

预测 X 中序列的标签。

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype

用于预测标签的时间序列。

可以是 Panel scitype 的任何 mtype,例如:

  • pd-multiindex:pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引

  • numpy3D:3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他受支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

有关规范,请参阅 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多元或不等长序列的面板,详情请参阅标签参考

返回:
y_predsktime 兼容的表格数据容器,Table scitype

预测的类标签

1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。

第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。

1D np.npdarray,如果 y 是单变量(一维);否则,与 fit 中传入的 y 类型相同

predict_proba(X)[source]#

预测 X 中序列的标签概率。

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype

用于预测标签的时间序列。

可以是 Panel scitype 的任何 mtype,例如:

  • pd-multiindex:pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引

  • numpy3D:3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他受支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

有关规范,请参阅 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多元或不等长序列的面板,详情请参阅标签参考

返回:
y_pred2D np.array,int 类型,形状为 [n_instances, n_classes]

预测的类标签概率,第 0 个索引对应于 X 中的实例索引,第 1 个索引对应于类索引,顺序与 self.classes_ 中的相同,条目为预测的类概率,总和为 1

reset()[source]#

将对象重置到干净的初始化后状态。

self 设置为其在调用构造函数后直接处于的状态,并保留相同的超参数。通过 set_config 设置的配置值也会保留。

一个 reset 调用会删除所有对象属性,除了

  • 超参数 = __init__ 的参数,写入到 self 中,例如 self.paramname,其中 paramname__init__ 的参数

  • 包含双下划线(即字符串“__”)的对象属性。例如,名为“__myattr”的属性会被保留。

  • 配置属性,配置保持不变。也就是说,reset 前后 get_config 的结果是相等的。

类和对象方法以及类属性也不受影响。

等同于 clone,不同之处在于 reset 会修改 self 而不是返回一个新对象。

调用 self.reset() 后,self 在值和状态上都等于构造函数调用 type(self)(**self.get_params(deep=False)) 后获得的对象。

返回:
自身

类实例重置为干净的初始化后状态,但保留当前的超参数值。

save(path=None, serialization_format='pickle')[source]#

将序列化的对象保存到字节类对象或 (.zip) 文件中。

行为:如果 path 为 None,则返回一个内存中的序列化 self;如果 path 是文件位置,则将 self 以 zip 文件形式存储在该位置

保存的文件是包含以下内容的 zip 文件:_metadata - 包含 self 的类,即 type(self) _obj - 序列化的 self。此类使用默认序列化(pickle)。

参数:
pathNone 或文件位置 (str 或 Path)

如果为 None,则将 self 保存到内存中的对象 如果是文件位置,则将 self 保存到该文件位置。如果

  • path="estimator",则会在当前工作目录生成一个 zip 文件 estimator.zip

  • path="/home/stored/estimator",则会在 /home/stored/

存储一个 zip 文件 estimator.zip

serialization_format: str, default = “pickle”

用于序列化的模块。可选选项为“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 为文件位置 - ZipFile 指向该文件
score(X, y) float[source]#

根据 X 上的真实标签对预测标签进行评分。

参数:
Xsktime 兼容的时间序列面板数据容器,Panel scitype

用于预测标签评分的时间序列。

可以是 Panel scitype 的任何 mtype,例如:

  • pd-multiindex:pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引

  • numpy3D:3D np.array(任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]

  • 或任何其他受支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

有关规范,请参阅 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持多元或不等长序列的面板,详情请参阅标签参考

ysktime 兼容的表格数据容器,Table scitype

1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions] 用于拟合的类标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引 支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame

返回:
float, predict(X) 与 y 相比的准确率得分
set_config(**config_dict)[source]#

将配置标志设置为给定值。

参数:
config_dictdict

配置名称 : 配置值对的字典。有效的配置、值及其含义列于下方

displaystr, “diagram” (default), 或 “text”

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串打印输出

print_changed_onlybool, default=True

打印 self 时是否只列出与默认值不同的 self 参数 (False),或所有参数名称和值 (False)。不进行嵌套,即只影响 self 而不影响组件估计器。

warningsstr, “on” (default), 或 “off”

是否引发警告,仅影响来自 sktime 的警告

  • “on” = 将引发来自 sktime 的警告

  • “off” = 不会引发来自 sktime 的警告

backend:parallelstr, 可选, default=”None”

广播/向量化时用于并行化的后端,以下之一:

  • “None”: 顺序执行循环,简单的列表推导式

  • “loky”、“multiprocessing”和“threading”: 使用 joblib.Parallel

  • “joblib”: 自定义和第三方 joblib 后端,例如 spark

  • “dask”: 使用 dask,需要在环境中安装 dask

  • “ray”: 使用 ray,需要在环境中安装 ray

backend:parallel:paramsdict, 可选, default={} (不传递参数)

作为配置传递给并行化后端的附加参数。有效键取决于 backend:parallel 的值

  • “None”: 没有附加参数,backend_params 被忽略

  • “loky”、“multiprocessing”和“threading”: 默认的 joblib 后端,可以传递 joblib.Parallel 的任何有效键,例如 n_jobs,除了由 backend 直接控制的 backend。如果未传递 n_jobs,则默认为 -1,其他参数将默认为 joblib 的默认值。

  • “joblib”: 自定义和第三方 joblib 后端,例如 spark。可以传递 joblib.Parallel 的任何有效键,例如 n_jobs,在这种情况下,backend 必须作为 backend_params 的键传递。如果未传递 n_jobs,则默认为 -1,其他参数将默认为 joblib 的默认值。

  • “dask”: 可以传递 dask.compute 的任何有效键,例如 scheduler

  • “ray”: 可以传递以下键

    • “ray_remote_args”: ray.init 的有效键的字典

    • “shutdown_ray”: bool, default=True; False 会阻止 ray

      在并行化后关闭。

    • “logger_name”: str, default=”ray”; 要使用的日志记录器名称。

    • “mute_warnings”: bool, default=False; 如果为 True,则抑制警告

返回:
self对 self 的引用。

注意

改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象和复合对象。参数键字符串 <component>__<parameter> 可用于复合对象(即包含其他对象的对象)来访问组件 <component> 中的 <parameter>。如果不带 <component>__ 的字符串 <parameter> 引用不含糊(例如,没有两个组件参数具有相同的名称 <parameter>),也可以使用它。

参数:
**paramsdict

BaseObject 参数,键必须是 <component>__<parameter> 字符串。__ 后缀如果对 get_params 的键来说是唯一的,则可以作为完整字符串的别名。

返回:
self对 self 的引用(设置参数后)
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为自身设置 random_state 伪随机种子参数。

通过 self.get_params 查找名为 random_state 的参数,并通过 set_params 将它们设置为从 random_state 派生的整数,派生方式是通过 sample_dependent_seed 的链式哈希。这些整数保证了伪随机独立性,适用于有种子的随机生成器。

根据 self_policy,适用于 self 中的 random_state 参数,并且当且仅当 deep=True 时适用于剩余的组件对象。

注意:即使 self 没有 random_state 参数,或者组件中没有任何 random_state 参数,也会调用 set_params。因此,set_random_state 将重置任何 scikit-base 对象,即使是那些没有 random_state 参数的对象。

参数:
random_stateint, RandomState 实例或 None, default=None

伪随机数生成器,用于控制随机整数的生成。传入 int 以在多次函数调用中获得可重现的输出。

deepbool, default=True

是否在 skbase 对象值参数(即组件估计器)中设置随机状态。

  • 如果为 False,则仅设置 selfrandom_state 参数(如果存在)。

  • 如果为 True,则同时设置组件对象中的 random_state 参数。

self_policystr, {“copy”, “keep”, “new”} 之一, default=”copy”
  • “copy” : self.random_state 设置为输入 random_state

  • “keep” : 保持 self.random_state 不变

  • “new” : self.random_state 设置为从输入

random_state 派生出的新随机状态,通常与输入不同

返回:
self对 self 的引用
set_tags(**tag_dict)[source]#

将实例级别标签覆盖设置为给定值。

每个 scikit-base 兼容对象都有一个标签字典,用于存储关于对象的元数据。

标签是特定于实例 self 的键值对,它们是静态标志,在对象构造后不会更改。它们可用于元数据检查或控制对象的行为。

set_tags 将动态标签覆盖设置为 tag_dict 中指定的值,键是标签名称,字典值是要将标签设置成的值。

set_tags 方法应仅在对象的 __init__ 方法中(构造期间)或通过 __init__ 直接调用后使用。

当前的标签值可以通过 get_tagsget_tag 查看。

参数:
**tag_dictdict

标签名称 : 标签值对的字典。

返回:
Self

对 self 的引用。