SAXlegacy

class SAXlegacy(word_length=8, alphabet_size=4, window_size=12, remove_repeat_words=False, save_words=False, return_pandas_data_series=True)

符号集合近似 (SAX) 变换器。

如 Jessica Lin, Eamonn Keogh, Li Wei 和 Stefano Lonardi 在“Experiencing SAX: a novel symbolic representation of time series” Data Mining and Knowledge Discovery, 15(2):107-144 中所述 概述：对于每个序列

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

使用 PAA (分段近似聚合) 缩短序列 将缩短后的序列离散化为固定 bin 从这些离散值形成一个词

默认情况下，SAX 为每个序列生成一个单词 (window_size=0)。SAX 返回一个 pandas 数据帧，其中第 0 列是每个序列的直方图 (稀疏 pd.series)。

参数:

word_length: int，用于将窗口缩短到的单词长度 (使用

PAA) (默认值 8)

alphabet_size: int，用于离散化每个值的数值数量

为 (默认值 4)

window_size: int，滑动窗口的大小。输入序列

长度用于整个序列变换 (默认值 12)

remove_repeat_words: boolean，是否使用数值约简 (

默认值 False)

save_words: boolean，是否使用数值约简 (

默认值 False)

return_pandas_data_series: boolean，默认值 = True

设置为 true 以返回 Pandas Series 作为变换结果。设置为 true 会显著降低速度，但对于自动测试是必需的。

属性:

words: history = []

方法

check_is_fitted([method_name])	检查评估器是否已拟合。
克隆()	获取一个具有相同超参数和配置的对象的克隆。
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_fitted_params([deep])	获取拟合参数。
获取参数默认值()	获取对象的参数默认值。
get_param_names([sort])	获取对象的参数名称。
get_params([deep])	获取此对象的参数值字典。
get_tag(tag_name[, tag_value_default, ...])	从实例中获取标签值，带有标签级别继承和覆盖。
获取标签()	从实例中获取标签，带有标签级别继承和覆盖。
get_test_params([parameter_set])	返回评估器的测试参数设置。
inverse_transform(X[, y])	对 X 进行逆变换并返回逆变换后的版本。
是否为复合对象()	检查对象是否由其他 BaseObjects 组成。
load_from_path(serial)	从文件位置加载对象。
load_from_serial(serial)	从序列化内存容器加载对象。
重置()	将对象重置到干净的初始化后状态。
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。在调用对象的fit方法时，应将is_fitted属性设置为True。

如果不是，则引发NotFittedError。

参数:

method_namestr，可选

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

引发:

NotFittedError

如果评估器尚未拟合。

clone()

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

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

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

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

fit(X, y=None)

将变换器拟合到 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型pd.DataFrame的list

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

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

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

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

返回值:

self评估器的一个已拟合实例

fit_transform(X, y=None)

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

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

状态变更

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

写入自身： _is_fitted：标志设置为 True。_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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型pd.DataFrame的list

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

有关数据格式的更多详细信息，请参见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，则返回一个行数与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兼容对象都有一个标签字典，用于存储对象的元数据。

The get_class_tag method is a class method, and retrieves the value of a tag taking into account only class-level tag values and overrides.

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

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

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

按继承顺序。

Does not take into account dynamic tag overrides on instances, set via set_tags or clone_tags, that are defined on instances.

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

参数:

tag_namestr

标签值的名称。

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

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

返回值:

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 方法。

Does not take into account dynamic tag overrides on instances, set via set_tags or clone_tags, that are defined on instances.

要包含来自动态标签的覆盖，请使用 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)

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:

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 方法。

所需状态

要求状态为“已拟合”。

访问自身中的内容

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

• 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型pd.DataFrame的list

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

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

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

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

返回值:

X 的逆变换版本

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

is_composite()

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

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

返回值:

composite: 布尔值 (bool)

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

property is_fitted

fit 是否已被调用。

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

返回值:

布尔值 (bool)

估计器是否已 fit。

classmethod load_from_path(serial)

从文件位置加载对象。

参数:

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

返回值:

cls.save(path) 在 path 生成的输出，经过反序列化的 self。

classmethod load_from_serial(serial)

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

参数:

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

返回值:

cls.save(None) 生成的输出 serial，经过反序列化的 self。

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，则返回一个内存中的序列化 self；如果 path 是文件位置，则将 self 存储为 zip 文件在该位置。

保存的文件是 zip 文件，包含以下内容：_metadata - 包含 self 的类，即 type(self)；_obj - 序列化的 self。此类使用默认序列化方法 (pickle)。

参数:

pathNone 或文件位置 (str 或 Path)

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

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

• path=”/home/stored/estimator”，则会在 /home/stored/ 存储一个名为 estimator.zip 的 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 时是仅列出与默认值不同的自参数（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: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”：布尔值，默认值=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>。如果引用明确（例如，没有两个组件参数同名 <parameter>），也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**paramsdict

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_stateint、RandomState 实例或 None，默认值=None

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

deepbool，默认值=True

是否设置 skbase 对象值参数（即组件估计器）中的 random state。

• 如果为 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，

派生自输入的 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_dictdict

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

返回值:

Self

对 self 的引用。

transform(X, y=None)

变换 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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型pd.DataFrame的list

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

有关数据格式的更多详细信息，请参见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，则返回一个行数与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.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 (实例, 时间), 3D np.ndarray (实例, 变量, 时间), Series 类型pd.DataFrame的list

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

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

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

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

返回值:

self评估器的一个已拟合实例