HIVECOTEV2#

class HIVECOTEV2(stc_params=None, drcif_params=None, arsenal_params=None, tde_params=None, time_limit_in_minutes=0, save_component_probas=False, verbose=0, n_jobs=1, random_state=None)[source]#

基于变换集成层次投票集合 (HIVE-COTE) V2。

[1] 中描述的 CAWPE 结构,它结合了来自不同特征表示的 STC、DrCIF、Arsenal 和 TDE 分类器的集成。

参数:
stc_paramsdict 或 None, 默认 None

ShapeletTransformClassifier 模块的参数。如果为 None,则使用默认参数,转换契约时长为 2 小时。

drcif_paramsdict 或 None, 默认 None

DrCIF 模块的参数。如果为 None,则使用默认参数,其中 n_estimators 设置为 500。

arsenal_paramsdict 或 None, 默认 None

Arsenal 模块的参数。如果为 None,则使用默认参数。

tde_paramsdict 或 None, 默认 None

TemporalDictionaryEnsemble 模块的参数。如果为 None,则使用默认参数。

time_limit_in_minutesint, 默认 0

时间契约,以分钟为单位限制构建时间,覆盖每个组件的 n_estimators/n_parameter_samples。默认值为 0 表示使用每个组件的 n_estimators/n_parameter_samples。

save_component_probasbool, 默认 False

调用 predict/predict_proba 时,将每个 HIVE-COTEV2 组件的概率预测保存在 component_probas 中。

verboseint, 默认 0

输出到控制台的信息级别(仅供参考)。

n_jobsint, 默认 1

fit 和 predict 并行运行的作业数。-1 表示使用所有处理器。

random_stateint 或 None, 默认 None

随机数生成的种子。

属性:
n_classes_int

类的数量。

classes_list

唯一的类标签。

stc_weight_float

STC 概率的权重。

drcif_weight_float

DrCIF 概率的权重。

arsenal_weight_float

Arsenal 概率的权重。

tde_weight_float

TDE 概率的权重。

component_probasdict

仅在 save_component_probas 为 true 时使用。保存每个 HIVE-COTEV2 组件的概率预测。

另请参阅

HIVECOTEV1, ShapeletTransformClassifier, DrCIF, Arsenal, TemporalDictionaryEnsemble

注意

对于 Java 版本,请参阅 `https://github.com/uea-machine-learning/tsml/blob/master/src/main/java/ tsml/classifiers/hybrids/HIVE_COTE.java`_

参考文献

[1]

Middlehurst, Matthew, James Large, Michael Flynn, Jason Lines, Aaron Bostrom, and Anthony Bagnall. “HIVE-COTE 2.0: a new meta ensemble for time series classification.” Machine Learning (2021)。

方法

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

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

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)

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

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

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

参数:
parameter_setstr, 默认 “default”

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

返回:
paramsdict 或 list of dict, 默认 {}

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

否则,引发 NotFittedError

参数:
method_namestr, 可选

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

引发:
未拟合错误

如果估计器尚未拟合。

clone()[source]#

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

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

等效于构造一个 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_namesstr 或 list of 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]#

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

状态改变

将状态改为“fitted”。

写入 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_test 从 cv 折叠中获得。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须不相交。

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

change_statebool, 可选 (默认 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 交叉验证对象, 可选, 默认 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, 可选 (默认 True)
  • 如果为 False,将不改变分类器的状态,即 fit/predict 序列使用副本运行,self 不改变

  • 如果为 True,将把 self 拟合到完整的 X 和 y,最终状态将等效于运行 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

self 中 tag_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 的配置标志。

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

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

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

Configs 在 clonereset 调用下保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“fitted”。

参数:
deepbool, 默认 True

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

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

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

返回:
fitted_params键为 str 类型的 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,但不包括组件的参数。

返回:
params键为 str 类型的 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

self 中 tag_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 对象属性的任何覆盖和新标签。

is_composite()[source]#

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

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

返回:
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 of 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))`` 后获得的对象相同。

返回:
self

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

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

将序列化的 self 保存到类似字节的对象或 (.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, 默认 = “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”(默认)或“text”

jupyter 内核如何显示 self 的实例。

  • “diagram” = html 框图表示。

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

print_changed_onlybool, 默认=True

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

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 的默认值。

  • “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对 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对 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 通过链式哈希(chain hashing)从 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, 默认=None

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

deepbool, 默认 True

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

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

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。