Catch22Wrapper#

class Catch22Wrapper(features='all', catch24=False, outlier_norm=False, replace_nans=False, col_names='range')[source]#

典型时间序列特征 (Catch22 和 24)，使用 pycatch22 包。

直接接口到 Catch-22 和 Catch-24 特征集的 pycatch22 实现 (DynamicsAndNeuralSystems/pycatch22)。

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

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

要提取的 Catch22 特征，可以是特征索引、字符串特征名，或由多个特征名或索引组成的列表。如果为“all”，则提取所有特征。有效特征如下所示

[“DN_HistogramMode_5”, “DN_HistogramMode_10”, “SB_BinaryStats_diff_longstretch0”, “DN_OutlierInclude_p_001_mdrmd”, “DN_OutlierInclude_n_001_mdrmd”, “CO_f1ecac”, “CO_FirstMin_ac”, “SP_Summaries_welch_rect_area_5_1”, “SP_Summaries_welch_rect_centroid”, “FC_LocalSimple_mean3_stderr”, “CO_trev_1_num”, “CO_HistogramAMI_even_2_5”, “IN_AutoMutualInfoStats_40_gaussian_fmmi”, “MD_hrv_classic_pnn40”, “SB_BinaryStats_mean_longstretch1”, “SB_MotifThree_quantile_hh”, “FC_LocalSimple_mean1_tauresrat”, “CO_Embed2_Dist_tau_d_expfit_meandiff”, “SC_FluctAnal_2_dfa_50_1_2_logi_prop_r1”, “SC_FluctAnal_2_rsrangefit_50_1_logi_prop_r1”, “SB_TransitionMatrix_3ac_sumdiagcov”, “PD_PeriodicityWang_th0_01”]

catch24bool，可选，默认值=False

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

outlier_normbool，可选，默认值=False

在计算两个离群值 Catch22 特征期间对每个时间序列进行归一化，这对于大值可能需要一段时间来处理。

replace_nansbool，可选，默认值=True

将 Catch22 变换产生的 NaN 或 inf 值替换为 0。

col_namesstr，取值范围 {“range”, “int_feat”, “str_feat”} 之一，可选，默认值=”range”

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

属性:
is_fitted

fit 方法是否已被调用。

另请参阅

Catch22
Catch22Classifier

参考文献

[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. .. [R7d980e05b412-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()

获取对象的配置标志。

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

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

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

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

set_tags(**tag_dict)

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

transform(X[, y])

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

update(X[, y, update_params])

使用 X（y 可选）更新变换器。
classmethod get_test_params(parameter_set='default')[source]#

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

参数:
parameter_setstr，默认值=”default”

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

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

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数:
method_namestr，可选

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

抛出:
NotFittedError

如果估计器尚未拟合。

clone()[source]#

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

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

等效于使用 self 的参数构造一个 type(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_tags 或 get_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=None)[source]#

对 X 拟合变换器，y 可选。

状态变化

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

写入对象自身

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

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

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

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合变换的数据。

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

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

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

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 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)[source]#

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

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

状态变化

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

写入对象自身：_is_fitted：标志设置为 True。_X：X，X 的强制拷贝，如果 remember_data 标签为 True

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

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

参数:
Xsktime 兼容数据容器格式的时间序列

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

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

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

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

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 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 行) | | 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，则返回值为 pd.DataFrame，其行数与 X 中的实例数相同。示例：返回值的第 i 行包含第 i 个时间序列的均值和方差。

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

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

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

从类获取类标签值，并继承父类的标签层级。

每个 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()[source]#

从类获取类标签，并继承父类的标签层级。

每个 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()[source]#

获取对象的配置标志。

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

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

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

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

返回值:
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deepbool，默认值=True

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

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

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

返回值:
fitted_params键为 str 类型的字典

已拟合参数字典，参数名: 参数值 键值对包括

  • 始终包含：此对象的所有已拟合参数，如通过 get_param_names 获取的那样，值是此对象该键的已拟合参数值

  • 如果 deep=True，还包含组件参数的键/值对，组件参数按 [组件名]__[参数名] 索引，组件名 的所有参数都以 参数名 及其值的形式出现

  • 如果 deep=True，还包含任意级别的组件递归，例如 [组件名]__[组件组件名]__[参数名] 等

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

参数字典，参数名: 参数值 键值对包括

  • 始终包含：此对象的所有参数，如通过 get_param_names 获取的那样，值是此对象该键的参数值，值始终与构造时传入的值相同

  • 如果 deep=True，还包含组件参数的键/值对，组件参数按 [组件名]__[参数名] 索引，组件名 的所有参数都以 参数名 及其值的形式出现

  • 如果 deep=True，还包含任意级别的组件递归，例如 [组件名]__[组件组件名]__[参数名] 等

get_tag(tag_name, tag_value_default=None, raise_error=True)[source]#

从实例获取标签值，并应用标签层级继承和覆盖。

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

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

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

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

在实例构建时。

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

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

按继承顺序。

参数:
tag_namestr

要检索的标签名称

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

如果未找到标签，则为默认/备用值

raise_errorbool

未找到标签时是否抛出 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()[source]#

从实例获取标签，并应用标签层级继承和覆盖。

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

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

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

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

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

在实例构建时。

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

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

按继承顺序。

返回值:
collected_tagsdict

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

inverse_transform(X, y=None)[source]#

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

当前假设只有带有以下标签的变换器

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

具有 inverse_transform 方法。

所需状态

要求状态为“已拟合”。

访问自身属性

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

  • self.is_fitted，必须为 True

参数:
Xsktime 兼容数据容器格式的时间序列

用于拟合变换的数据。

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

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

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

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

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

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

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

返回值:
X 的逆变换后版本

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

is_composite()[source]#

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

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

返回值:
composite: bool

对象是否有任何参数的值是 BaseObject 的后代实例。

property is_fitted[source]#

fit 方法是否已被调用。

检查对象的 _is_fitted` attribute，该属性在对象构建期间应初始化为 ``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) 输出的第 1 个元素
返回值:
反序列化的对象，结果输出为 serial，来自 cls.save(None)
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
set_config(**config_dict)[source]#

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

参数:
config_dictdict

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

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

jupyter kernels 如何显示对象本身的实例。

  • “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，默认值=True；False 阻止 ray 在并行化后。

      关闭。

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

    • “mute_warnings”：bool，默认值=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对象的引用。

注意事项

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

返回值:
self对象的引用（设置参数后）
set_random_state(random_state=None, deep=True, self_policy='copy')[source]#

为对象设置 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，将仅设置 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对象的引用
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回值:
对象本身

对象的引用。

transform(X, y=None)[source]#

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

所需状态

要求状态为“已拟合”。

访问自身属性

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

  • self.is_fitted，必须为 True

参数:
Xsktime 兼容数据容器格式的时间序列

要转换的数据。

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

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

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

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 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，则返回值为 pd.DataFrame，其行数与 X 中的实例数相同。示例：返回值的第 i 行包含第 i 个时间序列的均值和方差。

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

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

update(X, y=None, update_params=True)[source]#

使用 X（y 可选）更新变换器。

所需状态

要求状态为“已拟合”。

访问自身属性

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

  • self.is_fitted，必须为 True

写入对象自身

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

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

参数:
Xsktime 兼容数据容器格式的时间序列

用于更新转换的数据。

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

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

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

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

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

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

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

返回值:
self已拟合的估计器实例