ShapeletTransform#

类 ShapeletTransform(min_shapelet_length=3, max_shapelet_length=inf, max_shapelets_to_store_per_class=200, random_state=None, verbose=0, remove_self_similar=True)[source]#

Shapelet 变换。

原始期刊出版物：@article{hills2014classification,

title={Classification of time series by shapelet transformation}, author={Hills, Jon and Lines, Jason and Baranauskas, Edgaras and Mapp, James and Bagnall, Anthony}, journal={Data Mining and Knowledge Discovery}, volume={28}, number={4}, pages={851–881}, year={2014}, publisher={Springer}

}

参数：
min_shapelet_lengthint，候选
shapelet 长度的下限（默认为 3）
max_shapelet_lengthint，候选
shapelet 长度的上限（默认为 inf 或序列长度）
max_shapelets_to_store_per_classint，每个不同类别中保留的
shapelet 数量上限（默认为 200）
random_stateRandomState，int 或 none：控制
随机状态对象以获得确定性结果（默认为 None）
verboseint，打印到
控制台的输出级别（仅供参考）（默认为 0）
remove_self_similarboolean，从最终变换中移除重叠的
“自相似” shapelet（默认为 True）
属性：
predefined_ig_rejection_levelfloat，保留 shapelet 所需的最小信息增益
（默认为 0.05）
self.shapeletsShapelet 对象列表，
数据集处理后存储的 shapelet

方法

binary_entropy(num_this_class, num_other_class)

二元熵。

calc_binary_ig(orderline, ...)

二元信息增益。

calc_early_binary_ig(orderline, ...)

早期二元 IG。

check_is_fitted([method_name])

检查评估器是否已拟合。

clone()

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

clone_tags(estimator[, tag_names])

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

create_test_instance([parameter_set])

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

create_test_instances_and_names([parameter_set])

创建所有测试实例的列表以及它们的名称列表。

euclidean_distance_early_abandon(u, v, min_dist)

带有早期放弃的欧几里得距离。

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

访问器方法，返回提取的 shapelet。

get_tag(tag_name[, tag_value_default, ...])

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

get_tags()

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

get_test_params([parameter_set])

返回 skbase 对象的测试参数设置。

inverse_transform(X[, y])

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

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

remove_self_similar_shapelets(shapelet_list)

从输入列表中移除自相似的 shapelet。

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）更新变换器。

zscore(a[, axis, ddof])

返回序列的归一化版本。
静态 remove_self_similar_shapelets(shapelet_list)[source]#

从输入列表中移除自相似的 shapelet。

注意：此方法假定 shapelet 已按质量降序预先排序（即，如果两个候选对象自相似，则索引靠后的那个将被移除）

参数：
shapelet_list: Shapelet 对象列表
返回：
shapelet_list: Shapelet 对象列表
get_shapelets()[source]#

访问器方法，返回提取的 shapelet。

返回：
shapelets: Shapelet 对象列表
静态 binary_entropy(num_this_class, num_other_class)[source]#

二元熵。

二元熵。

二元信息增益。

静态 calc_binary_ig(orderline, total_num_this_class, total_num_other_class)[source]#

早期二元 IG。

二元信息增益。

返回序列的归一化版本。

静态 calc_early_binary_ig(orderline, num_this_class_in_orderline, num_other_class_in_orderline, num_to_add_this_class, num_to_add_other_class)[source]#

参数：
早期二元 IG。

静态 zscore(a, axis=0, ddof=0)[source]#

这与 scipy 实现类似，但有一个小区别 - 函数不返回 /0，而是返回 output = np.zeros(len(input))。这是为了允许对直线状的候选 shapelet/比较子序列进行合理的处理。原始版本：https://docs.scipy.org.cn/doc/scipy/reference/generated/scipy.stats .zscore.html

aarray_like

包含样本数据的 array 类似对象。

axisint 或 None，可选

返回：
操作轴。默认为 0。如果为 None，则在整个数组 a 上计算。

ddofint，可选

计算标准差时的自由度修正。默认为 0。

带有早期放弃的欧几里得距离。

zscorearray_like

检查评估器是否已拟合。

Z 分数，由输入数组 a 的均值和标准差进行标准化。

静态 euclidean_distance_early_abandon(u, v, min_dist)[source]#

参数：
带有早期放弃的欧几里得距离。

check_is_fitted(method_name=None)[source]#

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

如果不是，则引发 NotFittedError。

method_namestr，可选

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

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

引发：

如果评估器尚未拟合。

clone()[source]#

检查 _is_fitted 属性是否存在且为 True。在调用对象的 fit 方法时，is_fitted 属性应设置为 True。
克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等同于返回 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)[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 或 list of str，默认为 None

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

参数：
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

自身

返回：
对 self 的引用。
类方法 create_test_instance(parameter_set='default')[source]#

创建所有测试实例的列表以及它们的名称列表。

参数：
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

自身

返回：
parameter_setstr，默认为“default”

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

实例

带默认参数的类实例

类方法 create_test_instances_and_names(parameter_set='default')[source]#

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

对象列表

cls 实例列表

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

  • 名称列表

  • str 列表，与 objs 长度相同

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

参数：
fit(X, y=None)[source]#

状态变化

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

  • 写入自身

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list

对象列表

cls 实例列表

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

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

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

参数：
fit(X, y=None)[source]#

附加数据，例如用于变换的标签。如果 self.get_tag("requires_y") 为 True，则必须在 fit 中传递，不可选。所需格式请参阅类文档字符串了解详情。

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

  • 写入自身

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

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

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

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

用于拟合变换的数据。

返回：
自身
评估器的拟合实例
fit_transform(X, y=None)[source]#

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

写入自身：_is_fitted：标志设置为 True。_X：X 的强制副本，如果 remember_data 标签为 True
如果可能，可能会通过引用强制转换为内部类型或 update_data 兼容类型
模型属性（以“_”结尾）：取决于评估器

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

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 实例）。示例：Panel 中的所有序列都单独去趋势

  1. 如果 X 是 Series 或 Panel 且 transform-output 是

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

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

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

类方法 get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

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

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

返回：
在父类的 _tags 属性中设置的标签，

按继承顺序。

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

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

如果在 self 上设置了配置，克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

在值上也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。

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

tag_namestr

标签值的名称。

  1. 如果 X 是 Series 或 Panel 且 transform-output 是

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

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

tag_value_default任意类型

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

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

标签值

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

类方法 get_class_tags()[source]#

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

获取自身的配置标志。

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

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

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

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

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

收集的标签dict

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

获取拟合参数。

get_config()[source]#

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

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

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

  • 配置在 clone 或 reset 调用时保留。

  • 配置字典dict

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

get_fitted_params(deep=True)[source]#

  • 所需状态

  • 要求状态为“已拟合”。

  • deepbool，默认为 True

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

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

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

拟合参数键为 str 类型的 dict

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

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

参数：
如果 deep=True，还包含组件参数的键值对。组件参数按 [componentname]__[paramname] 索引，componentname 的所有参数以 paramname 及其值出现

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

返回：
类方法 get_param_defaults()[source]#

获取对象的参数默认值。

default_dict: dict[str, Any]

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

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

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

  • 类方法 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]#

是否返回组件的参数。

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

如果在 self 上设置了配置，克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

在值上也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。

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

  1. 如果为 False，将返回此对象的参数名称 : 值 dict，但不包括组件的参数。

参数键为 str 类型的 dict

  1. 如果 X 是 Series 或 Panel 且 transform-output 是

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

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

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

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

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

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

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

要检索的标签名称

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

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

如果在 self 上设置了配置，克隆也将具有与原始对象相同的配置，等同于调用 cloned_self.set_config(**self.get_config())。

在值上也等同于调用 self.reset，不同之处在于 clone 返回一个新对象，而不是像 reset 那样修改 self。

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

标签值的名称。

  1. 如果为 False，将返回此对象的参数名称 : 值 dict，但不包括组件的参数。

参数键为 str 类型的 dict

  1. 如果 X 是 Series 或 Panel 且 transform-output 是

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

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

返回：
raise_errorbool

未找到标签时是否引发 ValueError

标签值Any

返回 skbase 对象的测试参数设置。

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

ValueError，如果 raise_error 为 True。

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

get_tags()[source]#

参数：
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

自身

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

收集的标签dict

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

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

目前假定只有带有标签的转换器

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

拥有 inverse_transform 方法。

get_config()[source]#

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

在 self 中的访问项

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

  • self.is_fitted，必须为 True

参数：
fit(X, y=None)[source]#

状态变化

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

  • 写入自身

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

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

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

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

附加数据，例如用于转换的标签。一些转换器需要此信息，详细信息请参见类文档字符串。

返回：
X 的逆转换版本

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

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

从文件位置加载对象。

参数：
serialresult of ZipFile(path).open(“object)
返回：
反序列化后的 self，其输出在 path 处，等同于 cls.save(path) 的结果。
classmethod load_from_serial(serial)[source]#

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

参数：
serial1st element of output of cls.save(None)
返回：
反序列化后的 self，其输出为 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)) 后获得的对象相等。

返回：
当前的标签值可以通过 get_tags 或 get_tag 查看。

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

save(path=None, serialization_format='pickle')[source]#

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

行为：如果 path 为 None，则返回一个内存中的序列化对象自身；如果 path 是一个文件位置，则将自身以 zip 文件格式存储在该位置

保存的文件是 zip 文件，其内容如下：_metadata - 包含对象自身所属的类，即 type(self)；_obj - 序列化后的对象自身。此类使用默认的序列化方法 (pickle)。

参数：
pathNone or file location (str or Path)

如果为 None，则将 self 保存为内存对象；如果是文件位置，则将 self 保存到该文件位置。如果

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

  • path=”/home/stored/estimator” 则会在 /home/stored/ 存储一个 zip 文件 estimator.zip。

存储在 /home/stored/。

serialization_format: str, default = “pickle”

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

返回：
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向该文件的 ZipFile 对象。
set_config(**config_dict)[source]#

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

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

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

displaystr, “diagram” (default), or “text”

jupyter 内核如何显示 self 的实例。

  • “diagram” = html 框图表示

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

print_changed_onlybool, default=True

打印 self 时是否只列出与默认值不同的自身参数 (True)，还是列出所有参数名称和值 (False)。不进行嵌套，即只影响 self，不影响组件估计器。

warningsstr, “on” (default), or “off”

是否触发警告，仅影响来自 sktime 的警告。

  • “on” = 将触发来自 sktime 的警告

  • “off” = 将不触发来自 sktime 的警告

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行化的后端，可选值之一：

  • “None”: 按顺序执行循环，简单的列表推导

  • “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

  • “joblib”: 自定义和第三方 joblib 后端，例如 spark

  • “dask”: 使用 dask，要求环境中安装 dask 包

  • “ray”: 使用 ray，要求环境中安装 ray 包

backend:parallel:paramsdict, optional, default={} (no parameters passed)

作为配置传递给并行化后端的附加参数。有效键取决于 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”：字符串，默认为 “ray”；要使用的日志记录器名称。

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

input_conversionstr, one of “on” (default), “off”, or valid mtype string

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

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

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

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

output_conversionstr, one of “on”, “off”, valid mtype string

控制 _transform、_inverse_transform 的输出转换。

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

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

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

返回：
self对 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对 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 instance or None, default=None

用于控制随机整数生成的伪随机数生成器。传递 int 以在多次函数调用中获得可重现的输出。

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

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

  • 如果为 False，则仅设置 self 的 random_state 参数（如果存在）。

  • 如果为 True，则也会在组件对象中设置 random_state 参数。

self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”

  • “copy” : 将 self.random_state 设置为输入的 random_state。

  • “keep” : self.random_state 保持不变。

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

从输入的 random_state 派生而来，并且通常与它不同。

返回：
self对 self 的引用。
set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数：
**tag_dictdict

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

返回：
Self

对 self 的引用。

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

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

get_config()[source]#

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

在 self 中的访问项

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

  • self.is_fitted，必须为 True

参数：
fit(X, y=None)[source]#

要转换的数据。

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

  • 写入自身

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

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

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

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

附加数据，例如用于转换的标签。一些转换器需要此信息，详细信息请参见类文档字符串。

返回：
自身
评估器的拟合实例

转换

X

-输出

返回类型

Series

Primitives

pd.DataFrame (1行)

Panel

Primitives

pd.DataFrame

Series

Series

Series

Panel

Series

Panel

Series

Panel

Panel
写入自身：_is_fitted：标志设置为 True。_X：X 的强制副本，如果 remember_data 标签为 True
如果可能，可能会通过引用强制转换为内部类型或 update_data 兼容类型
模型属性（以“_”结尾）：取决于评估器

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

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 中的实例

  • 表中未列出的组合当前不受支持

明确说明，并举例

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

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

get_config()[source]#

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

在 self 中的访问项

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

  • self.is_fitted，必须为 True

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

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

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

参数：
fit(X, y=None)[source]#

用于更新转换的数据。

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

  • 写入自身

  • 设置以“_”结尾的拟合模型属性，拟合属性可通过 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。