Catch22

class Catch22(features: int | str | list[int | str]] = 'all', catch24: bool = False, outlier_norm: bool = False, replace_nans: bool = False, col_names: str = 'range')

规范时间序列特征 (Catch22)。

概览： 输入 n 个长度为 m 且具有 d 维的时间序列。将时间序列转换为从 hctsa [R93c36b0d3d4c-2] 工具箱中提取的 22 个 Catch22 [1] 特征。

参数：

featuresint/str 或 int/str 列表，可选，默认值=”all”

要提取的 Catch22 特征，可通过特征索引、字符串特征名称或名称或索引列表来指定多个特征。如果为“all”，则提取所有特征。有效特征及其对应的短特征名称如下：

{ “DN_HistogramMode_5”: “mode_5”, “DN_HistogramMode_10”: “mode_10”, “SB_BinaryStats_diff_longstretch0”: “stretch_decreasing”, “DN_OutlierInclude_p_001_mdrmd”: “outlier_timing_pos”, “DN_OutlierInclude_n_001_mdrmd”: “outlier_timing_neg”, “CO_f1ecac”: “acf_timescale”, “CO_FirstMin_ac”: “acf_first_min”, “SP_Summaries_welch_rect_area_5_1”: “centroid_freq”, “SP_Summaries_welch_rect_centroid”: “low_freq_power”, “FC_LocalSimple_mean3_stderr”: “forecast_error”, “CO_trev_1_num”: “trev”, “CO_HistogramAMI_even_2_5”: “ami2”, “IN_AutoMutualInfoStats_40_gaussian_fmmi”: “ami_timescale”, “MD_hrv_classic_pnn40”: “high_fluctuation”, “SB_BinaryStats_mean_longstretch1”: “stretch_high”, “SB_MotifThree_quantile_hh”: “entropy_pairs”, “FC_LocalSimple_mean1_tauresrat”: “whiten_timescale”, “CO_Embed2_Dist_tau_d_expfit_meandiff”: “embedding_dist”, “SC_FluctAnal_2_dfa_50_1_2_logi_prop_r1”: “dfa”, “SC_FluctAnal_2_rsrangefit_50_1_logi_prop_r1”: “rs_range”, “SB_TransitionMatrix_3ac_sumdiagcov”: “transition_matrix”, “PD_PeriodicityWang_th0_01”: “periodicity”,

} 此外，如果 catch24 为 true，则有两个额外特征可用： {

“DN_Mean”: “mean”, “DN_Spread_Std”: “std”,

} 这些特征的概览可查阅： https://time-series-features.gitbook.io/catch22-features/feature-overview-table

catch24bool，可选，默认值=False

如果为 True，则提取均值和标准差以及 22 个 Catch22 特征。如果提供了要提取的特定特征列表，则必须将“Mean”和/或“StandardDeviation”添加到列表中才能提取这些特征。

outlier_normbool，可选，默认值=False

在计算两个离群值 Catch22 特征：_DN_OutlierInclude_p_001_mdrmd 和 _DN_OutlierInclude_n_001_mdrmd 时，对每个时间序列进行标准化，这对于较大的值可能需要一段时间处理。

replace_nansbool，可选，默认值=True

将 Catch22 变换结果中的 NaN 或 inf 值替换为 0。

col_namesstr，以下选项之一：{“range”, “int_feat”, “str_feat”, “short_str_feat”, “auto”}，

可选，默认值=”range”

返回的列名类型。如果为“range”，列名将是常规的整数范围，如同 RangeIndex。如果为“int_feat”，列名将是 pycatch22 中定义的整数特征索引。如果为“str_feat”，列名将是字符串特征名称。如果为“short_str_feat”，列名将是 pycatch22 中定义的短字符串特征名称。如果为“auto”，列名将与 features 中定义的相同。

属性：

is_fitted

指示是否已调用 fit 方法。

另请参阅

Catch22Classifier

备注

原始 Catch22 包实现： DynamicsAndNeuralSystems/Catch22

Java 版本请参阅 uea-machine-learning/tsml /tsml/transformers/Catch22.java

参考文献

[1]

Lubba, C. H., Sethi, S. S., Knaute, P., Schultz, S. R., Fulcher, B. D., &

Jones, N. S. (2019). catch22: Canonical time-series characteristics. Data Mining and Knowledge Discovery, 33(6), 1821-1852. .. [R93c36b0d3d4c-2] Fulcher, B. D., Little, M. A., & Jones, N. S. (2013). Highly comparative time-series analysis: the empirical structure of time series and their methods. Journal of the Royal Society Interface, 10(83), 20130048.

方法

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])	将转换器拟合到 X，可选地拟合到 y。
fit_transform(X[, y])	拟合数据，然后对其进行变换。
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])	返回估计器的测试参数设置。
inverse_transform(X[, y])	逆变换 X 并返回逆变换后的版本。
is_composite()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化的内存容器加载对象。
reset()	将对象重置为干净的后初始化状态。
save([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.zip) 文件。
set_config(**config_dict)	将配置标志设置为给定值。
set_params(**params)	设置此对象的参数。
set_random_state([random_state, deep, ...])	为 self 设置 random_state 伪随机种子参数。
set_tags(**tag_dict)	设置实例级别的标签覆盖为给定值。
transform(X[, y])	变换 X 并返回转换后的版本。
update(X[, y, update_params])	使用 X 更新转换器，可选地使用 y。

classmethod get_test_params(parameter_set='default')

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

参数：

parameter_setstr，默认值=”default”

要返回的测试参数集名称，用于测试。如果某个值没有定义特殊参数，则返回 "default" 集。

返回值：

paramsdict 或 dict 列表，默认值 = {}

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

check_is_fitted(method_name=None)

检查估计器是否已拟合。

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

如果不是，则会引发 NotFittedError 异常。

参数：

method_namestr，可选

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

引发：

NotFittedError

如果估计器尚未拟合。

clone()

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

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

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

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

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具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')

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

参数：

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=None)

将转换器拟合到 X，可选地拟合到 y。

状态变化

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

写入 self

• 设置以“_”结尾的已拟合模型属性，可通过 get_fitted_params 检查已拟合属性。

• 将 self.is_fitted 标志设置为 True。

• 如果 self.get_tag("remember_data") 为 True，则将 X 记忆为 self._X，并强制转换为 self.get_tag("X_inner_mtype")。

参数：

X符合 sktime 数据容器格式的时间序列

用于拟合变换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每种 mtype 实现一个抽象的 scitype。

• Series scitype = 单个时间序列。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)

• Panel scitype = 时间序列集合。pd.DataFrame 具有两级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，或 Series 类型 pd.DataFrame 的 list

• Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅关于 mtype 的词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认值=None

附加数据，例如用于转换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，而非可选。有关所需格式，请参阅类文档字符串中的详细信息。

返回值：

self估计器的拟合实例

fit_transform(X, y=None)

拟合数据，然后对其进行变换。

将转换器拟合到 X 和 y，并返回 X 的转换版本。

状态变化

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

写入 self: _is_fitted : 标志设置为 True。 _X : X，X 的强制副本，如果 remember_data 标签为 True

如果可能，可能会通过引用强制转换为内部类型或 update_data 兼容类型

模型属性（以“_”结尾）：取决于估计器

参数：

X符合 sktime 数据容器格式的时间序列

用于拟合变换的数据，以及用于变换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每种 mtype 实现一个抽象的 scitype。

• Series scitype = 单个时间序列。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)

• Panel scitype = 时间序列集合。pd.DataFrame 具有两级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，或 Series 类型 pd.DataFrame 的 list

• Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅关于 mtype 的词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认值=None

附加数据，例如用于转换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，而非可选。有关所需格式，请参阅类文档字符串中的详细信息。

返回值：

X 的转换版本

类型取决于 X 的类型和 scitype:transform-output 标签

X | tf-output | 返回值类型 |

|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1-row) | | Panel | Primitives | pd.DataFrame | | Series | Series | Series | | Panel | Series | Panel | | Series | Panel | Panel |

返回值中的实例对应于 X 中的实例

表中未列出的组合目前不支持

详细解释，并附示例

• 如果 X 是 Series (例如，pd.DataFrame)

且 transform-output 是 Series，则返回值为相同 mtype 的单个 Series。示例：对单个时间序列进行去趋势

• 如果 X 是 Panel (例如，pd-multiindex) 且 transform-output

是 Series，则返回值为与 X 具有相同实例数的 Panel (转换器应用于每个输入的 Series 实例)。示例：面板中的所有时间序列都被单独去趋势

• 如果 X 是 Series 或 Panel 且 transform-output 是

Primitives，则返回值为具有与 X 中实例数量相同行数的 pd.DataFrame。示例：返回值的第 i 行包含第 i 个时间序列的均值和方差

• 如果 X 是 Series 且 transform-output 是 Panel，

则返回值为类型为 pd-multiindex 的 Panel 对象。示例：输出的第 i 个实例是运行在 X 上的第 i 个窗口

classmethod get_class_tag(tag_name, tag_value_default=None)

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

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

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

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

1. 类 _tags 属性中设置的标签。

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

按继承顺序。

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

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

参数：

tag_namestr

标签值的名称。

tag_value_default任意类型

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

返回值：

tag_value

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

classmethod get_class_tags()

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

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

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

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

值是对应的标签值，覆盖的优先级降序如下：

1. 类 _tags 属性中设置的标签。

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

按继承顺序。

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

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

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

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

collected_tagsdict

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

get_config()

获取 self 的配置标志。

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

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

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

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

返回值：

config_dictdict

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

get_fitted_params(deep=True)

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数：

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

获取对象的参数默认值。

返回值：

default_dict: dict[str, Any]

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

classmethod get_param_names(sort=True)

获取对象的参数名称。

参数：

sortbool，默认值=True

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

返回值：

param_names: list[str]

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

get_params(deep=True)

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

参数：

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)

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

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

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

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

在实例构建时设置的标签。

2. 类 _tags 属性中设置的标签。

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

按继承顺序。

参数：

tag_namestr

要检索的标签名称

tag_value_default任意类型，可选；默认值=None

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

raise_error布尔值

未找到标签时是否引发 ValueError

返回值：

tag_value任意类型

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

引发：

ValueError，如果 raise_error 为 True。

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

get_tags()

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

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

标签是特定于实例 self 的键值对，它们是对象构造后不会更改的静态标志。

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

值是对应的标签值，覆盖的优先级降序如下：

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

在实例构建时设置的标签。

2. 类 _tags 属性中设置的标签。

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

按继承顺序。

返回值：

collected_tags字典

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

inverse_transform(X, y=None)

逆变换 X 并返回逆变换后的版本。

目前假定只有标签为

“scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,

的变换器具有 inverse_transform。

所需状态

要求状态为“已拟合”。

在 self 中的访问

• 以“_”结尾的已拟合模型属性。

• self.is_fitted，必须为 True

参数：

X符合 sktime 数据容器格式的时间序列

用于拟合变换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每种 mtype 实现一个抽象的 scitype。

• Series scitype = 单个时间序列。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)

• Panel scitype = 时间序列集合。pd.DataFrame 具有两级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，或 Series 类型 pd.DataFrame 的 list

• Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅关于 mtype 的词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认值=None

额外数据，例如，用于变换的标签。某些变换器需要此项，详情请参阅类文档字符串。

返回值：

X 的逆变换版本

与 X 类型相同，并符合 mtype 格式规范

is_composite()

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

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

返回值：

composite: 布尔值

对象是否包含任何参数，且这些参数的值是 BaseObject 的派生实例。

property is_fitted

指示是否已调用 fit 方法。

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

返回值：

布尔值

估计器是否已 「fit」。

classmethod load_from_path(serial)

从文件位置加载对象。

参数：

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

返回值：

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

classmethod load_from_serial(serial)

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

参数：

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

返回值：

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

reset()

将对象重置为干净的后初始化状态。

结果是将 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')

将序列化的 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) 下创建 zip 文件 estimator.zip。

• path="/home/stored/estimator"，则会在 /home/stored/ 中存储 zip 文件 estimator.zip。

存储在 /home/stored/ 中的。

serialization_format: str，默认值 = “pickle”

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

返回值：

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

如果 path 是文件位置 - 引用该文件的 ZipFile

set_config(**config_dict)

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

参数：

config_dictdict

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

displaystr，“diagram”（默认值）或“text”

jupyter 内核如何显示 self 的实例

• “diagram” = html 方框图表示

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

print_changed_only布尔值，默认值=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:params字典，可选，默认值={}（不传递参数）

作为配置传递给并行后端的额外参数。有效键取决于 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”：布尔值，默认值=True；False 防止 ray 在并行化后关闭。

    在并行化之后关闭。

  • “logger_name”：str，默认值=“ray”；要使用的日志记录器名称。

  • “mute_warnings”：布尔值，默认值=False；如果为 True，则抑制警告

input_conversionstr，以下之一：“on”（默认值）、“off”或有效的 mtype 字符串

控制输入检查和转换，适用于 _fit、_transform、_inverse_transform、_update

• "on" - 执行输入检查和转换

• "off" - 在将数据传递给内部方法之前不执行输入检查和转换

• 有效的 mtype 字符串 - 假定输入为指定的 mtype，执行转换但不进行检查

output_conversionstr，以下之一：“on”、“off”、有效的 mtype 字符串

控制 _transform、_inverse_transform 的输出转换

• "on" - 如果 input_conversion 为“on”，则执行输出转换

• "off" - 直接返回 _transform、_inverse_transform 的输出

• 有效的 mtype 字符串 - 输出转换为指定的 mtype

返回值：

self对 self 的引用。

备注

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

set_params(**params)

设置此对象的参数。

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

参数：

**params字典

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

返回值：

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 从链式哈希中采样，保证种子随机生成器之间的伪随机独立性。

适用于 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。

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 的引用

set_tags(**tag_dict)

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

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

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

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

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

当前标签值可以通过 get_tags 或 get_tag 进行检查。

参数：

**tag_dict字典

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

返回值：

Self

对 self 的引用。

transform(X, y=None)

变换 X 并返回转换后的版本。

所需状态

要求状态为“已拟合”。

在 self 中的访问

• 以“_”结尾的已拟合模型属性。

• self.is_fitted，必须为 True

参数：

X符合 sktime 数据容器格式的时间序列

要变换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每种 mtype 实现一个抽象的 scitype。

• Series scitype = 单个时间序列。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)

• Panel scitype = 时间序列集合。pd.DataFrame 具有两级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，或 Series 类型 pd.DataFrame 的 list

• Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅关于 mtype 的词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认值=None

额外数据，例如，用于变换的标签。某些变换器需要此项，详情请参阅类文档字符串。

返回值：

X 的转换版本

类型取决于 X 的类型和 scitype:transform-output 标签

	变换
X	-输出	返回类型
Series	Primitives	pd.DataFrame (1 行)
Panel	Primitives	pd.DataFrame
Series	Series	Series
Panel	Series	Panel
Series	Panel	Panel

返回值中的实例对应于 X 中的实例

表中未列出的组合目前不支持

详细解释，并附示例

• 如果 X 是 Series (例如，pd.DataFrame)

且 transform-output 是 Series，则返回值为相同 mtype 的单个 Series。示例：对单个时间序列进行去趋势

• 如果 X 是 Panel (例如，pd-multiindex) 且 transform-output

是 Series，则返回值为与 X 具有相同实例数的 Panel (转换器应用于每个输入的 Series 实例)。示例：面板中的所有时间序列都被单独去趋势

• 如果 X 是 Series 或 Panel 且 transform-output 是

Primitives，则返回值为具有与 X 中实例数量相同行数的 pd.DataFrame。示例：返回值的第 i 行包含第 i 个时间序列的均值和方差

• 如果 X 是 Series 且 transform-output 是 Panel，

则返回值为类型为 pd-multiindex 的 Panel 对象。示例：输出的第 i 个实例是运行在 X 上的第 i 个窗口

update(X, y=None, update_params=True)

使用 X 更新转换器，可选地使用 y。

所需状态

要求状态为“已拟合”。

在 self 中的访问

• 以“_”结尾的已拟合模型属性。

• self.is_fitted，必须为 True

写入 self

• 以“_”结尾的已拟合模型属性。

• 如果 remember_data 标签为 True，则写入 self._X，并通过 update_data 根据 X 中的值进行更新。

参数：

X符合 sktime 数据容器格式的时间序列

用于更新变换的数据

sktime 中的单个数据格式是所谓的 mtype 规范，每种 mtype 实现一个抽象的 scitype。

• Series scitype = 单个时间序列。pd.DataFrame, pd.Series 或 np.ndarray (1D 或 2D)

• Panel scitype = 时间序列集合。pd.DataFrame 具有两级行 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，或 Series 类型 pd.DataFrame 的 list

• Hierarchical scitype = 分层时间序列集合。pd.DataFrame 具有三级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

有关数据格式的更多详细信息，请参阅关于 mtype 的词汇表。有关用法，请参阅转换器教程 examples/03_transformers.ipynb

y可选，sktime 兼容数据格式的数据，默认值=None

额外数据，例如，用于变换的标签。某些变换器需要此项，详情请参阅类文档字符串。

返回值：

self估计器的拟合实例