SFA

class SFA(word_length=8, alphabet_size=4, window_size=12, norm=False, binning_method='equi-depth', anova=False, bigrams=False, skip_grams=False, remove_repeat_words=False, levels=1, lower_bounding=True, save_words=False, keep_binning_dft=False, return_pandas_data_series=False, use_fallback_dft=False, typed_dict=False, n_jobs=1)

符号傅里叶近似 (SFA) 变换器。

概述: 对于每个序列

在序列上运行滑动窗口 对每个窗口

使用 DFT 缩短序列 使用 MFC 将缩短的序列离散化到 bin 中 根据这些离散值形成一个词

默认情况下，SFA 为每个序列生成一个词 (window_size=0) 如果使用窗口，它会形成一个词频直方图。

参数:

word_length: int, default = 8

缩短窗口的词长度 (使用 PAA)

alphabet_size: int, default = 4

用于离散化每个值的数值个数

window_size: int, default = 12

滑动窗口的大小。对于整个序列变换，这是输入序列的长度

norm: boolean, default = False

通过丢弃第一个傅里叶系数来均值归一化词

binning_method: {“equi-depth”, “equi-width”, “information-gain”, “kmeans”},

default=”equi-depth”

用于确定断点（breakpoints）的分箱方法。

anova: boolean, default = False

如果为 True，傅里叶系数的选择通过单因素方差分析（ANOVA test）完成。如果为 False，选择前几个傅里叶系数。仅在给出标签时适用。

bigrams: boolean, default = False

是否创建 SFA 词的二元词 (bigrams)

skip_grams: boolean, default = False

是否创建 SFA 词的跳跃词 (skip-grams)

remove_repeat_words: boolean, default = False

是否使用数值约简 (numerosity reduction) (默认为 False)

levels: int, default = 1

空间金字塔（spatial pyramid）的级别数

save_words: boolean, default = False

是否保存为每个序列生成的词 (默认为 False)

return_pandas_data_series: boolean, default = False

设置为 True 将返回 Pandas Series 作为转换结果。设置为 True 会显著降低速度，但自动化测试需要此设置。

n_jobs: int, optional, default = 1

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

属性:

words: []

breakpoints: = []

num_insts = 0

num_atts = 0

参考

[1]

Schäfer, Patrick 和 Mikael Högqvist。“SFA：高维数据相似性搜索的符号傅里叶近似和索引。”第15届数据库技术扩展国际会议论文集。2012年。

Methods

方法

bag_to_string(bag)	将 SFA 词袋转换为字符串。
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])	使用 MCB 或 IGB 计算词断点。
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）更新转换器。
word_list(word)	找到获取输入词的整数列表。
word_list_typed(word)	找到获取输入词的整数列表。

fit(X, y=None)

使用 MCB 或 IGB 计算词断点。

参数:

Xpandas DataFrame 或 3 维 numpy 数组，输入时间序列。

yarray_like，目标值 (可选，忽略)。

返回:

self: object

bag_to_string(bag)

将 SFA 词袋转换为字符串。

将 SFA 词袋转换为字符串。

找到获取输入词的整数列表。

word_list(word)

找到获取输入词的整数列表。

word_list_typed(word)

检查评估器是否已拟合。

检查评估器是否已拟合。检查 _is_fitted 属性是否存在且为 True。is_fitted 属性应在对象的 fit 方法调用中设置为 True。

如果没有，则引发 NotFittedError。

参数:

method_namestr, optional

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

引发:

NotFittedError

如果评估器尚未拟合。

clone()

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

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

等同于使用 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)

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

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

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

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

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

tag_names 的默认值将 estimator 中的所有标签写入 self。

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

estimatorAn instance of :class:BaseObject or derived class

参数:

tag_namesstr or list of str, default = None

要克隆的标签名称。默认值 (None) 克隆来自 estimator 的所有标签。

self

返回:

对 self 的引用。

classmethod create_test_instance(parameter_set='default')

parameter_setstr, default=”default”

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

参数:

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

instanceinstance of the class with default parameters

返回:

classmethod create_test_instances_and_names(parameter_set='default')

objslist of instances of cls

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

参数:

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

instanceinstance of the class with default parameters

返回:

i-th instance is cls(**cls.get_test_params()[i])

nameslist of str, same length as objs

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

fit_transform(X, y=None)

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

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

状态改变

将状态更改为“fitted”。

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

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

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

Xtime series in sktime compatible data container format

参数:

要拟合转换的数据，以及要转换的数据。

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

Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray（1维或2维）

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

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

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

yoptional, data in sktime compatible data format, default=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 实例）。示例：Panel 中的所有序列都分别进行去趋势。

• 如果 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_defaultany type, optional; default=None

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

返回:

tag_value

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

classmethod get_class_tags()

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

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

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

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, default=True

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

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

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

返回:

fitted_paramsdict with str-valued keys

拟合参数字典，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, default=True

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

返回:

param_names: list[str]

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

get_params(deep=True)

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

参数:

deepbool, default=True

是否返回组件的参数。

• 如果 True，将返回一个参数名:值的 dict，包含此对象的参数，以及组件的参数（= BaseObject 类型参数）。

• 如果 False，将返回一个参数名:值的 dict，包含此对象的参数，但不包含组件的参数。

返回:

params类型为 str 键的字典

参数字典，键值对为 参数名 : 参数值，包含

• 总是：此对象的所有参数，通过 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 的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

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

方法 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 的对象都有一个标签字典。标签可用于存储对象的元数据或控制对象的行为。

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

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

值是相应的标签值，优先级从高到低进行覆盖：

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

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

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

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

按照继承顺序。

返回:

collected_tags字典

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

classmethod get_test_params(parameter_set='default')

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

参数:

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

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

返回:

params字典或字典列表，默认 = {}

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

inverse_transform(X, y=None)

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

目前假定只有带有标签

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

的转换器具有 inverse_transform 方法。

所需状态

需要状态为“fitted”。

在 self 中访问

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

• self.is_fitted，必须为 True

参数:

要拟合转换的数据，以及要转换的数据。

要进行逆转换的数据。

Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray（1维或2维）

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

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

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

yoptional, data in sktime compatible data format, default=None

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

额外数据，例如用于转换的标签。一些转换器需要此参数，详情见类文档字符串。

返回:

X 的逆转换版本

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

is_composite()

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

复合对象是指包含其他对象作为参数的对象。在实例上调用，因为不同实例可能不同。

返回:

composite: 布尔值

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

property is_fitted

是否已调用 fit。

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

返回:

布尔值

评估器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回:

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

classmethod load_from_serial(serial)

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

参数:

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

返回:

对 self 进行反序列化，生成 cls.save(None) 的输出 serial

reset()

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

导致将 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')

将序列化的自身保存到类字节对象或 (.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: 字符串，默认 = “pickle”

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

返回:

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

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

set_config(**config_dict)

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

参数:

config_dictdict

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

display字符串，“diagram”（默认）或“text”

jupyter 内核如何显示 self 实例

• “diagram” = html 框图表示

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

print_changed_only布尔值，默认=True

打印 self 时是否仅列出自默认值不同的 self 参数 (False)，或所有参数名称和值 (False)。不进行嵌套，即仅影响 self 而不影响组件评估器。

warnings字符串，“on”（默认）或“off”

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

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

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

backend:parallel字符串，可选，默认=”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”：字符串，默认=”ray”；要使用的日志记录器的名称。

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

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

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

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

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

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

output_conversion字符串，以下之一：“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>，例如，没有两个组件参数的名称是 <parameter>。

参数:

**params字典

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

返回:

self对 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_state整数, RandomState 实例或 None, 默认=None

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

deepbool, default=True

是否在 skbase 对象值参数（即组件评估器）中设置随机状态。

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

• 如果为 True，也将设置组件对象中的 random_state 参数。

self_policy字符串，以下之一：{“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__ 之后调用。

estimatorAn instance of :class:BaseObject or derived class

参数:

**tag_dict字典

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

返回:

Self

对 self 的引用。

transform(X, y=None)

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

所需状态

需要状态为“fitted”。

在 self 中访问

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

• self.is_fitted，必须为 True

参数:

要拟合转换的数据，以及要转换的数据。

要转换的数据。

Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray（1维或2维）

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

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

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

yoptional, data in sktime compatible data format, default=None

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

额外数据，例如用于转换的标签。一些转换器需要此参数，详情见类文档字符串。

返回:

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

X | tf-output | 返回类型 |

	转换
X	-输出	返回类型
时间序列	原语	pd.DataFrame (1 行)
面板数据	原语	pd.DataFrame
时间序列	时间序列	时间序列
面板数据	时间序列	面板数据
时间序列	面板数据	面板数据

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

表中未包含的组合目前不支持

明确说明，并提供示例

• 如果 X 是 Series（例如 pd.DataFrame），

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

• 如果 X 是 Panel（例如 pd-multiindex），且 transform-output

是 Series，则返回与 X 实例数量相同的 Panel（转换器应用于每个输入的 Series 实例）。示例：Panel 中的所有序列都分别进行去趋势。

• 如果 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 中访问

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

• self.is_fitted，必须为 True

写入 self

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

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

参数:

要拟合转换的数据，以及要转换的数据。

用于更新转换器的数据

Series scitype = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray（1维或2维）

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

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

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

yoptional, data in sktime compatible data format, default=None

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

额外数据，例如用于转换的标签。一些转换器需要此参数，详情见类文档字符串。

返回:

self评估器的已拟合实例