合并器#
- class Merger(method='median', stride=0)[source]#
聚合包含一个时间序列重叠窗口的 Panel 数据。
输入数据包含多个重叠的时间序列元素,可以排列如下:xxxx….. .xxxx…. ..xxxx… …xxxx.. ….xxxx. …..xxxx ……xxxx …….xxxx ……..xxxx ………xxxx。合并器通过对齐如上所示的时间序列窗口,并对重叠数据点应用聚合函数来聚合数据。聚合函数可以是“mean”或“median”之一。即,计算每列的
mean
或median
,从而得到一个单变量时间序列。- 参数:
- method{
median
,mean
},默认值=”median” 用于聚合的方法。可以是“mean”或“median”之一。
- strideint,默认值=0
用于聚合的步幅。步幅决定了连续实例之间的偏移量。步幅为 0 表示没有偏移。步幅为 1 表示时间序列按上述方式聚合。
- method{
- 属性:
is_fitted
是否已调用
fit
。
示例
>>> from sktime.transformations.merger import Merger >>> from sktime.utils._testing.panel import _make_panel >>> y = _make_panel(n_instances=10, n_columns=3, n_timepoints=5) >>> result = Merger(method="median").fit_transform(y) >>> result.shape (5, 3)
>>> from sktime.transformations.merger import Merger >>> from sktime.utils._testing.panel import _make_panel >>> y = _make_panel(n_instances=10, n_columns=3, n_timepoints=5) >>> result = Merger(method="median", stride=1).fit_transform(y) >>> result.shape (14, 3)
方法
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_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 并返回逆转换后的版本。
检查对象是否由其他 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_setstr,默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回
"default"
集。目前预测器没有保留值。
- 返回:
- paramsdict 或 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,可选
调用此方法的名称。如果提供,错误消息将包含此信息。
- 抛出:
- 未拟合错误
如果估计器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象克隆。
克隆是另一个没有共享引用的对象,处于初始化后状态。此函数等效于返回
sklearn.clone
的self
。等效于构造一个具有
self
参数的新type(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_namesstr 或 str 列表,默认值 = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回:
- 自身
对
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 个元素是测试中 objs 的第 i 个实例的名称。命名约定为:如果实例多于一个,则为
{cls.__name__}-{i}
,否则为{cls.__name__}
- fit(X, y=None)[source]#
将转换器拟合到 X,可选拟合到 y。
- 状态变更
将状态更改为“已拟合”。
写入自身
设置以“_”结尾的已拟合模型属性,已拟合属性可通过以下方法查看:
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
列表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采用
- 返回:
- self估算器的已拟合实例
- fit_transform(X, y=None)[source]#
拟合数据,然后转换它。
将变换器拟合到 X 和 y,并返回 X 的变换版本。
- 状态变更
将状态更改为“已拟合”。
写入自身:_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 = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
、3D np.ndarray
(instance, variable, time)
,以及Series
类型的pd.DataFrame
列表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 的变换版本
- 类型取决于 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 实例)。示例:面板中的所有序列均单独进行去趋势处理如果
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_defaultany type
如果未找到标签,则使用的默认/回退值。
- 返回:
- 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_tags字典
标签名:标签值对的字典。通过嵌套继承从
_tags
类属性中收集。不会被通过set_tags
或clone_tags
设置的动态标签覆盖。
- get_config()[source]#
获取自身的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的
_config
类属性中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用后保留。- 返回:
- config_dict字典
配置名:配置值对的字典。通过嵌套继承从 _config 类属性中收集,然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- deep布尔值,默认为 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()[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键为 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
兼容的对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。get_tag
方法从实例中检索名称为tag_name
的单个标签值,考虑标签覆盖,优先级从高到低如下所示:在实例构建时,通过
set_tags
或clone_tags
在实例上设置的标签。
在实例构建时。
在类的
_tags
属性中设置的标签。在父类的
_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
设置的标签的键。值是相应的标签值,覆盖优先级从高到低如下所示:
在实例构建时,通过
set_tags
或clone_tags
在实例上设置的标签。
在实例构建时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序排列。
- 返回:
- collected_tags字典
标签名:标签值对的字典。通过嵌套继承从
_tags
类属性中收集,然后是来自_tags_dynamic
对象属性的任何覆盖和新标签。
- inverse_transform(X, y=None)[source]#
逆转换 X 并返回逆转换后的版本。
- 目前假设只有具有以下标签的变换器
“scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,
具有 inverse_transform。
- 所需状态
要求状态为“已拟合”。
在自身中的访问
以“_”结尾的已拟合模型属性。
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
列表Hierarchical
scitype = 分层时间序列集合。带有 3 级或更高级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
有关数据格式的更多详细信息,请参阅关于 mtype 的词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认值为 None
额外数据,例如用于变换的标签。有些变换器需要此数据,详情请参阅类文档字符串。
- X采用
- 返回:
- X 的逆变换版本
与 X 类型相同,并符合 mtype 格式规范
- is_composite()[source]#
检查对象是否由其他 BaseObject 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: 布尔值
对象是否具有任何参数,其值为
BaseObject
的后代实例。
- property is_fitted[source]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性应在对象构建期间初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- 布尔值
估算器是否已 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 反序列化自身,生成位于
path
的输出,即cls.save(path)
的结果
- 反序列化自身,生成位于
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化自身,生成输出
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))`` 后获得的对象相同。- 返回:
- 自身
将类实例重置到干净的初始化后状态,但保留当前的超参数值。
- save(path=None, serialization_format='pickle')[source]#
将序列化的自身保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化自身;如果path
是文件位置,则将自身作为 zip 文件存储在该位置保存的文件是 zip 文件,内容如下:_metadata - 包含自身的类,即 type(self);_obj - 序列化的自身。此类使用默认序列化方法 (pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,自身将被保存到内存对象中;如果是文件位置,自身将被保存到该文件位置。如果
path=”estimator”,则将在当前工作目录 (cwd) 创建一个 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则将创建一个 zip 文件
estimator.zip
并
存储在
/home/stored/
。- serialization_format: str, default = “pickle”
用于序列化的模块。可用选项包括“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化自身 - 如果
path
是文件位置 - 引用该文件的 ZipFile
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dict字典
配置名:配置值对的字典。有效的配置、值及其含义列举如下:
- displaystr,“diagram”(默认)或“text”
jupyter 内核如何显示自身实例
“diagram” = HTML 框图表示
“text” = 字符串打印输出
- print_changed_only布尔值,默认为 True
打印自身时是只列出与默认值不同的自身参数 (False),还是列出所有参数名称和值 (False)。不嵌套,即只影响自身而非组件估算器。
- 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: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
在并行化后 关闭。
- “shutdown_ray”:布尔值,默认为 True;如果为 False,则阻止
“logger_name”:str,默认为“ray”;要使用的日志记录器名称。
“mute_warnings”:布尔值,默认为 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对自身的引用。
注意
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
该方法适用于简单的 skbase 对象以及复合对象。对于复合对象(即包含其他对象的对象),可以使用参数键字符串
<component>__<parameter>
来访问组件<component>
中的<parameter>
。如果引用是明确的(例如,没有两个组件参数同名<parameter>
),也可以使用字符串<parameter>
,不带<component>__
。- 参数:
- **params字典
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,前提是在 get_params 键中是唯一的。
- 返回:
- 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
中的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 可在多次函数调用中获得可重现的输出。
- deep布尔值,默认为 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对自身的引用
- set_tags(**tag_dict)[source]#
将实例级标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储关于对象的元数据。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象构造期间,或通过__init__
构造后直接在对象的__init__
方法中调用。可以通过
get_tags
或get_tag
检查当前标签值。- 参数:
- **tag_dict字典
标签名:标签值对字典。
- 返回:
- 自身
对自身的引用。
- transform(X, y=None)[source]#
转换 X 并返回转换后的版本。
- 所需状态
要求状态为“已拟合”。
在自身中的访问
以“_”结尾的已拟合模型属性。
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
列表Hierarchical
scitype = 分层时间序列集合。带有 3 级或更高级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
有关数据格式的更多详细信息,请参阅关于 mtype 的词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认值为 None
额外数据,例如用于变换的标签。有些变换器需要此数据,详情请参阅类文档字符串。
- X采用
- 返回:
- X 的变换版本
- 类型取决于 X 的类型和 scitype:transform-output 标签
transform
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 实例)。示例:面板中的所有序列均单独进行去趋势处理如果
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.is_fitted
,必须为 True
写入自身
以“_”结尾的已拟合模型属性。
如果
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
列表Hierarchical
scitype = 分层时间序列集合。带有 3 级或更高级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
有关数据格式的更多详细信息,请参阅关于 mtype 的词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认值为 None
额外数据,例如用于变换的标签。有些变换器需要此数据,详情请参阅类文档字符串。
- X采用
- 返回:
- self估算器的已拟合实例