Logger#

class Logger(logger='sktime', logger_backend='logging', log_methods='all', level=None, log_fitted_params=False)[源代码]#

日志转换器，将数据写入日志，否则保持不变。

在方法中，将 X 和 y 记录到 logger。 logger 可以使用 logger_backend 作为 Python logging 实例，主要用于打印，其中 data 作为 extra 记录，或者使用自定义的 DataLog 实例来检索完整对象而不仅仅是打印输出。

参数:
loggerstr 可选，默认=”sktime”

要使用的日志器名称，传递给 logger_backend 以识别由 get_logger 引用的唯一日志器实例。

logger_backendstr，选项包括“logging”（默认）、“datalog”

用于日志记录的后端。

  • “logging”：使用标准的 Python logging 模块，记录到 logging.getLogger(logger)

  • “datalog”：使用多例日志器类以便轻松检索数据，记录到 DataLog(logger)，其中 DataLog 来自 transformations.compose 模块。

在任何一种情况下，都可以通过调用 obj.get_logger 来检索日志器的引用，其中 obj 是 Logger 的实例。

log_methodsstr 或 str 列表，默认=``”transform”``

如果为 "all"，将记录 fit、transform、inverse_transform；如果为 str 或 str 列表，所有字符串必须来自上述方法，并且将精确记录作为 str 传递的方法；也可以是 "off"" 以完全禁用日志记录。

levellogging 级别，可选，默认=logging.INFO

logging 级别，选项包括 logging.INFO、logging.DEBUG、logging.WARNING、logging.ERROR

log_fitted_paramsbool，可选，默认=False

如果为 True，还将 fit 中看到的 X 和 y 写入 self 作为 X_ 和 y_，这些可以通过调用 get_fitted_params 来检索。如果为 False，get_fitted_params 将返回一个空字典。

属性:
get_logger
is_fitted

是否已调用 fit。

示例

>>> from sktime.transformations.compose import DataLog, Logger
>>> from sktime.datasets import load_airline
>>> from sktime.forecasting.naive import NaiveForecaster
>>> from sktime.transformations.series.detrend import Detrender
>>>
>>> # create a logger
>>> logger = Logger(logger="foo", log_methods="all", logger_backend="datalog")
>>> # create a pipeline that logs after detrending and before forecasting
>>> pipe = Detrender() * logger * NaiveForecaster(sp=12)
>>> pipe.fit(load_airline(), fh=[1, 2, 3])
TransformedTargetForecaster(...)
>>> # get the log
>>> log = DataLog("foo").get_log()

方法

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

获取 self 的配置标志。

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

将序列化的 self 保存到字节类对象或 (.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(parameter_set='default')[源代码]#

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

参数:
parameter_setstr，默认=”default”

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

返回:
paramsdict 或 dict 列表
check_is_fitted(method_name=None)[源代码]#

检查估计器是否已拟合。

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

如果不是，则抛出 NotFittedError。

参数:
method_namestr, 可选

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

抛出:
NotFittedError

如果估计器尚未拟合。

clone()[源代码]#

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

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

抛出:
如果克隆不符合规范，由于 __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_namesstr 或 list of str, 默认 = None

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

返回:
self

对 self 的引用。

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

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

参数:
parameter_setstr，默认=”default”

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

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

创建所有测试实例的列表和它们的名称列表。

参数:
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)[源代码]#

将转换器拟合到 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 = 时间序列集合。pd.DataFrame，行具有 2 级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list。

  • 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)[源代码]#

拟合数据，然后转换它。

将转换器拟合到 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 = 时间序列集合。pd.DataFrame，行具有 2 级 MultiIndex (instance, time)，3D np.ndarray (instance, variable, time)，Series 类型 pd.DataFrame 的 list。

  • 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，则返回的 Panel 具有与 X 相同数量的实例（转换器应用于每个输入的 Series 实例）。示例：Panel 中的所有 Series 都单独进行去趋势

  • 如果 X 是 Series 或 Panel 且 transform-output 是

Primitives，则返回 pd.DataFrame，其行数与 X 中的实例数相同。示例：返回的第 i 行包含第 i 个 Series 的均值和方差

  • 如果 X 是 Series 且 transform-output 是 Panel，

则返回一个类型为 pd-multiindex 的 Panel 对象。示例：输出的第 i 个实例是运行在 X 上的第 i 个窗口

classmethod get_class_tag(tag_name, tag_value_default=None)[源代码]#

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

每个 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()[源代码]#

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

每个 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()[源代码]#

获取 self 的配置标志。

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

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

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

配置在 clone 或 reset 调用期间保留。

返回:
config_dictdict

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

get_fitted_params(deep=True)[源代码]#

获取拟合参数。

所需状态

要求状态为“已拟合”。

参数:
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()[源代码]#

获取对象的默认参数。

返回:
default_dict: dict[str, Any]

键是 cls 的所有在 __init__ 中定义了默认值的参数。值是在 __init__ 中定义的默认值。

classmethod get_param_names(sort=True)[源代码]#

获取对象的参数名称。

参数:
sortbool, 默认=True

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

返回:
param_names: list[str]

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

get_params(deep=True)[源代码]#

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

参数:
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)[源代码]#

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

每个 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_valueAny

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

抛出:
ValueError，如果 raise_error 为 True。

如果 tag_name 不在 self.get_tags().keys() 中，则会抛出 ValueError。

get_tags()[源代码]#

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

每个 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)[源代码]#

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

目前假定只有标签为

“scitype:transform-input”=”Series”，“scitype:transform-output”=”Series”的转换器才具有 inverse_transform 方法。

具有 inverse_transform。

所需状态

要求状态为“已拟合”。

访问 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)，Series 类型 pd.DataFrame 的 list。

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

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

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

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

返回:
X 的逆转换版本

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

is_composite()[源代码]#

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

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

返回:
composite: bool

对象是否具有其值是 BaseObject 派生实例的参数。

property is_fitted[源代码]#

是否已调用 fit。

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

返回:
bool

估计器是否已被 fit。

classmethod load_from_path(serial)[源代码]#

从文件位置加载对象。

参数:
serialZipFile(path).open(“object) 的结果
返回:
在 path 处产生的反序列化 self，是 cls.save(path) 的输出
classmethod load_from_serial(serial)[源代码]#

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

参数:
serialcls.save(None) 输出的第一个元素
返回:
导致输出 serial 的反序列化 self，是 cls.save(None) 的结果
reset()[源代码]#

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

将 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')[源代码]#

将序列化的 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”，则在 /home/stored/ 中存储一个 zip 文件 estimator.zip。

存储在 /home/stored/ 中。

serialization_format: str, 默认 = “pickle”

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

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

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

参数:
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)[源代码]#

设置此对象的参数。

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

参数:
**paramsdict

BaseObject 参数，键必须是 <component>__<parameter> 字符串。__ 后缀可以作为完整字符串的别名，如果它们在 get_params 键中是唯一的。

返回:
self对 self 的引用（参数已设置后）
set_random_state(random_state=None, deep=True, self_policy='copy')[源代码]#

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

通过 self.get_params 查找名为 random_state 的参数，并通过 set_params 将它们设置为通过链式哈希（chain hashing）从 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对 self 的引用
set_tags(**tag_dict)[源代码]#

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

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

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

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

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

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

参数:
**tag_dictdict

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

返回:
Self

对 self 的引用。

transform(X, y=None)[源代码]#

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

所需状态

要求状态为“已拟合”。

访问 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)，Series 类型 pd.DataFrame 的 list。

  • 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，则返回的 Panel 具有与 X 相同数量的实例（转换器应用于每个输入的 Series 实例）。示例：Panel 中的所有 Series 都单独进行去趋势

  • 如果 X 是 Series 或 Panel 且 transform-output 是

Primitives，则返回 pd.DataFrame，其行数与 X 中的实例数相同。示例：返回的第 i 行包含第 i 个 Series 的均值和方差

  • 如果 X 是 Series 且 transform-output 是 Panel，

则返回一个类型为 pd-multiindex 的 Panel 对象。示例：输出的第 i 个实例是运行在 X 上的第 i 个窗口

update(X, y=None, update_params=True)[源代码]#

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

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

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

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

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

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