Arsenal#

class Arsenal(num_kernels=2000, n_estimators=25, rocket_transform='rocket', max_dilations_per_kernel=32, n_features_per_kernel=4, time_limit_in_minutes=0.0, contract_max_n_estimators=100, save_transformed_data=False, n_jobs=1, random_state=None)[source]#

Arsenal 集成。

概述:使用 RidgeClassifierCV 基础分类器的 ROCKET 转换器集成。使用 ridge 交叉验证的精度对每个分类器加权。与 RocketClassifier 相比,可以生成概率估计,但牺牲了可伸缩性。

参数:
num_kernelsint, 默认值=2,000

每个 ROCKET 转换器的核数量。

n_estimatorsint, 默认值=25

为集成构建的评估器数量。

rocket_transformstr, 默认值=”rocket”

要使用的 Rocket 转换器类型。有效输入 = [“rocket”,”minirocket”,”multirocket”]

max_dilations_per_kernelint, 默认值=32

仅限于 MiniRocket 和 MultiRocket。每个核的最大膨胀数量。

n_features_per_kernelint, 默认值=4

仅限于 MultiRocket。每个核的特征数量。

time_limit_in_minutesint, 默认值=0

限制构建时间的分钟时间限制,将覆盖 n_estimators。默认值 0 表示使用 n_estimators。

contract_max_n_estimatorsint, 默认值=100

设置 time_limit_in_minutes 时,最大评估器数量。

save_transformed_databool, 默认值=False

保存 fit 中转换后的数据,用于 _get_train_probs。

n_jobsint, 默认值=1

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

random_stateint 或 None, 默认值=None

随机数生成的种子。

属性:
n_classesint

类别数量。

n_instances_int

训练案例数量。

n_dims_int

每个案例的维度数量。

series_length_int

每个序列的长度。

classes_list

类别标签。

estimators_BaseEstimator 形状 (n_estimators) 的列表

fit 中训练的评估器集合。

weights_float 形状 (n_estimators) 的列表

集成中每个评估器的权重。

transformed_data_形状 (n_estimators) 的 ndarray 列表,形状为
(n_instances,total_intervals * att_subsample_size)

所有分类器的转换后数据集。仅在 save_transformed_data 为 True 时保存。

另请参阅

RocketClassifier

注释

有关 Java 版本,请参阅 TSML

参考文献

[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.” arXiv preprint arXiv:2104.07551 (2021).

示例

>>> from sktime.classification.kernel_based import Arsenal
>>> 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 = Arsenal(num_kernels=100, n_estimators=5) 
>>> clf.fit(X_train, y_train) 
Arsenal(...)
>>> 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) float

对预测标签与 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, 可选

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

引发:
NotFittedError

如果评估器尚未拟合。

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 或 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-th 索引对应于 X 中的实例索引 1-st 索引(如果适用)对应于 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-th 索引对应于 X 中的实例索引 1-st 索引(如果适用)对应于 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),其中 cv 折叠生成多个 X_train, y_train, X_test。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须不相交

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

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

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

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

预测的类别标签

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

0-th 索引对应于 X 中的实例索引,1-st 索引(如果适用)对应于 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-th 索引对应于 X 中的实例索引 1-st 索引(如果适用)对应于 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),其中 cv 折叠生成多个 X_train, y_train, X_test。返回的 y 是所有测试折叠预测的并集,cv 测试折叠必须不相交

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

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

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

返回:
y_predint 的 2D np.array,形状为 [n_instances, n_classes]

预测的类别标签概率 0-th 索引对应于 X 中的实例索引 1-st 索引对应于类别索引,顺序与 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 的配置标志。

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

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

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

配置在 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

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

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) 的结果
返回:
path 位置生成的反序列化 self,来自 cls.save(path)
类方法 load_from_serial(serial)[source]#

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

参数:
serial`cls.save(None)` 输出的第 1 个元素
返回:
反序列化的 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-th 索引对应于 X 中的实例索引,1-st 索引(如果适用)对应于 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_predint 的 2D np.array,形状为 [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,返回一个内存中的序列化 self 对象;如果 path 是文件位置,则将 self 以 zip 文件形式存储在该位置。

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

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

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

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

  • path=”/home/stored/estimator”,则会创建一个名为 estimator.zip 的 zip 文件,

存储在 /home/stored/ 中。

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-th 索引对应于 X 中的实例索引 1-st 索引(如果适用)对应于 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 参数(True),或打印所有参数名和值(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,则抑制警告

返回:
selfself 的引用。

注释

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict 类型

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

返回:
selfself 的引用(参数设置后)
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 的设置,应用于 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,通常与之不同

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

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

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

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

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

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

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

参数:
**tag_dictdict 类型

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

返回:
self

self 的引用。