BOSSEnsemble#
- class BOSSEnsemble(threshold=0.92, max_ensemble_size=500, max_win_len_prop=1, min_window=10, save_train_predictions=False, feature_selection='none', use_boss_distance=True, alphabet_size=2, n_jobs=1, random_state=None)[source]#
符号傅里叶近似符号包 (BOSS) 集成。
Schäfer (2015) 提出的 BOSS 集成的实现。[1]
概述:输入长度为 m 的 n 个时间序列,BOSS 对一组参数值执行网格搜索,使用 LOOCV 评估每个参数。然后默认保留所有性能在最佳参数 92% 以内的集成成员用于集成。有三个主要参数:
`alpha`:字母表大小
`w`:窗口长度
`l`:词长度。
对于任何组合,单个 BOSS 沿时间序列滑动一个长度为 `w` 的窗口。通过进行傅里叶变换并保留前 `l/2` 个复数系数,将长度为 `w` 的窗口缩短为长度为 `l` 的词。然后将这些 `l` 个系数离散化为 `alpha` 个可能的值,形成一个长度为 `l` 的词。为每个时间序列形成并存储一个词直方图。
拟合涉及寻找“n”个直方图。
预测使用 1 最近邻和定制的 BOSS 距离函数。
- 参数:
- thresholdfloat, default=0.92
用于确定保留哪些分类器的阈值。保留所有性能在最佳分类器
threshold
百分比内的分类器。- max_ensemble_sizeint or None, default=500
保留的最大分类器数量。即使超过
max_ensemble_size
的分类器在阈值范围内,也会限制保留的分类器数量。- max_win_len_propint or float, default=1
作为时间序列长度比例的最大窗口长度。
- min_windowint, default=10
最小窗口大小。
- save_train_predictionsbool, default=False
在拟合时保存集成成员的训练预测,以便在 _get_train_probs 留一法交叉验证中使用。
- alphabet_sizedefault = 2
每个词可能的字母(值)数量。
- n_jobsint, default=1
fit
和predict
并行运行的作业数量。-1
表示使用所有处理器。- use_boss_distanceboolean, default=True
Boss 距离是一种非对称距离度量。它提供更高的准确性,但计算速度明显较慢。
- feature_selection: {"chi2", "none", "random"}, default: none
设置要使用的特征选择策略。Chi2 显著减少了词的数量,因此速度更快(首选)。Random 也显著减少了数量。None 不应用特征选择,会产生大量的词,例如可能需要大量内存。
- random_stateint or None, default=None
随机种子,整数。
- 属性:
- n_classes_int
类别数量。从数据中提取。
- classes_list
类别标签。
- n_instances_int
实例数量。从数据中提取。
- n_estimators_int
使用的最终分类器数量。如果指定了
max_ensemble_size
,则将 <=max_ensemble_size
。- series_length_int
所有时间序列的长度(假定相等)。
- estimators_list
DecisionTree 分类器列表。
注意
对于 Java 版本,请参阅 - Original Publication. - TSML.
参考文献
[1]Patrick Schäfer, “The BOSS is concerned with time series classification in the presence of noise”, Data Mining and Knowledge Discovery, 29(6): 2015 https://link.springer.com/article/10.1007/s10618-014-0377-7
示例
>>> from sktime.classification.dictionary_based import BOSSEnsemble >>> from sktime.datasets import load_unit_test >>> X_train, y_train = load_unit_test(split="train", return_X_y=True) >>> X_test, y_test = load_unit_test(split="test", return_X_y=True) >>> clf = BOSSEnsemble(max_ensemble_size=3) >>> clf.fit(X_train, y_train) BOSSEnsemble(...) >>> 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_fitted_params
([deep])获取已拟合的参数。
获取对象的参数默认值。
get_param_names
([sort])获取对象的参数名称。
get_params
([deep])获取此对象的参数值字典。
get_tag
(tag_name[, tag_value_default, ...])从实例中获取标签值,具有标签层级继承和覆盖。
get_tags
()从实例中获取标签,具有标签层级继承和覆盖。
get_test_params
([parameter_set])返回估计器的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
(X)预测 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)将实例级别的标签覆盖设置为给定值。
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则将返回
"default"
集。对于分类器,应提供一组“default”参数用于一般测试,如果一般集未产生适合比较的概率,则应提供一组“results_comparison”参数用于与先前记录的结果进行比较。
- 返回值:
- paramsdict or list of dict, default={}
用于创建类测试实例的参数。每个 dict 是用于构建“有趣”测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,is_fitted
属性应设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, optional
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个没有共享引用且处于初始化后状态的不同对象。此函数等同于返回
sklearn.clone
的self
。等同于构造一个
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_tags
或get_tag
检查。- 参数:
- estimator:class:BaseObject 或派生类的实例
- tag_namesstr 或 list of str, default = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回值:
- self
对
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.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,Scitype 为 Panel
用于拟合估计器的时间序列。
可以是
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 兼容的表格数据容器,Scitype 为 Table
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类别标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引,支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回值:
- self对自身的引用。
- fit_predict(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中时间序列的标签。
方便的方法,用于生成样本内预测和交叉验证的样本外预测。
- 写入自身,如果 change_state=True
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,Scitype 为 Panel
用于拟合和预测标签的时间序列。
可以是
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 兼容的表格数据容器,Scitype 为 Table
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类别标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引,支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- cvNone, int, or sklearn cross-validation object, optional, default=None
None : 预测为样本内预测,等同于
fit(X, y).predict(X)
cv : 预测等同于
fit(X_train, y_train).predict(X_test)
,其中多个X_train
,y_train
,X_test
从cv
折叠获得。返回的y
是所有测试折叠预测的并集,cv
测试折叠必须不相交int : 等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即样本外 k 折交叉验证预测,其中random_state
x
取自self
如果存在,否则x=None
- change_statebool, optional (default=True)
如果为 False,则不会更改分类器的状态,即拟合/预测序列使用副本运行,自身不改变
如果为 True,则将自身拟合到完整的 X 和 y,结束状态将等同于运行 fit(X, y)
- 返回值:
- y_predsktime 兼容的表格数据容器,Scitype 为 Table scitype
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。
1D np.npdarray,如果 y 为单变量(一维);否则,与拟合中传入的 y 类型相同
- fit_predict_proba(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中时间序列的标签概率。
方便的方法,用于生成样本内预测和交叉验证的样本外预测。
- 写入自身,如果 change_state=True
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,Scitype 为 Panel
用于拟合和预测标签的时间序列。
可以是
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 兼容的表格数据容器,Scitype 为 Table
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类别标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引,支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- cvNone, int, or sklearn cross-validation object, optional, default=None
None : 预测为样本内预测,等同于
fit(X, y).predict(X)
cv : 预测等同于
fit(X_train, y_train).predict(X_test)
,其中多个X_train
,y_train
,X_test
从cv
折叠获得。返回的y
是所有测试折叠预测的并集,cv
测试折叠必须不相交int : 等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即样本外 k 折交叉验证预测,其中random_state
x
取自self
如果存在,否则x=None
- change_statebool, optional (default=True)
如果为 False,则不会更改分类器的状态,即拟合/预测序列使用副本运行,自身不改变
如果为 True,则将自身拟合到完整的 X 和 y,结束状态将等同于运行 fit(X, y)
- 返回值:
- y_pred2D np.array of int, of shape [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
的标签值,考虑标签覆盖,按优先级递减的顺序如下:在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
不考虑实例上通过
set_tags
或clone_tags
设置的动态标签覆盖,这些覆盖定义在实例上。要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。- 参数:
- tag_namestr
标签值的名称。
- tag_value_defaultany type
未找到标签时的默认/回退值。
- 返回值:
- tag_value
self
中tag_name
标签的值。如果未找到,则返回tag_value_default
。
- classmethod get_class_tags()[source]#
从类中获取类标签,继承自父类的标签层级。
每个
scikit-base
兼容对象都包含一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。get_class_tags
方法是一个类方法,它考虑仅类级别的标签值和覆盖来检索标签的值。它返回一个字典,其键是类或其任何父类中设置的任何
_tags
属性的键。值是对应的标签值,覆盖按优先级递减的顺序如下:
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
实例可以根据超参数覆盖这些标签。
要检索可能包含实例覆盖的标签,请改用
get_tags
方法。不考虑实例上通过
set_tags
或clone_tags
设置的动态标签覆盖,这些覆盖定义在实例上。要包含动态标签的覆盖,请使用
get_tags
。- collected_tagsdict
标签名称 : 标签值对字典。通过嵌套继承从
_tags
类属性收集。不被set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取自身的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,它会覆盖默认配置。默认配置在类或其父类的
_config
类属性中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。- 返回值:
- config_dictdict
配置名称 : 配置值对字典。通过嵌套继承从 _config 类属性收集,然后应用 _onfig_dynamic 对象属性中的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合的参数。
- 所需状态
需要状态为“已拟合”。
- 参数:
- deepbool, default=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名称 : 值字典,包括可拟合组件(= BaseEstimator 类型参数)的已拟合参数。
如果为 False,将返回此对象的参数名称 : 值字典,但不包括组件的已拟合参数。
- 返回值:
- fitted_paramsdict with str-valued keys
已拟合参数字典,键为参数名,值为参数值,键值对包括:
始终:此对象的所有已拟合参数,如同通过
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
,但不包括组件的参数。
- 返回值:
- paramsdict with str-valued keys
参数字典,键为参数名,值为参数值,键值对包括:
始终:此对象的所有参数,如同通过
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
的单个标签的值,考虑标签覆盖,按优先级递减的顺序如下:在实例构造时,通过
set_tags
或clone_tags
在实例上设置的标签。
标签名,要检索的标签
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
tag_value_defaultany type, optional; default=None
- 未找到标签时的默认/回退值
raise_errorbool
- 未找到标签时是否引发
ValueError
tag_valueAny
- 返回值:
self
中tag_name
标签的值。如果未找到,则在raise_error
为 True 时引发错误,否则返回tag_value_default
。ValueError,如果
raise_error
为True
。
- 引发:
-
get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的任何_tags
属性的键,或通过set_tags
或clone_tags
设置的标签。 从实例中获取标签,具有标签层级继承和覆盖。
每个
scikit-base
兼容对象都包含一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。collected_tagsdict
值是对应的标签值,覆盖按优先级递减的顺序如下:
在实例构造时,通过
set_tags
或clone_tags
在实例上设置的标签。
标签名,要检索的标签
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序。
- 复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
检查对象是否由其他 BaseObject 组成。
composite: bool
-
是否已调用
fit
。 检查对象的
_is_fitted` 属性,该属性应在对象构造期间初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。bool
- serialZipFile(path).open(“object”) 的结果
从文件位置加载对象。
-
serial
cls.save(None)
输出的第一个元素 从序列化内存容器加载对象。
- 用于预测标签的时间序列。
预测 X 中时间序列的标签。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,Scitype 为 Panel
-
可以是
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 兼容的表格数据容器,Scitype 为 Table scitype
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。
1D np.npdarray,如果 y 为单变量(一维);否则,与拟合中传入的 y 类型相同
- 预测的类别标签概率,第 0 个索引对应于 X 中的实例索引,第 1 个索引对应于类别索引,顺序与 self.classes_ 中的顺序相同,条目是预测的类别概率,总和为 1
预测 X 中时间序列的标签概率。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,Scitype 为 Panel
-
可以是
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
并非所有估计器都支持具有多变量或不等长序列的面板,详见标签参考。
- 返回值:
-
导致将
self
设置为其在构造函数调用后立即具有的状态,具有相同的超参数。通过set_config
设置的配置值也保留。 将对象重置到干净的初始化后状态。
reset
调用会删除任何对象属性,除了:超参数 = 写入
self
的__init__
参数,例如self.paramname
其中paramname
是__init__
的参数包含双下划线的对象属性,即字符串 "__"。例如,名为 "__myattr" 的属性被保留。
配置属性,配置保持不变。也就是说,
reset
前后get_config
的结果是相同的。类和对象方法以及类属性也不受影响。
等同于
clone
,不同之处在于reset
修改self
而非返回一个新对象。在
self.reset()
调用后,self
在值和状态上等同于构造函数调用 ``type(self)(**
self.get_params(deep=False))`` 后获得的对象。类实例重置为干净的初始化后状态,但保留当前的超参数值。
-
行为:如果
path
为 None,则返回一个内存中的序列化自身;如果path
是文件位置,则将自身以 zip 文件形式存储在该位置 将序列化的自身保存到类字节对象或 (.zip) 文件。
保存的文件是 zip 文件,包含以下内容: _metadata - 包含自身的类,即 type(self) _obj - 序列化的自身。此类使用默认序列化 (pickle)。
pathNone or file location (str or Path)
- 参数:
- 如果为 None,则将自身保存到内存对象;如果为文件位置,则将自身保存到该文件位置。如果
path="estimator",则将在当前工作目录创建一个名为
estimator.zip
的 zip 文件。path="/home/stored/estimator",则一个名为
estimator.zip
的 zip 文件将存储在
/home/stored/
中。
serialization_format: str, default = “pickle”
- 用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
如果
path
为 None - 内存中的序列化自身
- 返回值:
- 用于评估预测标签的时间序列。
根据 X 上预测的标签评估真实标签的得分。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,Scitype 为 Panel
float, predict(X) 与 y 的准确率得分
可以是
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 兼容的表格数据容器,Scitype 为 Table
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类别标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引,支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回值:
- 配置名称 : 配置值对字典。下面列出了有效的配置、值及其含义
将配置标志设置为给定值。
- 参数:
- config_dictdict
displaystr, “diagram” (默认), or “text”
- jupyter 内核如何显示自身的实例
“diagram” = html 框图表示
“text” = 字符串输出
print_changed_onlybool, default=True
- 打印自身时是否只列出与默认值不同的自身参数 (False),或者所有参数名称和值 (False)。不嵌套,即仅影响自身,不影响组件估计器。
warningsstr, “on” (默认), or “off”
- 是否发出警告,仅影响来自 sktime 的警告
“on” = 将发出来自 sktime 的警告
“off” = 将不发出来自 sktime 的警告
backend:parallelstr, optional, default=”None”
- 广播/矢量化时用于并行的后端,选项之一:
“None”: 顺序执行循环,简单的列表推导式
“loky”, “multiprocessing” 和 “threading”: 使用
joblib.Parallel
“joblib”: 自定义和第三方
joblib
后端,例如spark
“dask”: 使用
dask
,需要在环境中安装dask
包“ray”: 使用
ray
,需要在环境中安装ray
包backend:parallel:paramsdict, optional, default={} (no parameters passed)
- 作为配置传递给并行后端的可选额外参数。有效的键取决于
backend:parallel
的值 “None”: 没有额外参数,
backend_params
被忽略“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”:布尔值,默认为 True;False 会阻止
ray
在并行化后 关闭。
- “shutdown_ray”:布尔值,默认为 True;False 会阻止
“logger_name”:字符串,默认为“ray”;要使用的日志记录器名称。
“mute_warnings”:布尔值,默认为 False;如果为 True,则抑制警告
- 返回值:
- self对自身的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的
skbase
对象以及复合对象。对于复合对象(即包含其他对象的对象),可以使用参数键字符串<component>__<parameter>
来访问组件<component>
中的<parameter>
。如果引用清晰无歧义(例如,没有两个组件参数同名为<parameter>
),则也可以使用字符串<parameter>
,不带<component>__
。- 参数:
- **params字典
BaseObject
参数,键必须是<component>__<parameter>
字符串。__
后缀如果相对于get_params
键是唯一的,则可以作为完整字符串的别名。
- 返回值:
- 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_state整数,RandomState 实例或 None,默认为 None
用于控制随机整数生成的伪随机数生成器。传入整数可在多次函数调用中获得可复现的输出。
- deepbool, default=True
是否在
skbase
对象值参数中设置随机状态,即组件估计器。如果为 False,则只设置
self
的random_state
参数(如果存在)。如果为 True,则也会在组件对象中设置
random_state
参数。
- self_policy字符串,{"copy", "keep", "new"} 之一,默认为 "copy"
“copy”:
self.random_state
设置为输入的random_state
“keep”:
self.random_state
保持不变“new”:
self.random_state
设置为一个新的随机状态,
由输入的
random_state
派生,通常与输入不同。
- 返回值:
- self对自身的引用
- set_tags(**tag_dict)[source]#
将实例级别的标签覆盖设置为给定值。
每个
scikit-base
兼容对象都包含一个标签字典,用于存储关于对象的元数据。标签是特定于实例
self
的键值对,它们是对象构造后不会改变的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中、构造期间或通过__init__
直接构造后调用。当前标签值可通过
get_tags
或get_tag
检查。- 参数:
- **tag_dict字典
标签名称:标签值 对的字典。
- 返回值:
- 自身
对自身的引用。