DrCIF

class DrCIF(n_estimators=200, n_intervals=None, att_subsample_size=10, min_interval=4, max_interval=None, base_estimator='CIT', time_limit_in_minutes=0.0, contract_max_n_estimators=500, save_transformed_data=False, n_jobs=1, random_state=None)

多样化表示规范区间森林分类器 (DrCIF)。

使用多种表示形式扩展 CIF 算法。区间森林的实现，利用 HIVE-COTE 2.0 论文 Middlehurst 等人 (2021) [1] 中描述的 catch22 特征集，在基础时间序列、周期图表示和差分表示的随机选择区间上进行。

概览：输入“n”个时间序列，每个序列具有“d”维，长度为“m”。对于每棵树：

• 从每种表示形式中采样 n_intervals 个随机位置和长度的区间

• 随机二次采样 att_subsample_size 个 catch22 或统计摘要属性

• 为每个区间随机选择维度

• 从其表示形式计算每个区间的属性，连接形成新的数据集

• 在新数据集上构建决策树

通过平均概率估计值集成树

参数：

n_estimatorsint, 默认为 200

集成中构建的估计器数量。

n_intervalsint, 长度为 3 的 int 列表或 None, 默认为 None

每棵树从每种表示形式中提取的区间数量，可以是一个 int 值用于所有表示形式，也可以是一个列表用于单独设置；如果为 None，则提取 (4 + (sqrt(表示长度) * sqrt(n_dims)) / 3) 个区间。

att_subsample_sizeint, 默认为 10

每棵树随机二次采样 catch22 或统计摘要属性的数量。

min_intervalint 或 长度为 3 的 int 列表, 默认为 4

每种表示形式的最小区间长度，可以是一个 int 值用于所有表示形式，也可以是一个列表用于单独设置。

max_intervalint, 长度为 3 的 int 列表或 None, 默认为 None

每种表示形式的最大区间长度，可以是一个 int 值用于所有表示形式，也可以是一个列表用于单独设置；如果为 None，则设置为 (表示长度 / 2)。

base_estimatorBaseEstimator 或 str, 默认为“CIT”

集成的基础估计器，可以提供一个 sklearn BaseEstimator 实例或一个字符串表示建议选项。“DTC”使用 sklearn DecisionTreeClassifier 并以熵作为分裂度量（sklearn.tree.DecisionTreeClassifier）。“CIT”使用 sktime ContinuousIntervalTree，这是原始树的实现，嵌入了属性处理功能，可实现更快的预测（sktime.classification.interval_based.ContinuousIntervalTree）。为了向估计器传递参数，请传递一个 BaseEstimator 实例。

time_limit_in_minutesint, 默认为 0

时间契约，以分钟为单位限制构建时间，覆盖 n_estimators 参数。默认为 0，表示使用 n_estimators。

contract_max_n_estimatorsint, 默认为 500

设置 time_limit_in_minutes 时最大估计器数量。

save_transformed_databool, 默认为 False

在 fit 中保存转换后的数据，以便在 _get_train_probs 中使用。

n_jobsint, 默认为 1

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

random_stateint 或 None, 默认为 None

随机数生成的种子。

属性：

n_classes_int

类的数量。

n_instances_int

训练样本的数量。

n_dims_int

每个样本的维度数量。

series_length_int

每个时间序列的长度。

classes_list

类别标签。

total_intervals_int

每棵树从所有表示形式中获得的区间总数。

estimators_shape 为 (n_estimators) 的 BaseEstimator 列表

在 fit 中训练的估计器集合。

intervals_shape 为 (n_estimators) 的 ndarray 列表，其 shape 为 (total_intervals,2)

存储所有分类器每个区间的起始点和结束点索引。

atts_shape 为 (n_estimators) 的 array 列表，其 shape 为 (att_subsample_size)

所有分类器二次采样的 catch22 或统计摘要的属性索引。

dims_shape 为 (n_estimators) 的 array 列表，其 shape 为 (total_intervals)

所有分类器从每个区间提取属性的维度。

transformed_data_shape 为 (n_estimators) 的 ndarray 列表，其 shape 为

(n_instances, total_intervals * att_subsample_size)

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

另请参阅

CanonicalIntervalForest

注释

有关 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.interval_based import DrCIF
>>> 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 = DrCIF(
...     n_estimators=3, n_intervals=2, att_subsample_size=2
... ) 
>>> clf.fit(X_train, y_train) 
DrCIF(...)
>>> 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)

检查估计器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数：

method_namestr, 可选

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

引发：

NotFittedError

如果估计器尚未拟合。

clone()

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

克隆是具有相同超参数和配置但没有共享引用的不同对象，处于初始化后状态。此函数等同于返回 sklearn.clone(self)。

等同于构造一个 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)

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

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

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

clone_tags 方法只能在对象的 __init__ 方法中，即构造过程中，或在通过 __init__ 构造后直接调用。

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

tag_names 的默认行为是将 estimator 中的所有标签写入 self。

当前标签值可以通过 get_tags 或 get_tag 查看。

estimator:class:BaseObject 或其派生类的实例

参数：

tag_namesstr 或 str 列表, 默认为 None

要克隆的标签名称。默认为 (None)，表示克隆 estimator 中的所有标签。

返回：

self

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

parameter_setstr, 默认为“default”

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

参数：

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

instance具有默认参数的类的实例

self

classmethod create_test_instances_and_names(parameter_set='default')

objscls 实例列表

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

参数：

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

instance具有默认参数的类的实例

self

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

namesstr 列表, 长度与 objs 相同

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

fit(X, y)

状态变更

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

将状态更改为“已拟合”。

写入 self

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

Xsktime 兼容的时间序列面板数据容器，属于 Panel scitype

参数：

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

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

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

• numpy3D: 3D np.array（任意维度数量，等长序列），shape 为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

• 有关 mtype 列表，请参见 datatypes.SCITYPE_REGISTER

有关规范，请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板数据，有关详细信息请参见 标签参考。

ysktime 兼容的表格数据容器，属于 Table scitype

1D 可迭代对象，shape 为 [n_instances]，或 2D 可迭代对象，shape 为 [n_instances, n_dimensions]，用于拟合的类别标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame。

self对 self 的引用。

self

fit_predict(X, y, cv=None, change_state=True)

生成样本内预测和交叉验证样本外预测的便捷方法。

拟合并预测 X 中序列的标签。

写入 self，如果 change_state=True

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

Xsktime 兼容的时间序列面板数据容器，属于 Panel scitype

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

参数：

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

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

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

• numpy3D: 3D np.array（任意维度数量，等长序列），shape 为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

• 有关 mtype 列表，请参见 datatypes.SCITYPE_REGISTER

有关规范，请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板数据，有关详细信息请参见 标签参考。

ysktime 兼容的表格数据容器，属于 Table scitype

1D 可迭代对象，shape 为 [n_instances]，或 2D 可迭代对象，shape 为 [n_instances, n_dimensions]，用于拟合的类别标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame。

self对 self 的引用。

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，将不会更改分类器的状态，即拟合/预测序列将使用一个副本运行，self 不会改变。

• 如果为 True，会将 self 拟合到完整的 X 和 y，最终状态等同于运行 fit(X, y)。

• y_predsktime 兼容的表格数据容器，属于 Table scitype

self

预测的类别标签

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

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

1D np.npdarray，如果 y 是单变量（一维）；否则，与 fit 中传入的 y 类型相同。

fit_predict_proba(X, y, cv=None, change_state=True)

y_pred2D np.array (int), shape 为 [n_instances, n_classes]

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

写入 self，如果 change_state=True

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

Xsktime 兼容的时间序列面板数据容器，属于 Panel scitype

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

参数：

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

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

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

• numpy3D: 3D np.array（任意维度数量，等长序列），shape 为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

• 有关 mtype 列表，请参见 datatypes.SCITYPE_REGISTER

有关规范，请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板数据，有关详细信息请参见 标签参考。

ysktime 兼容的表格数据容器，属于 Table scitype

1D 可迭代对象，shape 为 [n_instances]，或 2D 可迭代对象，shape 为 [n_instances, n_dimensions]，用于拟合的类别标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame。

self对 self 的引用。

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，将不会更改分类器的状态，即拟合/预测序列将使用一个副本运行，self 不会改变。

• 如果为 True，会将 self 拟合到完整的 X 和 y，最终状态等同于运行 fit(X, y)。

• y_predsktime 兼容的表格数据容器，属于 Table scitype

self

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

classmethod get_class_tag(tag_name, tag_value_default=None)

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

从类获取类标签值，具有来自父类的标签级别继承。

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

它从对象中返回名称为 tag_name 的标签的值，并按以下优先级降序考虑标签覆盖：

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

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

2. 按照继承顺序。

不考虑通过在实例上定义的 set_tags 或 clone_tags 设置的动态标签覆盖。

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

tag_namestr

参数：

标签值的名称。

tag_value_default任意类型

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

tag_value

self

self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()

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

从类获取类标签，具有来自父类的标签级别继承。

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

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

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

值是对应的标签值，覆盖优先级按以下降序排列：

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

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

2. 按照继承顺序。

不考虑通过在实例上定义的 set_tags 或 clone_tags 设置的动态标签覆盖。

要包含来自动态标签的覆盖，请使用 get_tags。

collected_tagsdict

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

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

get_config()

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

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

获取 self 的配置标志。

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

配置在 clone 或 reset 调用下保留。

config_dictdict

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

self

get_fitted_params(deep=True)

所需状态

要求状态为“已拟合”。

获取拟合参数。

deepbool, 默认为 True

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

参数：

如果 True，将返回此对象的参数名 : 值 字典，包括可拟合组件（= BaseEstimator 类型参数）的拟合参数。

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

• fitted_params键为 str 类型的 dict

• 拟合参数的字典，键值对 paramname : paramvalue 包括：

self

总是：此对象的所有拟合参数，如通过 get_param_names 获得的值是此对象该键的拟合参数值。

如果 deep=True，还包含组件参数的键/值对。组件的参数索引为 [componentname]__[paramname]，componentname 的所有参数都作为 paramname 并附带其值出现。

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

• classmethod get_param_defaults()

• 获取对象的默认参数。

default_dict: dict[str, Any]

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

self

classmethod get_param_names(sort=True)

获取对象的参数名称。

sortbool, 默认为 True

是否按字母顺序（True）或按它们在类的 __init__ 中出现的顺序（False）返回参数名称。

参数：

param_names: list[str]

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

self

get_params(deep=True)

是否返回组件的参数。

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

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

参数：

如果 True，将返回此对象的参数名 : 值 字典，包括可拟合组件（= BaseEstimator 类型参数）的拟合参数。

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

• params键为 str 类型的 dict

• 参数的字典，键值对 paramname : paramvalue 包括：

self

总是：此对象的所有参数，如通过 get_param_names 获得的值是此对象该键的参数值。值总是与构造时传递的值相同。

get_tag(tag_name, tag_value_default=None, raise_error=True)

• get_tag 方法从实例中检索名称为 tag_name 的单个标签的值，并按以下优先级降序考虑标签覆盖：

• classmethod get_param_defaults()

• 获取对象的默认参数。

通过实例上的 set_tags 或 clone_tags 设置的标签，

从实例获取标签值，具有标签级别继承和覆盖。

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

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

在实例构造时。

1. 要检索的标签名称。

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

2. 在父类的 _tags 属性中设置的标签，

3. 按照继承顺序。

不考虑通过在实例上定义的 set_tags 或 clone_tags 设置的动态标签覆盖。

参数：

标签值的名称。

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

raise_errorbool

当未找到标签时是否引发 ValueError。

tag_valueAny

self 中 tag_name 标签的值。如果未找到，并且 raise_error 为 True，则引发错误；否则返回 tag_value_default。

self

ValueError, 如果 raise_error 为 True。

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

引发：

get_tags()

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

collected_tagsdict

从实例获取标签，具有标签级别继承和覆盖。

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

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

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

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

1. 要检索的标签名称。

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

2. 在父类的 _tags 属性中设置的标签，

3. 按照继承顺序。

不考虑通过在实例上定义的 set_tags 或 clone_tags 设置的动态标签覆盖。

self

is_composite()

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

composite: bool

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

对象的任何参数值是否是 BaseObject 的派生实例。

self

property is_fitted

fit 是否已被调用。

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

bool

估计器是否已被 fit 拟合。

self

classmethod load_from_path(serial)

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

反序列化 self，结果为 cls.save(path) 在 path 的输出

从文件位置加载对象。

参数：

classmethod load_from_serial(serial)

self

serialcls.save(None) 输出的第一个元素

反序列化 self，结果为 cls.save(None) 的输出 serial

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

参数：

predict(X)

self

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

predict_proba(X)

预测 X 中序列的标签。

参数：

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

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

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

• numpy3D: 3D np.array（任意维度数量，等长序列），shape 为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

• 有关 mtype 列表，请参见 datatypes.SCITYPE_REGISTER

有关规范，请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板数据，有关详细信息请参见 标签参考。

ysktime 兼容的表格数据容器，属于 Table scitype

self

预测的类别标签

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

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

1D np.npdarray，如果 y 是单变量（一维）；否则，与 fit 中传入的 y 类型相同。

fit_predict_proba(X, y, cv=None, change_state=True)

reset()

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

参数：

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

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

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

• numpy3D: 3D np.array（任意维度数量，等长序列），shape 为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

• 有关 mtype 列表，请参见 datatypes.SCITYPE_REGISTER

有关规范，请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板数据，有关详细信息请参见 标签参考。

ysktime 兼容的表格数据容器，属于 Table scitype

self

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

将 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.reset() 后，self 在值和状态上都等同于调用构造函数 ``type(self)(**self.get_params(deep=False))`` 后获得的对象。

self

对 self 的引用。

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

save(path=None, serialization_format='pickle')

将序列化的 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”，则将在 /home/stored/ 中存储一个名为 estimator.zip 的 zip 文件。

存储在 /home/stored/ 中。

serialization_format: str, 默认值 = “pickle”

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

self

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

如果 path 是文件位置 - 指向该文件的 ZipFile 对象

score(X, y) → float

在 X 上根据真实标签评估预测标签。

参数：

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

要评估其预测标签的时间序列。

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

• numpy3D: 3D np.array（任意维度数量，等长序列），shape 为 [n_instances, n_dimensions, series_length]

• 或任何其他支持的 Panel mtype

• 有关 mtype 列表，请参见 datatypes.SCITYPE_REGISTER

有关规范，请参见 examples/AA_datatypes_and_datasets.ipynb

并非所有估计器都支持具有多变量或不等长序列的面板数据，有关详细信息请参见 标签参考。

ysktime 兼容的表格数据容器，属于 Table scitype

1D 可迭代对象，shape 为 [n_instances]，或 2D 可迭代对象，shape 为 [n_instances, n_dimensions]，用于拟合的类别标签。第 0 个索引对应于 X 中的实例索引，第 1 个索引（如果适用）对应于 X 中的多输出向量索引。支持的 sktime 类型：np.ndarray (1D, 2D), pd.Series, pd.DataFrame。

self对 self 的引用。

self

float, predict(X) 与 y 相比的准确率分数。

set_config(**config_dict)

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

参数：

get_fitted_params(deep=True)

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

displaystr, “diagram”（默认）或 “text”

jupyter 内核如何显示 self 的实例

• “diagram” = html 框图表示

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

print_changed_onlybool, 默认值=True

打印 self 时是否只列出与默认值不同的 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”; 要使用的 logger 名称。

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

self

self对 self 的引用。

注释

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

set_params(**params)

设置此对象的参数。

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

参数：

**paramsdict

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

self

self对 self 的引用 (参数设置后)

set_random_state(random_state=None, deep=True, self_policy='copy')

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

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

根据 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 值以在多次函数调用中获得可复现的输出。

如果 True，将返回此对象的参数名 : 值 字典，包括可拟合组件（= BaseEstimator 类型参数）的拟合参数。

deepbool, 默认值=True

• 是否在具有 skbase 对象值的参数中设置随机状态，即组件估计器中。

• 如果为 False，则只设置 self 的 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

self对 self 的引用

set_tags(**tag_dict)

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

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

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

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

set_tags 方法应仅在对象的 __init__ 方法中（构造期间）或通过 __init__ 构造后立即调用。

estimator:class:BaseObject 或其派生类的实例

参数：

**tag_dictdict

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

self

Self

对 self 的引用。

classmethod get_test_params(parameter_set='default')

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

参数：

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

要返回的测试参数集的名称，用于测试中。如果某个值没有特殊的参数定义，则将返回 "default" 集。对于分类器，应提供一组“default”参数用于一般测试，并提供一组“results_comparison”参数用于与之前记录的结果进行比较（如果通用集未生成适合比较的概率）。

self

paramsdict 或 list of dict, 默认值={}

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