在转换中拟合#

class FitInTransform(transformer, skip_inverse_transform=True)[源代码]#

延迟拟合到转换阶段的转换器包装器。

在面板设置中，例如时间序列分类，在测试集上进行拟合和转换可能是更优（或必需）的，例如，在正在拟合插值参数的同一序列内进行插值。FitInTransform 可用于包装任何转换器，通过将 fit 延迟到 transform 批次，从而确保 fit 和 transform 始终发生在同一序列上。

警告：在预测设置中天真地使用 FitInTransform 通常无效，或者可能导致错误（数据泄露）。

参数:
transformer估计器

类似 scikit-learn 或 sktime 的转换器，用于拟合并应用于序列。

skip_inverse_transform布尔值

FitInTransform 默认会跳过 inverse_transform，如果参数 skip_inverse_transform=False，则 inverse_transform 通过 inner transformer（内部转换器）的 transformer.fit(X=X, y=y).inverse_transform(X=X, y=y) 来计算。因此，内部转换器会在 inverse_transform 数据上进行拟合。这是为了让 FitInTransform 的 transform() 方法不改变状态所必需的。

属性:
是否已拟合

是否已调用 fit。

示例

>>> from sktime.datasets import load_longley
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.forecasting.base import ForecastingHorizon
>>> from sktime.forecasting.compose import ForecastingPipeline
>>> from sktime.split import temporal_train_test_split
>>> from sktime.transformations.compose import FitInTransform
>>> from sktime.transformations.series.impute import Imputer
>>> y, X = load_longley()
>>> y_train, y_test, X_train, X_test = temporal_train_test_split(y, X)
>>> fh = ForecastingHorizon(y_test.index, is_relative=False)
>>> # we want to fit the Imputer only on the predict (=transform) data.
>>> # note that NaiveForecaster can't use X data, this is just a show case.
>>> pipe = ForecastingPipeline(
...     steps=[
...         ("imputer", FitInTransform(Imputer(method="mean"))),
...         ("forecaster", NaiveForecaster()),
...     ]
... )
>>> pipe.fit(y_train, X_train)
ForecastingPipeline(...)
>>> y_pred = pipe.predict(fh=fh, X=X_test)

方法

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 进行逆转换并返回逆转换后的版本。

是否为复合对象()

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

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_set字符串，默认为“default”

要返回的测试参数集的名称，用于测试。如果未为某个值定义特殊参数，将返回 "default" 集。当前没有为转换器保留的值。

返回:
params字典或字典列表，默认为 {}

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

check_is_fitted(method_name=None)[源代码]#

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数:
method_name字符串，可选

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

抛出:
未拟合错误

如果估计器尚未拟合。

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_names字符串或字符串列表，默认为 None

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

返回:
自身

对 self 的引用。

classmethod create_test_instance(parameter_set='default')[源代码]#

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

参数:
parameter_set字符串，默认为“default”

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

返回:
instance具有默认参数的类的实例
classmethod create_test_instances_and_names(parameter_set='default')[源代码]#

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

参数:
parameter_set字符串，默认为“default”

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

返回:
objscls 实例的列表

第 i 个实例是 cls(**cls.get_test_params()[i])

names字符串列表，长度与 objs 相同

第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个，命名约定是 {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 兼容数据容器格式的时间序列

用于 fit transform 的数据。

sktime 中的个体数据格式称为 mtype 规范，每个 mtype 都实现了一个抽象的 scitype。

  • Series scitype = 个体时间序列。可以是 pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合。可以是具有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或者 Series 类型的 pd.DataFrame 的 list

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

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

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

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

返回:
self estimator 的一个已拟合实例
fit_transform(X, y=None)[source]#

拟合数据，然后转换数据。

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

状态改变

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

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

可能在可行的情况下通过引用强制转换为内部类型或与 update_data 兼容的类型

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

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

用于拟合转换以及进行转换的数据。

sktime 中的个体数据格式称为 mtype 规范，每个 mtype 都实现了一个抽象的 scitype。

  • Series scitype = 个体时间序列。可以是 pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合。可以是具有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或者 Series 类型的 pd.DataFrame 的 list

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

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

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

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

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

|----------|————–|------------------------|

返回结果中的实例对应于 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)[source]#

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

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

get_class_tag 方法是一个类方法，它在仅考虑类级别标签值和覆盖的情况下检索标签的值。

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

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

  2. 在父类的 _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 属性的任何键。

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

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

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

按照继承顺序。

实例可以根据超参数覆盖这些标签。

要检索可能包含实例覆盖的标签，请改用 get_tags 方法。

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

要包含来自动态标签的覆盖，请使用 get_tags。

collected_tags字典

标签名称：标签值 对的字典。通过嵌套继承从 _tags 类属性收集。不会被通过 set_tags 或 clone_tags 设置的动态标签覆盖。

get_config()[source]#

获取自身的配置标志。

Configs 是 self 的键值对，通常用作控制行为的瞬时标志。

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

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

Configs 在 clone 或 reset 调用下保留。

返回:
config_dict字典

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

get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
deep布尔值，默认为 True

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

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

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

返回:
fitted_params键为字符串的字典

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

获取对象的参数名称。

参数:
sort布尔值，默认为 True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deep布尔值，默认为 True

是否返回组件的参数。

  • 如果 True，将返回此对象的参数名称：值 dict，包括组件（= BaseObject 类型参数）的参数。

  • 如果 False，将返回此对象的参数名称：值 dict，但不包括组件的参数。

返回:
params键为字符串的字典

参数字典，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_name字符串

要检索的标签名称

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

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

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

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

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

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

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

在实例构造时。

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

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

按照继承顺序。

返回:
collected_tags字典

标签名称：标签值 对的字典。通过嵌套继承从 _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 兼容数据容器格式的时间序列

用于 fit transform 的数据。

sktime 中的个体数据格式称为 mtype 规范，每个 mtype 都实现了一个抽象的 scitype。

  • Series scitype = 个体时间序列。可以是 pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合。可以是具有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或者 Series 类型的 pd.DataFrame 的 list

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

有关数据格式的更多详细信息，请参阅关于 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。

返回:
布尔值

Estimator 是否已 fit。

classmethod load_from_path(serial)[source]#

从文件位置加载对象。

参数:
serialZipFile(path).open("object") 的结果
返回:
反序列化的 self，其输出位于 path，是 cls.save(path) 的结果
classmethod load_from_serial(serial)[source]#

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

参数:
serial`cls.save(None)` 输出的第一个元素
返回:
反序列化的 self，其输出为 serial，是 cls.save(None) 的结果
reset()[source]#

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

结果是将 self 设置为构造函数调用后直接所处的状态，具有相同的超参数。通过 set_config 设置的配置值也会被保留。

一个 reset 调用会删除所有对象属性，除了

  • 超参数 = 写入 self 的 __init__ 参数，例如 self.paramname，其中 paramname 是 __init__ 的一个参数

  • 包含双下划线的对象属性，即字符串 “__”。例如，名为 “__myattr” 的属性会被保留。

  • config 属性，配置会被保留且不改变。也就是说，在 reset 前后调用 get_config 的结果是相同的。

类方法和对象方法，以及类属性也不受影响。

等同于 clone，但 reset 会修改 self 而不是返回新对象。

在调用 self.reset() 后，self 的值和状态与构造函数调用``type(self)(**self.get_params(deep=False))`` 后获得的对象相等。

返回:
自身

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

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

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

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

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

参数:
pathNone 或文件位置（字符串或 Path 对象）

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

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

  • path=”/home/stored/estimator”，则会在 /home/stored/ 中存储一个 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str，默认为 “pickle”

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

返回:
如果 path 为 None - 内存中的序列化 self
如果 path 是文件位置 - 指向该文件的 ZipFile 对象
set_config(**config_dict)[source]#

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

参数:
config_dict字典

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

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

jupyter 内核如何显示 self 的实例

  • “diagram” = html 框图表示

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

print_changed_only布尔值，默认为 True

打印 self 时是否只列出与默认值不同的 self 参数 (True)，还是列出所有参数名称和值 (False)。不进行嵌套，即只影响 self，不影响组件 estimators。

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

设置此对象的参数。

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

参数:
params字典

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_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

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

deep布尔值，默认为 True

是否在 skbase 对象类型参数中设置随机状态，即组件 estimators。

  • 如果为 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)[source]#

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

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

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

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

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

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

参数:
tag_dict字典

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

返回:
Self

对 self 的引用。

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 = 时间序列集合。可以是具有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或者 Series 类型的 pd.DataFrame 的 list

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

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

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

附加数据，例如用于转换的标签。一些转换器需要此项，请参阅类文档字符串以获取详细信息。

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

X 的转换版本

类型取决于 X 的类型和 scitype:transform-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 实例)。示例：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)[source]#

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

所需状态

要求状态为“已拟合”。

访问 self 中的项

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

  • self.is_fitted，必须为 True

写入自身

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

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

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

用于更新转换的数据

sktime 中的个体数据格式称为 mtype 规范，每个 mtype 都实现了一个抽象的 scitype。

  • Series scitype = 个体时间序列。可以是 pd.DataFrame、pd.Series 或 np.ndarray（1D 或 2D）

  • Panel scitype = 时间序列集合。可以是具有两级行 MultiIndex (instance, time) 的 pd.DataFrame，3D np.ndarray (instance, variable, time)，或者 Series 类型的 pd.DataFrame 的 list

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

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

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

附加数据，例如用于转换的标签。一些转换器需要此项，请参阅类文档字符串以获取详细信息。

返回:
self estimator 的一个已拟合实例