ClaSPTransformer

class ClaSPTransformer(window_length=10, scoring_metric='ROC_AUC', exclusion_radius=0.05)

ClaSP（分类分数 профиль）转换器。

实现时间序列的分类分数剖面。ClaSP 将时间序列分层拆分为两部分，其中每个分割点通过为每个可能的分割点训练一个二元时间序列分类器来确定，并选择准确率最高的那个，即最擅长识别来自任一部分子序列的那个。

参数:

window_lengthint, 默认 = 10

滑动窗口的大小。

scoring_metricstring, 默认 = ROC_AUC

在 ClaSP 中使用的评分指标 - 从 ROC_AUC 或 F1 中选择

exclusion_radiusint

非平凡匹配的变点排除半径

属性:

is_fitted

fit 是否已被调用。

注意事项

如 @inproceedings{clasp2021 中所述，

title={ClaSP - Time Series Segmentation}, author={Sch”afer, Patrick and Ermshaus, Arik and Leser, Ulf}, booktitle={CIKM}, year={2021}

}

示例

>>> from sktime.transformations.series.clasp import ClaSPTransformer
>>> from sktime.detection.clasp import find_dominant_window_sizes
>>> from sktime.datasets import load_electric_devices_segmentation
>>> X, true_period_size, true_cps = load_electric_devices_segmentation()
>>> dominant_period_size = find_dominant_window_sizes(X) 
>>> clasp = ClaSPTransformer(window_length=dominant_period_size) 
>>> clasp.fit(X) 
>>> profile = clasp.transform(X) 

方法

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

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

参数:

parameter_setstr, 默认=”default”

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

返回:

paramsdict 或 list of 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 或 list of 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 个元素是测试中第 i 个 obj 实例的名称。如果多于一个实例，命名约定为 {cls.__name__}-{i}，否则为 {cls.__name__}。

fit(X, y=None)

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

状态改变

将状态更改为“fitted”。

写入自身

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

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

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

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

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

返回:

self估计器的拟合实例

fit_transform(X, y=None)

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

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

状态改变

将状态更改为“fitted”。

写入自身: _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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list

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

有关数据格式的更多详细信息，请参阅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)

从类中获取类标签值，并从父类继承标签级别。

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

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

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

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

返回:

config_dictdict

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

get_fitted_params(deep=True)

获取拟合参数。

所需状态

需要状态为“fitted”。

参数:

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_errorbool

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

返回:

tag_valueAny

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_tagsdict

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

inverse_transform(X, y=None)

逆转换 X 并返回逆转换版本。

目前假定只有具有标签

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

的转换器具有 inverse_transform 方法。

所需状态

需要状态为“fitted”。

访问自身中的属性

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

• self.is_fitted，必须为 True。

参数:

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

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

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

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

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

返回:

X 的逆转换版本

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

is_composite()

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

复合对象是指其参数值为其他 BaseObject 派生类实例的对象。在实例上调用，因为这可能因实例而异。

返回:

composite: bool

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

属性 is_fitted

fit 是否已被调用。

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

返回:

bool

评估器是否已被 fit。

类方法 load_from_path(serial)

从文件位置加载对象。

参数:

serialZipFile(path).open(“object) 的输出

返回:

反序列化后的自身，其输出位于 path，是 cls.save(path) 的结果

类方法 load_from_serial(serial)

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

参数:

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

返回:

反序列化后的自身，其输出为 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')

将序列化的自身保存到字节类对象或 (.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)

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

参数:

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

设置此对象的参数。

该方法适用于简单的 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')

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

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中、构建期间或通过 __init__ 直接在构建后调用。

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

参数:

**tag_dictdict

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

返回:

自身

自身的引用。

transform(X, y=None)

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

所需状态

需要状态为“fitted”。

访问自身中的属性

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

• self.is_fitted，必须为 True。

参数:

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

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

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

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

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

返回:

X 的转换版本。

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

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

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

所需状态

需要状态为“fitted”。

访问自身中的属性

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

• 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 = 时间序列集合。具有 2 级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list

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

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

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

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

返回:

self估计器的拟合实例