RandomIntervalSpectralEnsemble#

class RandomIntervalSpectralEnsemble(n_estimators=500, max_interval=0, min_interval=16, acf_lag=100, acf_min_values=4, n_jobs=1, random_state=None)[source]#

Random Interval Spectral Ensemble (RISE)。

输入:n 个长度为 m 的序列。对于每棵树,

  • 采样随机区间

  • 计算此区间上的 ACF 和 PS,并连接特征

  • 在新特征上构建树

通过平均概率对树进行集成。

参数:
n_estimatorsint,默认值=200

森林中的树木数量。

min_intervalint,默认值=16

区间的最小宽度。

acf_lagint,默认值=100

要使用的自相关项的最大数量。

acf_min_valuesint,默认值=4

查找相关性时使用的项数不得少于此值。

n_jobsint,默认值=1

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

random_stateint, RandomState 实例或 None,默认值=None

如果为 int,random_state 是随机数生成器使用的种子;如果为 RandomState 实例,random_state 是随机数生成器;如果为 None,则随机数生成器是 np.random 使用的 RandomState 实例。

属性:
n_classes_int

类别数量。

classes_list

类别标签。

intervals_形状为 [n_estimators][2] 的数组

存储所有分类器的起点和终点索引。

注意

Java 版本请参阅 TSML

参考文献

[1]

Jason Lines, Sarah Taylor and Anthony Bagnall, “Time Series Classification with HIVE-COTE: The Hierarchical Vote Collective of Transformation-Based Ensembles”,ACM Transactions on Knowledge and Data Engineering,12(5): 2018

方法

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

获取自身的配置标志。

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

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

score(X, y) float

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

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

property feature_importances_[source]#

RISE 分类器不支持特征重要性。

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

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

参数:
parameter_setstr,默认值="default"

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

返回:
paramsdict 或 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]#

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

克隆是一个不同的对象,没有共享引用,处于初始化后状态。此函数等效于返回 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

引发:
如果克隆不符合要求,则引发 RuntimeError,原因是 __init__ 存在错误。
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 个元素是测试中 obj 的第 i 个实例的名称。如果多于一个实例,命名约定为 {cls.__name__}-{i},否则为 {cls.__name__}

fit(X, y)[source]#

使用训练数据拟合时间序列分类器。

状态变更

将状态更改为“fitted”。

写入自身

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

参数:
Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel

用于拟合估计器的时间序列。

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

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

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

  • 或任何其他支持的 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:形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维度,等长序列)

  • 或任何其他支持的 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, 或 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 拟合自身,最终状态将等效于运行 fit(X, y)

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

预测的类别标签

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

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

如果 y 是一元(一维),则为 1D np.npdarray;否则,与 fit 中传入的 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:形状为 [n_instances, n_dimensions, series_length] 的 3D np.array(任意维度,等长序列)

  • 或任何其他支持的 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, 或 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 拟合自身,最终状态将等效于运行 fit(X, y)

返回:
y_pred形状为 [n_instances, n_classes] 的 2D np.array (int 类型)

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

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 的键值对,通常用作控制行为的瞬时标志。

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 类型的字典

拟合参数字典,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 类型的字典

参数字典,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]#

检查对象是否由其他 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”) 的结果
返回:
反序列化的自身,结果输出到 path,即 cls.save(path) 的输出
classmethod load_from_serial(serial)[source]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
反序列化的自身,结果输出为 serial,即 cls.save(None) 的输出
predict(X)[source]#

预测 X 中序列的标签。

参数:
Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel

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

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

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

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

  • 或任何其他支持的 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 中的多输出向量索引。

如果 y 是一元(一维),则为 1D np.npdarray;否则,与 fit 中传入的 y 类型相同

predict_proba(X)[source]#

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

参数:
Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel

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

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

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

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

  • 或任何其他支持的 Panel mtype

有关 mtype 列表,请参阅 datatypes.SCITYPE_REGISTER

有关规范,请参阅 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持包含多元或不等长序列的面板,有关详细信息,请参阅标签参考

返回:
y_pred形状为 [n_instances, n_classes] 的 2D np.array (int 类型)

预测的类别标签概率。第 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]#

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

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

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

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

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

  • path=”estimator”,则将在当前工作目录 (cwd) 中生成一个 zip 文件 estimator.zip

  • path=”/home/stored/estimator”,则 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str,默认值 = “pickle”

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

返回:
如果 path 为 None - 内存中的序列化自身
如果 path 为文件位置 - 包含文件引用的 ZipFile
score(X, y) float

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

参数:
Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel

用于评估预测标签的时间序列。

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

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

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

  • 或任何其他支持的 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

返回:
float,predict(X) 与 y 的准确率分数
set_config(**config_dict)[source]#

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

参数:
config_dictdict

配置名称:配置值对的字典。有效的配置、值及其含义如下所示

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

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

  • “diagram” = html 框图表示

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

print_changed_onlybool,默认值=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 默认值。

  • “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, default=True; False prevents ray from

      shutting down after parallelization.

    • “logger_name”: str, default=”ray”; name of the logger to use.

    • “mute_warnings”: bool, default=False; if True, suppresses warnings

返回:
self对自身的引用。

注意

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

set_params(**params)[来源]#

设置此对象的参数。

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

参数:
**paramsdict

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

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

为自身设置 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

伪随机数生成器,用于控制随机整数的生成。传入整数以实现跨多个函数调用的可重现输出。

deepbool,默认值=True

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

  • 如果为 False,将只设置 selfrandom_state 参数(如果存在)。

  • 如果为 True,也将设置组件对象中的 random_state 参数。

self_policystr, 以下之一: {“copy”, “keep”, “new”}, default=”copy”
  • “copy” : self.random_state 设置为输入的 random_state

  • “keep” : self.random_state 保持原样

  • “new” : self.random_state 设置为一个新的随机状态,

从输入的 random_state 派生,并且通常与它不同

返回:
self对自身的引用
set_tags(**tag_dict)[来源]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
自身

对自身的引用。