IndividualTDE#

IndividualTDE(window_size=10, word_length=8, norm=False, levels=1, igb=False, alphabet_size=4, bigrams=True, dim_threshold=0.85, max_dims=20, typed_dict=True, n_jobs=1, random_state=None)[source]#

单个 TDE 分类器,是 Bag of SFA Symbols (BOSS) 模型的扩展。

TDE 分类器的基础分类器。实现了 Middlehurst (2021) 的单个 TDE 基础模型。 [R89e83b1e1ed5-1]

概述:输入长度为“m”的“n”个时间序列,IndividualTDE 执行 SFA 转换,形成离散化词的稀疏字典。生成的字典在 1-最近邻中使用直方图交集距离函数。

fit 过程涉及寻找“n”个直方图。

predict 使用直方图交集距离函数与 1-最近邻。

参数:
window_size整型,默认为 10

在 SFA 转换中使用的窗口大小。

word_length整型,默认为 8

在 SFA 转换中使用的词长度。

norm布尔型,默认为 False

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

levels整型,默认为 1

SFA 转换的空间金字塔层级数。

igb布尔型,默认为 False

SFA 转换时是使用信息增益分箱 (IGB) 还是多系数分箱 (MCB)。

alphabet_size默认为 4

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

bigrams布尔型,默认为 False

是否在 SFA 转换中记录词的双词组。

dim_threshold浮点型,默认为 0.85

从每个维度提取的词中,作为最高准确度维度比例的准确度阈值。仅适用于多元数据。

max_dims整型,默认为 20

提取词的最大维度数。仅适用于多元数据。

typed_dict布尔型,默认为 True

使用 numba TypedDict 存储词计数。可能增加内存使用量,但对于大型数据集会更快。

n_jobs整型,默认为 1

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

random_state整型或 None,默认为 None

随机种子,整型。

属性:
n_classes_整型

类别数。

classes_列表

类别标签。

n_instances_整型

训练样本数。

n_dims_整型

每个样本的维度数。

series_length_整型

每个时间序列的长度。

另请参阅

TemporalDictionaryEnsemble, SFA

注意

Java 版本请参阅 TSML

参考文献

示例

>>> from sktime.classification.dictionary_based import IndividualTDE
>>> 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 = IndividualTDE() 
>>> clf.fit(X_train, y_train) 
IndividualTDE(...)
>>> y_pred = clf.predict(X_test) 

方法

check_is_fitted([method_name])

检查估计器是否已 fit。

clone()

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

clone_tags(estimator[, tag_names])

从另一个对象克隆标签作为动态覆盖。

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

创建所有测试实例的列表和它们的名称列表。

fit(X, y)

将时间序列分类器 fit 到训练数据。

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

Fit 并预测 X 中序列的标签。

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

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

get_class_tag(tag_name[, tag_value_default])

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

get_class_tags()

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

get_config()

获取对象的配置标志。

get_fitted_params([deep])

获取已 fit 参数。

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

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

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)

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已 fit。

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

如果不存在,则引发 NotFittedError

参数:
method_namestr,可选

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

引发:
未拟合错误

如果估计器尚未训练。

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 的对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。

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

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

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

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

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

estimator一个 :class:BaseObject 或派生类的实例

参数:
tag_namesstr 或 list of str,默认为 None
要克隆的标签名称。默认值(None)克隆 estimator 中的所有标签。

返回:

self
self 的引用。

类方法 create_test_instance(parameter_set='default')[source]#

parameter_setstr,默认为 “default”

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

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

instance具有默认参数的类实例

self
类方法 create_test_instances_and_names(parameter_set='default')[source]#
objscls 实例列表

创建所有测试实例的列表和它们的名称列表。

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

instance具有默认参数的类实例

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

namesstr 列表,长度与 objs 相同

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

fit(X, y)[source]#

状态改变

将时间序列分类器 fit 到训练数据。

将状态更改为“fitted”。

写入 self

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

XPanel scitype 的 sktime 兼容时间序列面板数据容器

参数:
用于 fit 估计器的时间序列。

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

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

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

  • 或任何其他支持的 Panel mtype

  • mtypes 列表请参阅 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]#
方便的方法,用于生成样本内预测和交叉验证样本外预测。

Fit 并预测 X 中序列的标签。

如果 change_state=True,则写入 self

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

XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

参数:
用于 fit 估计器的时间序列。

cvNone、整型或 sklearn 交叉验证对象,可选,默认为 None

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

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

  • 或任何其他支持的 Panel mtype

  • mtypes 列表请参阅 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对象引用。

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

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

  • change_state布尔型,可选(默认为 True)

如果为 False,则不会更改分类器的状态,即 fit/predict 序列使用副本运行,self 不改变
  • 如果为 True,则将 self fit 到完整的 X 和 y,结束状态将等同于运行 fit(X, y)

  • y_predTable scitype 的 sktime 兼容表格数据容器

self
预测的类别标签

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

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

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

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

y_pred2D np.array,整型,形状为 [n_instances, n_classes]

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

如果 change_state=True,则写入 self

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

XPanel scitype 的 sktime 兼容时间序列面板数据容器

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

参数:
用于 fit 估计器的时间序列。

cvNone、整型或 sklearn 交叉验证对象,可选,默认为 None

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

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

  • 或任何其他支持的 Panel mtype

  • mtypes 列表请参阅 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对象引用。

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

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

  • change_state布尔型,可选(默认为 True)

如果为 False,则不会更改分类器的状态,即 fit/predict 序列使用副本运行,self 不改变
  • 如果为 True,则将 self fit 到完整的 X 和 y,结束状态将等同于运行 fit(X, y)

  • y_predTable scitype 的 sktime 兼容表格数据容器

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

类方法 get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

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

它返回名称为 tag_name 的标签值,考虑标签覆盖,按以下优先级递减顺序:

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

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

  2. 按继承顺序。

不考虑在实例上通过 set_tagsclone_tags 设置的动态标签覆盖(这些是在实例上定义的)。

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

tag_namestr

参数:
标签值的名称。

tag_value_default任何类型

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

tag_value

self
self 中名称为 tag_name 的标签的值。如果找不到,则返回 tag_value_default

类方法 get_class_tags()[source]#

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

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

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

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

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

值是相应的标签值,覆盖按以下优先级递减顺序:

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

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

  2. 按继承顺序。

不考虑在实例上通过 set_tagsclone_tags 设置的动态标签覆盖(这些是在实例上定义的)。

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

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

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

collected_tagsdict

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

get_config()[source]#

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

获取对象的配置标志。

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

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

配置在 clonereset 调用后保留。

config_dictdict

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

get_fitted_params(deep=True)[source]#

所需状态

获取已 fit 参数。

需要状态为“fitted”。

deep布尔型,默认为 True

参数:
是否返回组件的已 fit 参数。

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

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

  • fitted_params键为 str 类型的字典

self
已 fit 参数字典,键为 paramname : paramvalue 包括

始终包含:此对象的所有已 fit 参数,如通过 get_param_names 获取的值是此对象该键对应的已 fit 参数值

  • 如果 deep=True,还包含组件参数的键/值对,组件参数的索引为 [componentname]__[paramname]componentname 的所有参数都以 paramname 的形式出现,并带有其值

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

  • 类方法 get_param_defaults()[source]#

获取对象的参数默认值。

default_dict: dict[str, Any]

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

类方法 get_param_names(sort=True)[source]#

获取对象的参数名称。

sort布尔型,默认为 True

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

param_names: list[str]

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

get_params(deep=True)[source]#

是否返回组件的参数。

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

参数:
是否返回组件的已 fit 参数。

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

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

  • params键为 str 类型的字典

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

始终包含:此对象的所有参数,如通过 get_param_names 获取的值是此对象该键对应的参数值,值始终与构造时传递的值相同

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

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

  • 类方法 get_param_defaults()[source]#

get_tag 方法从实例中检索名称为 tag_name 的单个标签的值,考虑标签覆盖,按以下优先级递减顺序:

从实例获取标签值,并考虑标签层级继承和覆盖。

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

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

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

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

要检索的标签名称

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

  2. 按继承顺序。

不考虑在实例上通过 set_tagsclone_tags 设置的动态标签覆盖(这些是在实例上定义的)。

参数:
标签值的名称。

tag_value_default任何类型,可选;默认为 None

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

raise_error布尔型

找不到标签时是否引发 ValueError

tag_valueAny

self
self 中名称为 tag_name 的标签的值。如果找不到,如果 raise_error 为 True 则引发错误,否则返回 tag_value_default

ValueError,如果 raise_errorTrue

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

get_tags()[source]#

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

从实例获取标签,并考虑标签层级继承和覆盖。

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

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

collected_tagsdict

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

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

要检索的标签名称

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

  2. 按继承顺序。

不考虑在实例上通过 set_tagsclone_tags 设置的动态标签覆盖(这些是在实例上定义的)。

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

类方法 get_test_params(parameter_set='default')[source]#

要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 "default" 集。对于分类器,应为一般测试提供一组“默认”参数,并为与之前记录的结果进行比较(如果默认参数集无法生成合适的概率进行比较)提供一组“结果比较”参数。

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

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

paramsdict 或 list of dict,默认为 {}

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

is_composite()[source]#

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

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

composite: 布尔型

self
对象是否具有任何参数值是 BaseObject 后代实例。

属性 is_fitted[source]#

是否已调用 fit

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

布尔型

self
估计器是否已训练。

类方法 load_from_path(serial)[source]#

serialZipFile(path).open(“object) 的结果

从文件位置加载对象。

参数:
path 位置的输出,由 cls.save(path) 生成的已反序列化对象
self
类方法 load_from_serial(serial)[source]#
serialcls.save(None) 输出的第一个元素

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

参数:
cls.save(None) 生成的输出 serial 的已反序列化对象
self
predict(X)[source]#
用于预测标签的时间序列。

预测 X 中序列的标签。

参数:
用于 fit 估计器的时间序列。

predict_proba(X)[source]#

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

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

  • 或任何其他支持的 Panel mtype

  • mtypes 列表请参阅 datatypes.SCITYPE_REGISTER

规范请参阅 examples/AA_datatypes_and_datasets.ipynb

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

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

self
预测的类别标签

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

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

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

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

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

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

参数:
用于 fit 估计器的时间序列。

predict_proba(X)[source]#

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

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

  • 或任何其他支持的 Panel mtype

  • mtypes 列表请参阅 datatypes.SCITYPE_REGISTER

规范请参阅 examples/AA_datatypes_and_datasets.ipynb

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

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

self
预测的类别标签概率 第 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
self 的引用。

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

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

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

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

pathNone 或文件位置 (str 或 Path)

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

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

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

  • 中存储一个 zip 文件 estimator.zip

serialization_format: str,默认为 “pickle”

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

如果 path 为 None - 内存中的序列化对象

self
如果 path 是文件位置 - 引用该文件的 ZipFile 对象
score(X, y) 浮点型[source]#
用于评估预测标签的时间序列。

评估预测标签与 X 上的真实标签的得分。

参数:
用于 fit 估计器的时间序列。

浮点型,predict(X) 与 y 之间的准确率得分

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

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

  • 或任何其他支持的 Panel mtype

  • mtypes 列表请参阅 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
set_config(**config_dict)[source]#
配置名称 : 配置值 对的字典。有效的配置、值及其含义如下所示

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

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

displaystr,“diagram”(默认),或“text”

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

“diagram” = html 框图表示

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

  • print_changed_only布尔型,默认为 True

打印对象时是否仅列出与默认值不同的参数 (False),或列出所有参数名称和值 (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 直接控制。如果未传递 n_jobs,则默认为 `-1`,其他参数默认为 `joblib` 的默认值。

  • “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

      并行化后关闭。

    • “logger_name”:字符串,默认为“ray”;要使用的日志记录器名称。

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

self
self对自身的引用。

注意

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**params**字典

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 中的 random_state 参数,取决于 self_policy,并且仅当 deep=True 时应用于其余组件对象。

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

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

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

是否返回组件的已 fit 参数。

是否在值类型为 skbase 对象的参数中设置随机状态,即组件估计器。

  • 如果为 False,将仅设置 selfrandom_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
self对自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

estimator一个 :class:BaseObject 或派生类的实例

参数:
**tag_dict**字典

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

self
Self

对自身的引用。