DilationMappingTransformer#
- class DilationMappingTransformer(dilation=2)[source]#
膨胀映射转换器。
一种用于将索引网格膨胀映射应用于时间序列数据的转换器,根据 [1] 中的术语。
这种转换的灵感来源于核膨胀,它通过重新排列时间序列的时间步来模拟膨胀效果。例如,在管道中,它使得下游本身不支持膨胀功能的模型能够获得类似膨胀的效果。
数学上,该映射作用于序列 \(x_1, \dots, x_k\)。因子为 \(d\) 的膨胀定义为序列 \(x_1, x_{1+d}, x_{1+2d}, \dots, x_2, x_{2+d}, x_{2+2d}, \dots, x_d, x_{2d}, \dots\),其中网格间距为 \(d\) 的子序列是最大的。
结果序列的长度与输入序列相等。
该转换器会重新排列值,并且如果 mtype 是基于
pandas
的,则会将序列索引重置为RangeIndex
。- 参数:
- dilationint 类型,默认值为 2
膨胀因子。决定了转换后序列中原始数据点之间的间距。必须是大于 0 的整数。膨胀因子为 1 意味着没有变化,而更高的值会增加间距。
- 属性:
is_fitted
`fit` 方法是否已被调用。
参考文献
[1]Patrick Schäfer and Ulf Leser, “WEASEL 2.0–A Random Dilated Dictionary Transform for Fast, Accurate and Memory Constrained Time Series Classification”, 2023, arXiv preprint arXiv:2301.10194。
示例
>>> from sktime.transformations.series.dilation_mapping import \ ... DilationMappingTransformer >>> from sktime.datasets import load_airline >>> y = load_airline() >>> y_transform = DilationMappingTransformer(dilation=2).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_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 列表,默认值为 {}
用于创建类测试实例的参数。每个 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]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个没有共享引用、处于初始化后状态的不同对象。此函数等效于返回
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_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 个元素是测试中对象的第 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
pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅mtype词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,采用 sktime 兼容数据格式的数据,默认值为 None
附加数据,例如用于转换的标签。一些转换器需要此数据,请参阅类 docstring 以获取详细信息。
- X采用
- 返回值:
- self估计器的一个已拟合实例
- fit_transform(X, y=None)[source]#
拟合数据,然后对其进行转换。
将转换器拟合到 X 和 y,并返回 X 的转换版本。
- 状态变更
将状态变更为“已拟合”。
写入 self:_is_fitted : 标志设置为 True。 _X : X,如果 remember_data 标签为 True,则为强制转换的 X 副本
如果可能,可能会通过引用强制转换为内部类型或 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
pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
带有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
有关数据格式的更多详细信息,请参阅mtype词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
- y可选,采用 sktime 兼容数据格式的数据,默认值为 None
附加数据,例如用于转换的标签。一些转换器需要此数据,请参阅类 docstring 以获取详细信息。
- 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
,则返回与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
的标签值,并按照以下优先级降序考虑标签覆盖:在类的
_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
的键值对,通常用作控制行为的瞬时标志。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
已拟合参数字典,参数名称 : 参数值的键值对包括
始终:此对象的所有已拟合参数,通过 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
参数字典,参数名 : 参数值 键值对包括
始终:此对象的所有参数,如通过
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
。
- 引发:
- 如果
raise_error
为True
,则引发 ValueError。 如果
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_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 = 时间序列集合。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
额外数据,例如转换的标签。一些转换器需要此数据,详情请参阅类文档字符串。
- X采用
- 返回值:
- X 的逆变换版本
类型与 X 相同,并符合 mtype 格式规范
- is_composite()[source]#
检查对象是否由其他 BaseObject 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回值:
- composite: bool
对象是否具有其值是
BaseObject
后代实例的任何参数。
- property is_fitted[source]#
`fit` 方法是否已被调用。
检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回值:
- bool
估计器是否已 拟合。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回值:
- 反序列化的 self,结果输出到
path
,即cls.save(path)
的输出。
- 反序列化的 self,结果输出到
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回值:
- 反序列化的 self,结果输出
serial
,即cls.save(None)
的输出。
- 反序列化的 self,结果输出
- 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”,则 zip 文件
estimator.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 时是仅列出与默认值不同的 self 参数 (False),还是列出所有参数名和值 (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”;要使用的日志记录器名称。
“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]#
为自身设置 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 以在多次函数调用中获得可重现的输出。
- 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 = 时间序列集合。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
额外数据,例如转换的标签。一些转换器需要此数据,详情请参阅类文档字符串。
- X采用
- 返回值:
- 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。
- 所需状态
需要状态为“已拟合”。
在 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 = 时间序列集合。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
额外数据,例如转换的标签。一些转换器需要此数据,详情请参阅类文档字符串。
- X采用
- 返回值:
- self估计器的一个已拟合实例