HurstExponentTransformer#

class HurstExponentTransformer(lags: list[int] | range | None = None, method: str = 'rs', min_lag: int = 2, max_lag: int = 100, fit_trend: str = 'c', confidence_level: float = 0.95)[source]#

用于计算时间序列 Hurst 指数的转换器。

该转换器计算 Hurst 指数，该指数用于评估时间序列的自相关特性，特别是长程依赖的程度。

参数:
lagsOptional[Union[List[int], range]], default=None

用于计算的滞后项。如果为 None，则使用基于 min_lag 和 max_lag 的范围。

methodstr, default=’rs’

用于计算 Hurst 指数的方法。可以是 ‘rs’（重标极差）或 ‘dfa’（去趋势波动分析）。

min_lagint, default=2

如果 lags 为 None，则使用的最小滞后项。

max_lagint, default=100

如果 lags 为 None，则使用的最大滞后项。

fit_trendstr, default=’c’

计算中包含的趋势分量。

confidence_levelfloat, default=0.95

置信区间计算的置信水平。

属性:
hurst_estimate_float

估计的 Hurst 指数。

confidence_interval_tuple

Hurst 指数估计的置信区间。

示例

>>> from sktime.transformations.series.hurst import HurstExponentTransformer
>>> from sktime.datasets import load_airline
>>> y = load_airline()
>>> transformer = HurstExponentTransformer()
>>> 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()

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

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

load_from_path(serial)

从文件位置加载对象。

load_from_serial(serial)

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

plot_log_log(ts)

绘制 Hurst 指数计算中使用的对数-对数图。

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。
plot_log_log(ts: Series)[source]#

绘制 Hurst 指数计算中使用的对数-对数图。

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

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

参数:
parameter_setstr, default=”default”

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

Returns:
paramslist of dict

用于创建类的测试实例的参数

check_is_fitted(method_name=None)[source]#

检查评估器是否已拟合。

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

如果不是，则引发 NotFittedError。

参数:
method_namestr, optional

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

Raises:
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。

Raises:
如果克隆不符合要求（由于 __init__ 错误），则引发 RuntimeError。
clone_tags(estimator, tag_names=None)[source]#

将标签从另一个对象克隆为动态覆盖。

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

动态标签被设置为 estimator 中标签的值，其名称在 tag_names 中指定。

tag_names 的默认值将 estimator 中的所有标签写入 self。

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

estimator:class:BaseObject 或派生类的实例

参数:
tag_namesstr 或 str 列表，默认 = None
要克隆的标签名称。默认值 (None) 克隆 estimator 中的所有标签。

self

Returns:
对 self 的引用。

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

instance具有默认参数的类实例

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

参数:
parameter_setstr, default=”default”

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

Returns:
classmethod create_test_instances_and_names(parameter_set='default')[source]#
objscls 实例列表

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

参数:
parameter_setstr, default=”default”

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

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

namesstr 列表，与 objs 长度相同

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

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

状态改变

拟合转换器到 X，可选地拟合到 y。

将状态更改为“已拟合”("fitted")。

写入 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), list 包含 Series 类型的 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评估器的一个已拟合实例

Returns:
fit_transform(X, y=None)[source]#
将转换器拟合到 X 和 y，并返回 X 的转换版本。

拟合数据，然后转换。

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

将状态更改为“已拟合”("fitted")。

写入 self

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

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

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

参数:
用于拟合转换的数据。

X 的转换版本

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 类型的 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评估器的一个已拟合实例

Returns:
类型取决于 X 的类型和 scitype:transform-output 标签
X | tf-output | 返回类型 |
|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1-row) | | 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，

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

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

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

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

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

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

  2. 按继承顺序排列。

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

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

tag_namestr

参数:
标签值的名称。

tag_value_defaultany type

如果未找到标签的默认/回退值。

tag_value

Returns:
self 中 tag_name 标签的值。如果未找到，则返回 tag_value_default。

classmethod get_class_tags()[source]#

get_class_tags 方法是一个类方法，它返回一个标签字典，其键是类或其任何父类中设置的任何 _tags 属性的键。

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

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

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

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

  2. 按继承顺序排列。

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

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

collected_tagsdict

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

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

get_config()[source]#

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

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

获取 self 的配置标志。

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

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

config_dictdict

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

Returns:
get_fitted_params(deep=True)[source]#

获取拟合参数。

所需状态

获取拟合参数。

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

deepbool, default=True

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

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

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

  • fitted_paramsdict (键为 str)

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

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

classmethod get_param_names(sort=True)[source]#

获取对象的参数名称。

sortbool, default=True

参数:
是按字母顺序（True）返回参数名称，还是按它们在类 __init__ 中出现的顺序（False）返回。

param_names: list[str]

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

get_params(deep=True)[source]#

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

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

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

是否返回组件的参数。

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

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

Returns:
paramsdict (键为 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)[source]#

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

get_tag 方法从实例中检索名称为 tag_name 的单个标签值，并考虑标签覆盖，按以下优先级降序排列

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

在实例构造时。

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

  2. 按继承顺序排列。

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

参数:
标签值的名称。

要检索的标签名称

tag_value_defaultany type, 可选；默认为 None

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

raise_errorbool

未找到标签时是否引发 ValueError

Returns:
tag_valueAny

self 中 tag_name 标签的值。如果未找到，则在 raise_error 为 True 时引发错误，否则返回 tag_value_default。

Raises:
ValueError，如果 raise_error 为 True。

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

get_tags()[source]#

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

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

clone_tags 从另一个对象 estimator 设置动态标签覆盖。

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

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

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

在实例构造时。

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

  2. 按继承顺序排列。

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

Returns:
collected_tagsdict

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

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

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

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

目前假定只有带有标签的转换器

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

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

deepbool, default=True

具有 inverse_transform 方法。

  • 访问 self 中的属性

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

参数:
用于拟合转换的数据。

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 类型的 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.is_fitted，必须为 True

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

X 的逆转换版本

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

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

is_composite()[source]#

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

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

composite: bool

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

property is_fitted[source]#

Returns:
是否已调用 fit。

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

bool

从文件位置加载对象。

参数:
评估器是否已 fit。
Returns:
classmethod load_from_path(serial)[source]#
从文件位置加载对象。

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

参数:
serialZipFile(path).open(“object) 的结果
Returns:
反序列化 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__ 的一个参数

Returns:
对 self 的引用。

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

配置属性，配置保持不变。也就是说，在 reset 前后 get_config 的结果是相等的。

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

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

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

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

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

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

  • 将序列化的 self 保存为字节类对象或 (.zip) 文件。

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

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

pathNone 或文件位置 (str 或 Path)

Returns:
如果为 None，则 self 保存到内存对象；如果是文件位置，则将 self 保存到该文件位置。如果
path=”estimator”，则将在当前工作目录创建 zip 文件 estimator.zip。
set_config(**config_dict)[source]#

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

参数:
get_fitted_params(deep=True)[source]#

配置名称 : 配置值对的字典。下面列出了有效的配置、值及其含义

displaystr, “diagram” (default), or “text”

Jupyter 内核如何显示对象实例

  • “diagram” = HTML 框图表示

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

print_changed_onlybool, default=True

打印对象时是否仅列出自变量中与默认值不同的参数（如果为 True），或者列出所有参数名称和值（如果为 False）。不嵌套，即仅影响对象本身，不影响组件估计器。

warningsstr, “on” (default), or “off”

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

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

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

backend:parallelstr, optional, default=”None”

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

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

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

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

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

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

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

作为配置传递给并行化后端的附加参数。有效键取决于 backend:parallel 的值

  • “None”: 没有附加参数，backend_params 被忽略

  • “loky”, “multiprocessing” and “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, one of “on” (default), “off”, or valid mtype string

控制输入检查和转换，适用于 _fit, _transform, _inverse_transform, _update

  • "on" - 执行输入检查和转换

  • "off" - 在将数据传递给内部方法之前不执行输入检查和转换

  • valid mtype string - 输入被假定为指定的 mtype，执行转换但不执行检查

output_conversionstr, one of “on”, “off”, valid mtype string

控制 _transform, _inverse_transform 的输出转换

  • "on" - 如果 input_conversion 为“on”，则执行输出转换

  • "off" - 直接返回 _transform, _inverse_transform 的输出

  • valid mtype string - 输出被转换为指定的 mtype

Returns:
self对自身的引用。

注意事项

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

set_params(**params)[source]#

设置此对象的参数。

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

参数:
**paramsdict

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

Returns:
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, default=None

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

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

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

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

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

self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”

  • “copy” : self.random_state 被设置为输入的 random_state

  • “keep” : self.random_state 保持原样

  • “new” : self.random_state 被设置为一个新的随机状态，

从输入的 random_state 派生，通常与它不同

Returns:
self对自身的引用
set_tags(**tag_dict)[source]#

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

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

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

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

set_tags 方法只能在对象的 __init__ 方法中（构造期间）或构造后直接通过 __init__ 调用。

estimator:class:BaseObject 或派生类的实例

参数:
**tag_dictdict

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

Returns:
自身

对自身的引用。

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

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

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

deepbool, default=True

具有 inverse_transform 方法。

  • 访问 self 中的属性

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

参数:
用于拟合转换的数据。

要转换的数据。

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 类型的 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.is_fitted，必须为 True

Returns:
类型取决于 X 的类型和 scitype:transform-output 标签
X | tf-output | 返回类型 |

转换

X

-输出

返回类型

序列 (Series)

原始值 (Primitives)

pd.DataFrame (1行)

面板 (Panel)

原始值 (Primitives)

pd.DataFrame

序列 (Series)

序列 (Series)

序列 (Series)

面板 (Panel)

序列 (Series)

面板 (Panel)

序列 (Series)

面板 (Panel)

面板 (Panel)
表中未列出的组合目前不受支持
具体地，通过示例
如果 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，

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

classmethod get_class_tag(tag_name, tag_value_default=None)[source]#

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

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

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

deepbool, default=True

具有 inverse_transform 方法。

  • 访问 self 中的属性

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

设置以“_”结尾的已拟合模型属性，已拟合属性可通过 get_fitted_params 检查。

  • 访问 self 中的属性

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

参数:
用于拟合转换的数据。

用于更新转换的数据

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 类型的 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.is_fitted，必须为 True

Returns:
fit_transform(X, y=None)[source]#