AutoCorrelationTransformer#
- class AutoCorrelationTransformer(adjusted=False, n_lags=None, fft=False, missing='none')[source]#
自相关转换器。
自相关函数衡量时间序列与其自身在不同滞后下的相关性。AutoCorrelationTransformer 为每个滞后返回这些值作为序列,直至指定的
n_lags
。- 参数:
- adjustedbool, 默认值=False
如果为 True,则自协方差的分母为 n-k,否则为 n。
- n_lagsint, 默认值=None
返回自相关的滞后数量。如果为 None,则 statsmodels acf 函数使用 min(10 * np.log10(nobs), nobs - 1)。
- fftbool, 默认值=False
如果为 True,通过 FFT 计算 ACF。
- missing{“none”, “raise”, “conservative”, “drop”}, 默认值=”none”
在计算自相关函数时如何处理缺失值。
“none” 不执行任何检查或处理缺失值
“raise” 如果发现 NaN 值则引发异常。
“drop” 移除缺失观测值,然后将非缺失部分视为连续,估计自协方差。
“conservative” 使用 nan-ops 计算自协方差,以便在计算用于估计自协方差的均值和交叉乘积时移除 nan。计算中的 “n” 设置为非缺失观测值的数量。
- 属性:
is_fitted
是否已调用
fit
。
说明
提供 statsmodels acf 函数的包装器。
示例
>>> from sktime.transformations.series.acf import AutoCorrelationTransformer >>> from sktime.datasets import load_airline >>> y = load_airline() >>> transformer = AutoCorrelationTransformer(n_lags=12) >>> y_hat = 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])从类获取类标签值,具有来自父类的标签级别继承。
从类获取类标签,具有来自父类的标签级别继承。
获取 self 的配置标志。
get_fitted_params
([deep])获取已拟合的参数。
获取对象的参数默认值。
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 执行逆转换并返回逆转换后的版本。
检查对象是否由其他 BaseObjects 组成。
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')[source]#
返回评估器的测试参数设置。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则将返回
"default"
集。
- 返回:
- paramsdict 或 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
。- 引发:
- 如果由于
__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
进行检查。- 参数:
- estimatorBaseObject 或派生类的实例
- tag_namesstr 或 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")
。
- 参数:
- X`sktime` 兼容数据容器格式的时间序列
用于拟合和转换的数据。
`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
中传递,不是可选的。有关所需格式,请参阅类文档字符串了解详细信息。
- 返回:
- self评估器的已拟合实例
- fit_transform(X, y=None)[source]#
拟合数据,然后对其进行转换。
将转换器拟合到 X 和 y,并返回 X 的转换版本。
- 状态变化
将状态更改为“已拟合”。
写入 self: _is_fitted : 标志设置为 True。 _X : 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 = 时间序列集合。具有 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
中传递,不是可选的。有关所需格式,请参阅类文档字符串了解详细信息。
- 返回:
- 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 实例)。示例: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
的标签值,考虑标签覆盖,按以下降序优先级:在类的
_tags
属性中设置的标签。在父类
_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
属性的任何键。值是相应的标签值,覆盖按以下降序优先级:
在类的
_tags
属性中设置的标签。在父类
_tags
属性中设置的标签,
按继承顺序。
实例可以根据超参数覆盖这些标签。
要检索具有潜在实例覆盖的标签,请改用
get_tags
方法。不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要包含来自动态标签的覆盖,请使用
get_tags
。- collected_tagsdict
标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性收集。未被set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取 self 的配置标志。
配置是
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
的单个标签的值,考虑标签覆盖,按以下降序优先级:通过实例上的
set_tags
或clone_tags
设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类
_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
。
- ValueError, 如果
- get_tags()[source]#
从实例获取标签,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会改变的静态标志。get_tags
方法返回一个标签字典,其键是类或其任何父类中设置的_tags
属性的任何键,或者通过set_tags
或clone_tags
设置的标签。值是相应的标签值,覆盖按以下降序优先级:
通过实例上的
set_tags
或clone_tags
设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类
_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
- 参数:
- X`sktime` 兼容数据容器格式的时间序列
用于拟合和转换的数据。
`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
附加数据,例如用于转换的标签。某些转换器需要此数据,请参阅类文档字符串了解详细信息。
- 返回:
- 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)
的输出
- 反序列化的 self,结果位于
- 类方法 load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第 1 个元素
- serial
- 返回:
- 反序列化自身,产生来自
cls.save(None)
的输出serial
- 反序列化自身,产生来自
- reset()[source]#
将对象重置为干净的初始化后状态。
将
self
设置为构造函数调用后直接所处的状态,保持相同的超参数。通过set_config
设置的配置值也会保留。reset
调用会删除任何对象属性,除了超参数 =
__init__
的参数,并写入到self
中,例如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 保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化 self;如果path
是文件位置,则将 self 存储在该位置作为 zip 文件保存的文件是 zip 文件,包含以下内容:_metadata - 包含 self 的类,即 type(self);_obj - 序列化的 self。此类使用默认序列化(pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,则将 self 保存为内存中的对象;如果是文件位置,则将 self 保存到该文件位置。
如果 path=”estimator”,则会在当前工作目录 (cwd) 下生成一个名为
estimator.zip
的 zip 文件。如果 path=”/home/stored/estimator”,则会生成一个名为
estimator.zip
的 zip 文件,
存储在
/home/stored/
中。- serialization_format: str, 默认值 = “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 时是仅列出自参数与默认值不同的参数 (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
在并行化后关闭。
- “shutdown_ray”: bool, 默认值=True;False 会阻止
“logger_name”: str, 默认值=”ray”;要使用的 logger 名称。
“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)[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]#
为 self 设置 random_state 伪随机种子参数。
通过
self.get_params
查找名为random_state
的参数,并使用通过链式哈希(通过sample_dependent_seed
)从random_state
派生的整数来设置它们(通过set_params
)。这些整数保证了种子随机生成器的伪随机独立性。适用于
self
中的random_state
参数,具体取决于self_policy
;并且仅当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)[source]#
将实例级别标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储关于对象的元数据。标签是特定于实例
self
的键值对,它们是静态标志,在对象构造后不会更改。它们可用于元数据检查或控制对象的行为。set_tags
根据tag_dict
中指定的值设置动态标签覆盖,其中键是标签名称,字典值是要设置的标签值。set_tags
方法只能在对象的__init__
方法中(在构造期间)或通过__init__
直接在构造后调用。当前标签值可以通过
get_tags
或get_tag
进行检查。- 参数:
- **tag_dictdict
标签名称: 标签值 对的字典。
- 返回:
- Self
对 self 的引用。
- transform(X, y=None)[source]#
转换 X 并返回转换后的版本。
- 所需状态
要求状态为“已拟合”。
访问 self 中的
以“_”结尾的已拟合模型属性。
self.is_fitted
,必须为 True
- 参数:
- X`sktime` 兼容数据容器格式的时间序列
要转换的数据。
`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
附加数据,例如用于转换的标签。某些转换器需要此数据,请参阅类文档字符串了解详细信息。
- 返回:
- X 的转换版本
- 类型取决于 X 的类型和 scitype:transform-output 标签
转换 (transform)
X (输入)
-输出 (-output)
返回类型 (type of return)
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
写入 self
以“_”结尾的已拟合模型属性。
如果
remember_data
标签为 True,则通过update_data
,将数据写入self._X
,并通过X
中的值进行更新。
- 参数:
- X`sktime` 兼容数据容器格式的时间序列
用于更新转换的数据
`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评估器的已拟合实例