IndividualBOSS#

class IndividualBOSS(window_size=10, word_length=8, norm=False, alphabet_size=2, save_words=False, typed_dict='deprecated', use_boss_distance=True, feature_selection='none', n_jobs=1, random_state=None)[source]#

单个符号傅里叶近似符号包 (IndividualBOSS)。

SFA 符号包集成:单个 BOSS Schaffer 的实现,它是 BOSS 集成的基础分类器。

实现 Schäfer (2015) 的单个 BOSS 模型。 [1]

这是 BOSS 集成中每个分类器的底层分类器。

概述:输入长度为“m”的“n”个序列,IndividualBoss 执行 SFA 变换以形成离散化词的稀疏字典。结果字典与 BOSS 距离函数一起用于 1-最近邻分类。

Fit 过程涉及找到“n”个直方图。

Predict 使用 1-最近邻算法和定制的 BOSS 距离函数。

参数:
window_sizeint

在 BOSS 算法中使用的窗口大小。

word_lengthint

在 BOSS 算法中使用的词长度。

normbool, 默认为 False

是否通过丢弃第一个傅里叶系数来标准化词。

alphabet_size默认为 2

每个词可能字母(值)的数量。

save_wordsbool, 默认为 True

即使在返回词典后,是否在 SFA 变换中保留词的 NumPy 数组。如果为 True,则保存数组,这可以缩短使用较短的 word_length 计算词典的时间(因为可以移除最后的“n”个字母)。

n_jobsint, 默认为 1

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

random_stateint 或 None, 默认为 None

随机种子,整数。

属性:
n_classes_int

类别数量。从数据中提取。

classes_list

类别标签。

说明

有关 Java 版本,请参阅 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 IndividualBOSS
>>> 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 = IndividualBOSS() 
>>> clf.fit(X_train, y_train) 
IndividualBOSS(...)
>>> 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()

获取 self 的配置标志。

get_fitted_params([deep])

获取已拟合参数。

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])

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

score(X, y)

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是,则引发 NotFittedError

参数:
method_namestr, 可选

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

引发:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等效于使用 self 的参数构造一个 type(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 设置动态标签覆盖。

应仅在对象的 __init__ 方法中、构造期间或通过 __init__ 构造后直接调用 clone_tags 方法。

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

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

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

参数:
estimator:class:BaseObject 或派生类的实例
tag_namesstr 或 str 列表, 默认为 None

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

返回:
self

self 的引用。

classmethod create_test_instance(parameter_set=default)[source]#

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

参数:
parameter_setstr, 默认为“default”

要返回的测试参数集的名称,用于测试。如果未为值定义特殊参数,将返回 “default” 集。

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

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

参数:
parameter_setstr, 默认为“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 交叉验证对象, 可选, 默认为 None
  • None : 预测是样本内预测,等效于 fit(X, y).predict(X)

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

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

change_statebool, 可选 (默认为 True)
  • 如果为 False,则不会改变分类器的状态,即拟合/预测序列使用副本运行,self 不改变

  • 如果为 True,将用完整的 X 和 y 拟合 self,最终状态将等效于运行 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 交叉验证对象, 可选, 默认为 None
  • None : 预测是样本内预测,等效于 fit(X, y).predict(X)

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

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

change_statebool, 可选 (默认为 True)
  • 如果为 False,则不会改变分类器的状态,即拟合/预测序列使用副本运行,self 不改变

  • 如果为 True,将用完整的 X 和 y 拟合 self,最终状态将等效于运行 fit(X, y)

返回:
y_pred2D np.array of 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

tag_name 标签在 self 中的值。如果未找到,则返回 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 的配置标志。

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

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

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

clonereset 调用下保留配置。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool, 默认为 True

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

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

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

返回:
fitted_paramsstr 值键的 dict

已拟合参数字典,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, 默认为 True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, 默认为 True

是否返回组件的参数。

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

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

返回:
paramsstr 值键的 dict

参数字典,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任意类型, 可选; 默认为 None

如果未找到标签,则为默认/回退值

raise_errorbool

未找到标签时是否引发 ValueError

返回:
tag_valueAny

tag_name 标签在 self 中的值。如果未找到,则在 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" 集。对于分类器,应提供一组“默认”参数用于一般测试,并提供一组“results_comparison”用于与先前记录的结果进行比较,如果一般集未生成适合比较的概率。

返回:
paramsdict 或 dict 列表, 默认为 {}

用于创建类的测试实例的参数。每个 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,其输出位于 path,来自 cls.save(path)
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的 self,其输出为 serial,来自 cls.save(None)
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 of int, 形状为 [n_instances, n_classes]

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

reset()[source]#

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

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))`` 后获得的对象。

返回:
self

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

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

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

行为:如果 path 为 None,则返回一个内存中的序列化对象自身;如果 path 是一个文件位置,则将对象自身作为 zip 文件存储在该位置

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

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

如果为 None,对象自身将保存到内存中的一个对象;如果为文件位置,对象自身将保存到该文件位置。如果

  • path=”estimator”,则将在当前工作目录创建一个名为 estimator.zip 的 zip 文件。

  • path=”/home/stored/estimator”,则将在 /home/stored/

中存储一个名为 estimator.zip 的 zip 文件。

serialization_format: str,默认值 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化对象自身
如果 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”(默认)或“text”

jupyter 内核如何显示对象自身的实例

  • “diagram” = html 框图表示

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

print_changed_onlybool,默认值=True

打印对象自身时,是仅列出与默认值不同的自身参数(如果为 True),还是列出所有参数名称和值(如果为 False)。不进行嵌套,即仅影响对象自身,不影响组件估计器。

warningsstr,“on”(默认)或“off”

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

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

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

backend:parallelstr,可选,默认值=”None”

广播/矢量化时用于并行化的后端,可选项包括

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

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

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

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

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

backend:parallel:paramsdict,可选,默认值={}(未传递参数)

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

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

  • “loky”、“multiprocessing”和“threading”:默认 joblib 后端,此处可以传递任何对 joblib.Parallel 有效的键,例如 n_jobs,但 backend 除外,它直接由 backend:parallel 控制。如果未传递 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,默认值=True;False 防止 ray

      在并行化后关闭。

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

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

返回:
self对对象自身的引用。

说明

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

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

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

通过 self.get_params 找到名为 random_state 的参数,并通过 set_params 将它们设置为从 random_state 派生的整数。这些整数通过 sample_dependent_seed 从链式哈希中采样得到,并保证种子随机生成器的伪随机独立性。

根据 self_policy,应用于对象自身的 random_state 参数;当且仅当 deep=True 时,应用于其余组件对象。

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

参数:
random_stateint, RandomState 实例或 None, 默认值=None

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

deepbool, 默认为 True

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

  • 如果为 False,则仅设置对象自身的 random_state 参数(如果存在)。

  • 如果为 True,则也会在组件对象中设置 random_state 参数。

self_policystr,可选项之一 {“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 兼容对象都有一个标签字典,用于存储对象的元数据。

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

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

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

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

参数:
**tag_dictdict

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

返回:
自身

对自身的引用。