RandomIntervalFeatureExtractor#
- class RandomIntervalFeatureExtractor(n_intervals='sqrt', min_length=None, max_length=None, features=None, random_state=None)[source]#
随机区间特征提取器转换。
将时间序列分割成随机区间,并随后提取每个区间的序列到原始特征的转换器。
n_intervals: str{‘sqrt’, ‘log’, ‘random’}, int 或 float, 可选 (默认为 ‘sqrt’)
要生成的随机区间数,其中 m 是时间序列的长度: - 如果为 “log”,使用 m 的对数。 - 如果为 “sqrt”,使用 m 的平方根。 - 如果为 “random”,生成随机数量的区间。 - 如果为 int,生成 n_intervals 个区间。 - 如果为 float,使用 int(n_intervals * m),其中 n_intervals 表示时间序列长度的区间比例。
对于所有与时间序列长度相关的参数,生成的区间数始终至少为 1。
- features: 函数列表, 可选 (默认为 None)
对随机区间应用每个函数以提取特征。如果为 None,则提取均值。
- random_state:int, RandomState 实例, 可选 (默认为 None)
如果为 int,则 random_state 是随机数生成器使用的种子;
如果为 RandomState 实例,则 random_state 是随机数生成器;
如果为 None,则随机数生成器是使用的 RandomState 实例
由
np.random
提供。
- 属性:
is_fitted
是否已调用
fit
方法。
方法
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])返回 skbase 对象的测试参数设置。
inverse_transform
(X[, y])对 X 进行逆转换并返回逆转换后的版本。
检查对象是否由其他 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。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,应将is_fitted
属性设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, 可选
调用此方法的函数名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- 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 或 list of 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 个元素是测试中 objs 中第 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
(1维 或 2维)Panel
scitype = 时间序列集合。 具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
, 或Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层时间序列集合。 具有 3 级或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
的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 版本。
- 状态改变
将状态更改为“已拟合”。
写入 self: _is_fitted : 标志设置为 True。 _X : X 的强制副本,如果 remember_data 标签为 True
如果可能,可能会强制转换为内部类型或通过引用转换为 update_data 兼容类型
模型属性(以“_”结尾):取决于估计器
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于拟合转换和转换的数据。
sktime
中的个体数据格式是所谓的 mtype 规范,每个 mtype 都实现了抽象的 scitype。Series
scitype = 个体时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1维 或 2维)Panel
scitype = 时间序列集合。 具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
, 或Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层时间序列集合。 具有 3 级或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
的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
,则返回的是与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
属性中设置的标签。在父类
_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
对象属性的任何覆盖和新标签。
- classmethod get_test_params(parameter_set='default')[source]#
返回 skbase 对象的测试参数设置。
get_test_params
是一个统一的接口点,用于存储测试目的的参数设置。此函数也用于create_test_instance
和create_test_instances_and_names
来构造测试实例。get_test_params
应返回一个dict
,或一个dict
的list
。每个
dict
都是用于测试的参数配置,可用于构造一个“有趣”的测试实例。调用cls(**params)
对于get_test_params
返回中的所有字典params
都应有效。get_test_params
不必返回固定的字典列表,它也可以返回动态或随机的参数设置。- 参数:
- parameter_setstr, 默认为“default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则将返回 “default” 集。
- 返回:
- paramsdict 或 list of dict, 默认为 {}
用于创建类的测试实例的参数 每个 dict 都是用于构造“有趣”测试实例的参数,即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一的)字典
- 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
(1维 或 2维)Panel
scitype = 时间序列集合。 具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
, 或Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层时间序列集合。 具有 3 级或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 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
估计器是否已 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object) 的结果
- 返回:
- 反序列化 self,结果是
cls.save(path)
的输出在path
位置
- 反序列化 self,结果是
- classmethod load_from_serial(serial)[source]#
从序列化的内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化 self,结果是
cls.save(None)
的输出serial
- 反序列化 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]#
将序列化的 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”,则 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 kernel 如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认为 True
打印 self 时是仅列出自默认值不同的 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”;要使用的日志记录器名称。
- “shutdown_ray”: bool, 默认为 True;False 防止
“mute_warnings”: bool, 默认为 False;如果为 True,则抑制警告
“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
- 返回:
- selfself 的引用。
注意
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及组合对象。参数键字符串
<component>__<parameter>
可用于组合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果引用明确(例如,没有两个组件参数同名为<parameter>
),也可以使用不带<component>__
的字符串<parameter>
。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,如果它们在 get_params 键中是唯一的。
- 返回:
- selfself 的引用(设置参数后)
- 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
中的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
伪随机数生成器,用于控制随机整数的生成。传递整数可在多次函数调用中获得可复现的输出。
- 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
(1维 或 2维)Panel
scitype = 时间序列集合。 具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
, 或Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层时间序列集合。 具有 3 级或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 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
,则返回的是pd.DataFrame
,其行数与X
中的实例数相同。示例:返回的第 i 行包含第 i 个时间序列的均值和方差。如果
X
是Series
并且transform-output
是Panel
,
则返回的是一个
Panel
对象,类型为pd-multiindex
。示例:输出的第 i 个实例是在X
上运行的第 i 个窗口。
- update(X, y=None, update_params=True)[source]#
使用 X 更新转换器,可选地使用 y。
- 所需状态
要求状态为“已拟合”。
访问 self 中的内容
以“_”结尾的已拟合模型属性。
self.is_fitted
, 必须为 True
写入 self
以“_”结尾的已拟合模型属性。
如果
remember_data
标签为 True,则通过update_data
将X
中的值更新到self._X
中。
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于更新转换的数据
sktime
中的个体数据格式是所谓的 mtype 规范,每个 mtype 都实现了抽象的 scitype。Series
scitype = 个体时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1维 或 2维)Panel
scitype = 时间序列集合。 具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
, 或Series
类型pd.DataFrame
的list
Hierarchical
scitype = 分层时间序列集合。 具有 3 级或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 mtype 的术语表。有关用法,请参见转换器教程
examples/03_transformers.ipynb
。- y可选,sktime 兼容数据格式的数据,默认为 None
附加数据,例如用于转换的标签。一些转换器需要此项,详情请参见类文档字符串。
- X
- 返回:
- self估计器的已拟合实例