FinancialHolidaysTransformer#

class FinancialHolidaysTransformer(market, years=None, expand=True, observed=True, name=None)[source]#

金融假日转换器。

此实现包装了 vacanza 的 holidays [1]。

根据 X 的索引，提取日期并传递给 holidays。然后根据传递的金融市场信息生成该日期（或没有假日）的假日信息后，准备一个布尔序列，其中 True 表示该日期是假日，否则为 False。fit 对于此转换器是空操作。

参数:

marketstr: 一个 ISO 3166-1 Alpha-2 市场代码 [2]；并非所有国家都已实现（请参阅文档 [3]）。
yearsUnion[int, Iterable[int]], optional: 实例化时用于预先计算公共假日的年份。
expandbool, optional: 当请求该年份的一个日期时，是否计算整个年份。
observedbool, optional: 是否包含公共假期的观察日期（例如，星期日遇到的假期在下周一进行观察）。False 可能不适用于所有国家/地区。
namestr, optional: 转换后序列的名称。

属性:

is_fitted: 是否已调用 fit。

说明

如果缺少 name（默认），则自动填充为 {market}_holidays。

参考文献

[1]

vacanza/python-holidays

[2]

https://www.iso20022.org/market-identifier-codes

[3]

https://python-holidays.readthedocs.io/en/stable/#available-financial-markets

示例

>>> from sktime.transformations.series.holiday import FinancialHolidaysTransformer
>>>
>>> import numpy
>>> data = numpy.random.default_rng(seed=0).random(size=365)
>>>
>>> import pandas
>>> index = pandas.date_range(start="2023-01-01", end="2023-12-31", freq="D")
>>>
>>> y = pandas.Series(data, index=index, name="random")
>>>
>>> y_t = FinancialHolidaysTransformer("XNYS").fit_transform(y)  
>>> y_t.dtype  
dtype('bool')
>>> y_t.sum()  
10
>>> y_t.name  
'XNYS_holidays'

方法

`check_is_fitted`([方法名称])	检查评估器是否已拟合。
`clone`()	获取具有相同超参数和配置的对象的克隆。
`clone_tags`(estimator[, 标签名称])	将其他对象的标签克隆为动态覆盖。
`create_test_instance`([参数集])	使用第一个测试参数集构造类的一个实例。
`create_test_instances_and_names`([参数集])	创建所有测试实例的列表及其名称列表。
`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`([参数集])	返回评估器的测试参数设置。
`inverse_transform`(X[, y])	逆向转换 X 并返回逆向转换后的版本。
`is_composite`()	检查对象是否由其他 BaseObject 组成。
`load_from_path`(serial)	从文件位置加载对象。
`load_from_serial`(serial)	从序列化内存容器加载对象。
`reset`()	将对象重置为干净的初始化后状态。
`save`([path, serialization_format])	将序列化的 self 保存到字节类对象或 (.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 列表, 默认值 = {}: 创建类测试实例的参数

引发:

ValueError: 如果提供了未知的 parameter_set。

check_is_fitted(method_name=None)[source]#

检查评估器是否已拟合。

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

如果未拟合，则引发 NotFittedError。

参数:

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

引发:

NotFittedError: 如果评估器尚未拟合。

clone()[source]#

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

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

引发:

如果克隆不符合规范，则会引发 RuntimeError，原因在于 __init__ 错误。

clone_tags(estimator, tag_names=None)[source]#

将其他对象的标签克隆为动态覆盖。

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

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

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

clone_tags 方法只能在对象构造期间或构造后通过 __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])
names字符串列表，长度与 objs 相同: 第 i 个元素是测试中第 i 个 obj 实例的名称。命名约定为 {cls.__name__}-{i}（如果有多个实例），否则为 {cls.__name__}

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

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

状态改变: 将状态更改为“已拟合”（fitted）。

写入 self

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 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), list 类型为 Series 的 pd.DataFrame
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 的转换版本。

状态改变: 将状态更改为“已拟合”（fitted）。

写入 self：_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 (instance, time), 3D np.ndarray (instance, variable, time), list 类型为 Series 的 pd.DataFrame
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 （单行） | | 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 的标签值，考虑标签覆盖，优先级按降序排列，顺序如下：

在类的 _tags 属性中设置的标签。
在父类的 _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 属性的键。

值是相应的标签值，覆盖顺序按降序排列，如下：

在类的 _tags 属性中设置的标签。
在父类的 _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]#

获取拟合参数。

所需状态: 要求状态为“已拟合”（fitted）。

参数:

deepbool，默认值为 True

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

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

返回:

fitted_params键为 str 的字典

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

总是：此对象的所有已拟合参数，如通过 get_param_names 所获；值是此对象该键对应的已拟合参数值
如果 deep=True，也包含组件参数的键/值对；组件的参数索引方式为 [componentname]__[paramname]；componentname 的所有参数以 paramname 的形式出现，带有其对应的值
如果 deep=True，也包含任意层级的组件递归，例如 [componentname]__[componentcomponentname]__[paramname] 等

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

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

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

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

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

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

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

在实例构建时设置。

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

按继承顺序排列。

参数:

tag_namestr: 要检索的标签名称
tag_value_default任意类型，可选；默认值为 None: 如果未找到标签，则使用的默认值/回退值
raise_errorbool: 未找到标签时是否引发 ValueError

返回:

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

引发:

如果 raise_error 为 True，则为 ValueError。: 如果 tag_name 不在 self.get_tags().keys() 中，则引发 ValueError。

get_tags()[source]#

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

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

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

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

值是相应的标签值，覆盖顺序按降序排列，如下：

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

在实例构建时设置。

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

按继承顺序排列。

返回:

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

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

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

目前假设只有带有标签的转换器: “scitype:transform-input”=”Series”，”scitype:transform-output”=”Series”，

具有 inverse_transform 方法。

所需状态: 要求状态为“已拟合”（fitted）。

self 中的访问项

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

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), list 类型为 Series 的 pd.DataFrame
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` 属性，该属性在对象构建期间应初始化为 ``False，并在调用对象的 fit 方法时设置为 True。

返回:

bool: 估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回:

反序列化的 self，其结果输出到 path，是 cls.save(path) 的输出

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回:

反序列化的 self，其结果输出 serial，是 cls.save(None) 的输出

reset()[source]#

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

将 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')[source]#

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

行为：如果 path 为 None，则返回一个内存中的序列化 self；如果 path 是一个文件位置，则将 self 作为 zip 文件存储在该位置

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

参数:

pathNone 或文件位置（str 或 Path）

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

path=”estimator”，则将在当前工作目录创建 zip 文件 estimator.zip。
path=”/home/stored/estimator”，则将创建 zip 文件 estimator.zip

存储在 /home/stored/ 中。

serialization_format: str，默认值为 “pickle”

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

返回:

如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向文件的 ZipFile 对象

set_config(**config_dict)[source]#

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

参数:

config_dictdict

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

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

jupyter 内核如何显示 self 的实例

“diagram” = html 框图表示
“text” = 字符串输出

print_changed_onlybool，默认值为 True

打印 self 时，是仅列出与默认值不同的自变量参数（True），或列出所有参数名称和值（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”：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对 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 中的 random_state 参数（取决于 self_policy），以及剩余的组件对象（当且仅当 deep=True 为 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对 self 的引用

set_tags(**tag_dict)[source]#

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

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

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

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

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

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

参数:

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

返回:

Self: 对 self 的引用。

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

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

所需状态: 要求状态为“已拟合”（fitted）。

self 中的访问项

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

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), list 类型为 Series 的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

额外数据，例如转换的标签。某些转换器需要此数据，详细信息请参阅类文档字符串。

返回:

X 的转换版本
类型取决于 X 的类型和 scitype:transform-output 标签

	transform
X	-output	返回类型
Series	Primitives	pd.DataFrame （单行）
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。

所需状态: 要求状态为“已拟合”（fitted）。

self 中的访问项

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

self.is_fitted，必须为 True

写入 self

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

如果 remember_data 标签为 True，则写入 self._X，通过 update_data 使用 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), list 类型为 Series 的 pd.DataFrame
Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

额外数据，例如转换的标签。某些转换器需要此数据，详细信息请参阅类文档字符串。

返回:

self估计器的已拟合实例