去季节化器#

class Deseasonalizer(sp=1, model='additive')[source]#

从时间序列中移除季节性成分。

应用 statsmodels.tsa.seasonal.seasonal_compose 并在 transform 中移除 seasonal 成分。在 inverse_transform 中重新添加回季节性成分。季节性移除可以是加法模型或乘法模型。

fit 计算季节性成分并将其存储在 seasonal_ 属性中。

transform 将存储在 seasonal_ 中的季节性成分与传入时间序列的时间索引对齐，然后从传入时间序列中减去它们（“加法”模型）或用传入时间序列除以它们（“乘法”模型）。

参数:

sp整数，默认为1: 季节周期性。
model{"加法", "乘法"}，默认为"加法": 用于估计季节性成分的模型。

属性:

seasonal_长度为 sp 的数组: 在季节性分解中计算出的季节性成分。

另请参阅

ConditionalDeseasonalizer

注意事项

关于季节性成分以及加法模型与乘法模型的进一步解释，请参阅《预测：原理与实践》。季节性分解使用`statsmodels

<https://statsmodels.pythonlang.cn/stable/generated/statsmodels.tsa.seasonal.seasonal_decompose.html>`_。

示例

>>> from sktime.transformations.series.detrend import Deseasonalizer
>>> from sktime.datasets import load_airline
>>> y = load_airline()  
>>> transformer = Deseasonalizer()  
>>> y_hat = transformer.fit_transform(y)  

方法

`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])	将序列化后的自身保存为bytes-like对象或(.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_set字符串，默认为“default”: 要返回的测试参数集名称，用于测试。如果某个值没有定义特殊参数，将返回 "default" 集。目前变换器没有保留值。

返回值:

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

check_is_fitted(method_name=None)[source]#

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数:

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

抛出异常:

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

clone()[source]#

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

克隆是一个不同的对象，没有共享引用，处于初始化后状态。此函数等同于返回 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_names字符串或字符串列表，默认为 None: 要克隆的标签名称。默认值 (None) 克隆 estimator 的所有标签。

返回值:

自身: 对 self 的引用。

classmethod create_test_instance(parameter_set='default')[source]#

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

参数:

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

返回值:

instance具有默认参数的类实例

classmethod create_test_instances_and_names(parameter_set='default')[source]#

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

参数:

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

返回值:

objscls 的实例列表: 第 i 个实例是 cls(**cls.get_test_params()[i])
names字符串列表，与 objs 长度相同: 第 i 个元素是测试中 obj 的第 i 个实例的名称。命名约定是 {cls.__name__}-{i} (如果实例多于一个)，否则是 {cls.__name__}

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

将变换器拟合到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 科学类型 = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel 科学类型 = 时间序列集合。pd.DataFrame，行索引为两级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 包含 Series 类型 pd.DataFrame 的对象。
Hierarchical 科学类型 = 分层时间序列集合。pd.DataFrame，行索引为三级或更多级 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 的变换后版本。

状态变更: 将状态变更为“已拟合”。

写入自身: _is_fitted : 标志设置为 True。 _X : X 的强制转换副本，如果 remember_data 标签为 True

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

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

参数:

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

用于拟合和变换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series 科学类型 = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel 科学类型 = 时间序列集合。pd.DataFrame，行索引为两级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 包含 Series 类型 pd.DataFrame 的对象。
Hierarchical 科学类型 = 分层时间序列集合。pd.DataFrame，行索引为三级或更多级 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 | 变换输出 | 返回类型 |

|----------|————–|------------------------| | 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)[source]#

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

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

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

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

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

按继承顺序。

不考虑在实例上通过 set_tags 或 clone_tags 设置的实例动态标签覆盖。

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

参数:

tag_name字符串: 标签值的名称。
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_tags字典: 标签名称 : 标签值对的字典。通过嵌套继承从 _tags 类属性收集。不受通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取对象的配置标志。

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

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

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

在 clone 或 reset 调用下，配置会被保留。

返回值:

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

get_fitted_params(deep=True)[source]#

获取已拟合参数。

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

参数:

deep布尔值，默认为 True

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

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

返回值:

fitted_params键为字符串的字典

已拟合参数的字典，参数名 : 参数值键值对包含

始终: 此对象的所有已拟合参数，通过 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]#

获取对象的参数名称。

参数:

sort布尔值，默认为 True: 是否按字母顺序返回参数名称 (True)，或按它们在类 __init__ 中出现的顺序返回 (False)。

返回值:

param_names: list[str]: cls 的参数名称列表。如果 sort=False，则按它们在类 __init__ 中出现的顺序排列。如果 sort=True，则按字母顺序排列。

get_params(deep=True)[source]#

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

参数:

deep布尔值，默认为 True

是否返回组件的参数。

如果 True，将返回此对象的参数名 : 参数值字典，包括组件的参数 (= BaseObject 值参数)。
如果 False，将返回此对象的参数名 : 参数值字典，但不包括组件的参数。

返回值:

params键为字符串的字典

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

始终: 此对象的所有参数，通过 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_name字符串: 要检索的标签名称
tag_value_default任何类型，可选；默认为 None: 找不到标签时的默认/备用值
raise_error布尔值: 找不到标签时是否抛出 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()[source]#

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

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

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

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

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

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

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

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

按继承顺序。

返回值:

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

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

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

目前假定只有带有标签: “scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,

的变换器具有 inverse_transform。

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

访问自身属性

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

self.is_fitted，必须为 True

参数:

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

用于拟合和变换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series 科学类型 = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel 科学类型 = 时间序列集合。pd.DataFrame，行索引为两级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 包含 Series 类型 pd.DataFrame 的对象。
Hierarchical 科学类型 = 分层时间序列集合。pd.DataFrame，行索引为三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

返回值:

X 的逆变换后版本: 与 X 类型相同，并符合 mtype 格式规范

is_composite()[source]#

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

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

返回值:

composite: 布尔值: 对象是否有任何参数的值是 BaseObject 的派生实例。

property is_fitted[source]#

fit 是否已调用。

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

返回值:

布尔值: 估计器是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:

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

返回值:

反序列化后的自身，结果是在 path 路径下的输出，它是 cls.save(path) 的结果

classmethod load_from_serial(serial)[source]#

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

参数:

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

返回值:

反序列化后的自身，结果是输出 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))`` 后获取的对象相同。

返回值:

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

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

将序列化后的自身保存为bytes-like对象或(.zip)文件。

行为: 如果 path 为 None，返回内存中的序列化自身；如果 path 是文件位置，则将自身保存到该位置作为 zip 文件。

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

参数:

pathNone 或文件位置 (str 或 Path)

如果为 None，自身将保存到内存对象中。如果是文件位置，自身将保存到该文件位置。

如果 path=”estimator”，则将在当前工作目录创建一个 zip 文件 estimator.zip。
如果 path=”/home/stored/estimator”，则将在 /home/stored/ 中存储一个 zip 文件 estimator.zip。

serialization_format: 字符串，默认为 “pickle”

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

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

返回值:

如果 path 是文件位置 - ZipFile，引用文件
set_config(**config_dict)[source]#

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

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

参数:

config_dict字典

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

jupyter kernel 如何显示 self 的实例

“diagram” = html 框图表示

“text” = 字符串打印输出
print_changed_only布尔值，默认为 True

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”，则执行输出转换

控制 _transform 和 _inverse_transform 的输出转换

"on" - 如果 input_conversion 为 "on"，则执行输出转换
"off" - 直接返回 _transform 和 _inverse_transform 的输出
有效的 mtype 字符串 - 输出转换为指定的 mtype

返回值:

self指向自身的引用。

注意事项

改变对象状态，将 config_dict 中的配置复制到 self._config_dynamic。

set_params(**params)[source]#

设置此对象的参数。

此方法适用于简单的 skbase 对象以及复合对象。参数关键字字符串 <component>__<parameter> 可用于复合对象（即包含其他对象的对象），以访问组件 <component> 中的 <parameter>。如果引用明确（例如，没有两个组件参数名称相同），则也可以使用不带 <component>__ 的字符串 <parameter>。

参数:

**paramsdict: BaseObject 参数，关键字必须是 <component>__<parameter> 字符串。__ 后缀可以在 get_params 关键字中唯一时作为完整字符串的别名。

返回值:

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 实例或 None, 默认值=None

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

deep布尔值，默认为 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)[source]#

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

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

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

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

应该只在对象的 __init__ 方法中，在构建过程中，或在通过 __init__ 构建后直接调用 set_tags 方法。

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

参数:

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

返回值:

Self: 指向自身的引用。

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

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

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

访问自身属性

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

self.is_fitted，必须为 True

参数:

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

要转换的数据。

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series 科学类型 = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel 科学类型 = 时间序列集合。pd.DataFrame，行索引为两级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 包含 Series 类型 pd.DataFrame 的对象。
Hierarchical 科学类型 = 分层时间序列集合。pd.DataFrame，行索引为三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

返回值:

X 的变换后版本
类型取决于 X 的类型和 scitype:transform-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 实例)。示例: 面板中的所有时间序列单独进行去趋势

如果 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。

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

访问自身属性

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

self.is_fitted，必须为 True

写入自身

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

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

参数:

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

用于更新转换的数据

sktime 中的单个数据格式是所谓的 mtype 规范，每个 mtype 实现一个抽象的 scitype。

Series 科学类型 = 单个时间序列。pd.DataFrame、pd.Series 或 np.ndarray (1D 或 2D)
Panel 科学类型 = 时间序列集合。pd.DataFrame，行索引为两级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，list 包含 Series 类型 pd.DataFrame 的对象。
Hierarchical 科学类型 = 分层时间序列集合。pd.DataFrame，行索引为三级或更多级 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

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

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

返回值:

self估计器的已拟合实例