Differencer#

class Differencer(lags=1, na_handling='fill_zero', memory='all')[source]#

对时间序列应用迭代差分。

该变换适用于单变量和多变量时间序列。但是，多变量情况对每个序列应用相同的差分。

差分变换按照提供的顺序在指定的滞后处应用。

例如，给定一个具有月度周期性的时间序列，使用 lags=[1, 12] 相当于应用标准一阶差分来处理趋势，然后应用季节性差分（在滞后 12 处）以尝试解释季节性依赖性。

要在同一滞后处提供更高阶差分，请多次列出该滞后。例如，lags=[1, 1] 进行迭代的一阶差分，这可能对于二阶积分的序列是必需的。

参数：
lagsint 或 array-like，默认 = 1

用于对数据进行差分的滞后。如果是一个 int 值，则

na_handlingstr，可选，默认 = “fill_zero”

如何处理差分后出现在序列开头的 NaNs 例如：长度为 4 的序列只有 3 个差分，

对 [a, b, c, d] 进行差分得到 [?, b-a, c-b, d-c]，因此我们需要确定“？”（= 未知值）如何处理

“drop_na” - 丢弃未知值，缩短序列 “keep_na” - 未知值被替换为 NaN “fill_zero” - 未知值被替换为零

memorystr，可选，默认 = “all”

记住之前看到多少 X，以便精确重建逆变换 “all”：评估器记住所有 X，逆变换对于所有已见索引都是正确的 “latest”：评估器只记住未来重建所需的最新 X

fit 后任何时间戳的逆变换都是正确的，但不是过去的时间戳

“none”：评估器不记住任何 X，逆变换是直接累加

属性：
is_fitted

是否已调用 fit。

示例

>>> from sktime.transformations.series.difference import Differencer
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = Differencer(lags=[1, 12])
>>> y_transform = 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()

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

inverse_transform(X[, y])

对 X 进行逆变换并返回逆变换版本。

is_composite()

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

reset()

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

save([path, serialization_format])

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

set_config(**config_dict)

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

set_params(**params)

设置此对象的参数。

set_random_state([random_state, deep, ...])

为 self 设置 random_state 伪随机种子参数。

set_tags(**tag_dict)

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

transform(X[, y])

对 X 进行变换并返回变换后的版本。

update(X[, y, update_params])

使用 X 更新变换器，可选使用 y。
classmethod get_test_params()[source]#

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

返回：
paramsdict 或 list of dict，默认 = {}

用于创建类的测试实例的参数 每个 dict 都是构建一个“有趣”测试实例的参数，即 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_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__ 方法中调用，在构造期间或通过 __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')[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])

namesstr 列表，与 objs 长度相同

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

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

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

状态改变

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

写入 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 = 时间序列集合。 具有 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 中传递，不可选。所需格式，请参阅类 docstring 获取详细信息。

返回：
self评估器的拟合实例
fit_transform(X, y=None)[source]#

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

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

状态改变

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

写入 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 = 时间序列集合。 具有 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 中传递，不可选。所需格式，请参阅类 docstring 获取详细信息。

返回：
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)[source]#

从类中获取类标签值，具有来自父类的标签级别继承。

每个 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()[source]#

从类中获取类标签，具有来自父类的标签级别继承。

每个 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()[source]#

获取自身的配置标志。

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

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

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

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

返回：
config_dictdict

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数：
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()[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 的 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)[source]#

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

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

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

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

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

在实例构造时。

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

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

按照继承顺序。

参数：
tag_namestr

要检索的标签名称

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

未找到标签时的默认/回退值

raise_errorbool

未找到标签时是否引发 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()[source]#

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

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

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

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

值是相应的标签值，覆盖优先级降序如下：

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

在实例构造时。

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

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

按照继承顺序。

返回：
collected_tagsdict

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

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

对 X 进行逆变换并返回逆变换版本。

目前假设只有具有标签

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

的变换器具有 inverse_transform。

所需状态

要求状态为“已拟合”。

访问 self 中的内容

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

  • 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

额外数据，例如变换的标签。某些变换器需要此项，请参阅类 docstring 获取详细信息。

返回：
X 的逆变换版本

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

is_composite()[source]#

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

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

返回：
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 保存为 bytes-like 对象或 (.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” 则将在 /home/stored/ 存储 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, default = “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 时是否只列出与默认值不同的 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”：bool，默认=True；False 阻止 ray 在并行化后关闭。

      “logger_name”：str，默认=“ray”；要使用的记录器名称。

    • “mute_warnings”：bool，默认=False；如果为 True，则禁止警告

    • “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)[source]#

设置此对象的参数。

此方法适用于简单的 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')[source]#

为 self 设置 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)[source]#

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

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

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

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

此 set_tags 方法应仅在对象构造期间，即在 __init__ 方法中或通过 __init__ 直接构造后调用。

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

参数：
**tag_dictdict

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

返回：
自身

对自身的引用。

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

对 X 进行变换并返回变换后的版本。

所需状态

要求状态为“已拟合”。

访问 self 中的内容

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

  • 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

额外数据，例如变换的标签。某些变换器需要此项，请参阅类 docstring 获取详细信息。

返回：
X 的变换版本
类型取决于 X 的类型和 scitype:transform-output 标签

转换

X

-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 个窗口

update(X, y=None, update_params=True)[source]#

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

所需状态

要求状态为“已拟合”。

访问 self 中的内容

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

  • self.is_fitted，必须为 True

写入 self

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

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

额外数据，例如变换的标签。某些变换器需要此项，请参阅类 docstring 获取详细信息。

返回：
self评估器的拟合实例