YtoX#

class YtoX(subset_index=False)[source]#

创建作为内生数据副本的外生特征。

用内生数据 (y) 替换外生特征 (X)。

要添加而不是替换，请使用 FeatureUnion。

常见用例包括

  • 从转换后的内生变量创建外生变量

  • 如果外生数据不可用，从索引创建外生数据

  • 与 YfromX 结合，手动构建归约策略

参数:
subset_index布尔值, 可选, 默认为 False

如果为 True，则将 transform 的输出子集化为 X.index，即输出 y.loc[X.index]

属性:
is_fitted

是否已调用 fit。

示例

用例：如果外生数据不可用，从索引创建外生数据。

>>> from sktime.datasets import load_airline
>>> from sktime.transformations.compose import YtoX
>>> from sktime.transformations.series.fourier import FourierFeatures
>>> from sktime.forecasting.arima import ARIMA
>>> from sktime.forecasting.compose import ForecastingPipeline
>>>
>>> # data with no exogenous features
>>> y = load_airline()
>>>
>>> # create a pipeline with Fourier features and ARIMA
>>> pipe = ForecastingPipeline(
...     [
...             YtoX(),
...             FourierFeatures(sp_list=[24, 24 * 7], fourier_terms_list=[10, 5]),
...             ARIMA(order=(1, 1, 1))  
...     ]
... )  
>>>
>>> # fit and forecast, using Fourier features as exogenous data
>>> pred = pipe.fit_predict(y, fh=[1, 2, 3, 4, 5])

用例：使用滞后的内生变量作为外生数据。

>>> from sktime.datasets import load_airline
>>> from sktime.transformations.compose import YtoX
>>> from sktime.transformations.series.lag import Lag
>>> from sktime.transformations.series.impute import Imputer
>>> from sktime.forecasting.sarimax import SARIMAX
>>>
>>> # data with no exogenous features
>>> y = load_airline()
>>>
>>> # create the pipeline
>>> lagged_y_trafo = YtoX() * Lag(1, index_out="original") * Imputer()
>>>
>>> # we need to specify index_out="original" as otherwise ARIMA gets 1 and 2 ahead
>>> # use lagged_y_trafo to generate X
>>> forecaster = lagged_y_trafo ** SARIMAX()  
>>>
>>> # fit and forecast next value, with lagged y as exogenous data
>>> forecaster.fit(y, fh=[1])  
>>> y_pred = forecaster.predict()

用例：使用汇总的内生变量作为外生数据。

>>> from sktime.datasets import load_airline
>>> from sktime.transformations.series.summarize import WindowSummarizer
>>> from sktime.transformations.compose import YtoX
>>> from sktime.forecasting.compose import make_reduction
>>> from sktime.forecasting.compose import ForecastingPipeline
>>> from sklearn.ensemble import GradientBoostingRegressor  
>>>
>>> # data with no exogenous features
>>> y = load_airline()
>>>
>>> # keyword arguments for WindowSummarizer
>>> kwargs = {
...     "lag_feature": {
...         "lag": [1],
...         "mean": [[1, 3], [3, 6]],
...         "std": [[1, 4]],
...     },
...     "truncate": 'bfill',
... }
>>>
>>> # create forecaster from sklearn regressor using make_reduction
>>> forecaster = make_reduction(
...     GradientBoostingRegressor(),
...     strategy="recursive",
...     pooling="global",
...     window_length=12,
... )  
>>>
>>> # create the pipeline
>>> pipe = ForecastingPipeline(
...     steps=[
...         ("ytox", YtoX()),
...         ("summarizer", WindowSummarizer(**kwargs)),
...         ("forecaster", forecaster),
...     ]
... )  
>>>
>>> # fit and forecast, with summarized y as exogenous data
>>> preds = pipe.fit_predict(y=y, fh=range(1, 20))

方法

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])

将序列化的对象保存到字节类对象或 (.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字典列表
用于创建类的测试实例的参数。
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

对 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 个元素是测试中 objs 第 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")。

参数:
X符合 sktime 数据容器格式的时间序列

用于拟合转换的数据。

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 typed 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 版本。

状态变更

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

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

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

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

参数:
X符合 sktime 数据容器格式的时间序列

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

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

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

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

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

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

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

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

按继承顺序。

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

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

参数:
tag_namestr

标签值的名称。

tag_value_defaultany type

如果找不到标签，则使用默认/备用值。

返回:
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]#

获取已拟合参数。

所需状态

要求状态为“已拟合 (fitted)”。

参数:
deepbool, default=True

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

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

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

返回:
fitted_paramsdict with str-valued keys

拟合参数的字典，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, default=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[source]#

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

参数:
deepbool, default=True

是否返回组件的参数。

  • 如果为 True，将返回此对象的参数名称 : 值 dict，包括组件的参数 (= BaseObject 值的参数)。

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

返回:
paramsdict with str-valued keys

参数的字典，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_defaultany type, optional; 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()[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 方法。

所需状态

要求状态为“已拟合 (fitted)”。

访问自身属性

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

  • self.is_fitted，必须为 True

参数:
X符合 sktime 数据容器格式的时间序列

用于拟合转换的数据。

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 typed 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]#

将序列化的对象保存到字节类对象或 (.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。

serialization_format: str, default = “pickle”

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

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

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

参数:
config_dictdict

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

displaystr, “diagram” (默认), 或 “text”

jupyter kernel 如何显示 self 的实例

  • “diagram” = html 框图表示

  • “text” = 字符串输出

print_changed_onlybool, default=True

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

warningsstr, “on” (默认), 或 “off”

是否引发警告，仅影响来自 sktime 的警告

  • “on” = 将引发来自 sktime 的警告

  • “off” = 不会引发来自 sktime 的警告

backend:parallelstr, optional, default=”None”

广播/向量化时用于并行的后端，以下之一

  • “None”: 顺序执行循环，简单的列表推导

  • “loky”, “multiprocessing” 和 “threading”: 使用 joblib.Parallel

  • “joblib”: 自定义和第三方 joblib 后端，例如 spark

  • “dask”: 使用 dask，需要在环境中安装 dask 包

  • “ray”: 使用 ray，需要在环境中安装 ray 包

backend:parallel:paramsdict, optional, default={} (未传递参数)

作为配置传递给并行化后端的额外参数。有效键取决于 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, default=True; False 会阻止 ray 在

      并行化后关闭。

    • “logger_name”: str, default=”ray”; 要使用的日志记录器名称。

    • “mute_warnings”: bool, default=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_policy 应用于 self 中的 random_state 参数，并且当且仅当 deep=True 时应用于剩余的组件对象。

注意：即使 self 没有 random_state 参数，或者没有任何组件具有 random_state 参数，也会调用 set_params。因此，set_random_state 将重置任何 scikit-base 对象，即使是没有 random_state 参数的对象。

参数:
random_stateint, RandomState 实例 或 None, default=None

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

deepbool, default=True

是否在 skbase 对象值的参数（即组件估计器）中设置随机状态。

  • 如果为 False，则（如果存在）仅设置 self 的 random_state 参数。

  • 如果为 True，也将设置组件对象中的 random_state 参数。

self_policystr, 以下之一 {“copy”, “keep”, “new”}, default=”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 的引用。

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

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

所需状态

要求状态为“已拟合 (fitted)”。

访问自身属性

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

  • self.is_fitted，必须为 True

参数:
X符合 sktime 数据容器格式的时间序列

要转换的数据。

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 typed 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 标签

转换

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

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

所需状态

要求状态为“已拟合 (fitted)”。

访问自身属性

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

  • self.is_fitted，必须为 True

写入 self

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

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

参数:
X符合 sktime 数据容器格式的时间序列

用于更新转换的数据

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 typed pd.DataFrame

  • Hierarchical scitype = 分层时间序列集合。pd.DataFrame 带有 3 级或更多级行 MultiIndex (hierarchy_1, ..., hierarchy_n, time)

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

y可选, 符合 sktime 数据格式的数据, 默认为 None

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

返回:
self评估器的已拟合实例