SplitterSummarizer#
- class SplitterSummarizer(transformer, splitter=None, index='last', fit_on='transform_train', transform_on='transform_train')[source]#
创建时间序列分割的汇总值。
一种序列到序列的转换器,它将序列到原语的转换器
transformer
应用于使用分割器splitter
创建的每个训练分割。结果序列的第 i 行等同于
transformer.fit(X_fit).transform(X_trafo)
,其中X_fit
和X_transform
是根据fit_on
和transform_on
参数从splitter
的第i-th
分割中获得的。输出序列旨在根据给定的转换器和分割器提供输入序列的摘要。
- 参数:
- transformer继承自
BaseTransformer
的sktime
转换器 用于将序列转换为原语的序列到原语转换器。
- splitter继承自
BaseSplitter
的sktime
分割器,可选 - (默认值为 None)
用于分割序列的分割器。如果为 None,则使用
ExpandingWindowSplitter
,其start_with_window=False
,其余参数为默认值。- indexstr,可选(默认值为“last”)
确定结果序列的索引方法。如果为“last”,则使用分割的最新索引。如果为其他值,则行号成为索引。
- fit_onstr,可选(默认值为“transform_train”)
对于结果序列的第
i
行,使用什么数据来拟合transformer
。“all_train” : 转换从
splitter.split_series
获得的第i
个训练分割,该分割应用于在fit
和update
调用中见过的所有数据,以及在transform
中见过的所有数据。“all_test” : 转换从
splitter.split_series
获得的第i
个测试分割,该分割应用于在fit
和update
调用中见过的所有数据,以及在transform
中见过的所有数据。“transform_train” : 转换从
splitter.split_series
获得的第i
个训练分割,该分割应用于在transform
中见到的数据。“transform_test” : 转换从
splitter.split_series
获得的第i
个测试分割,该分割应用于在transform
中见到的数据。
- transform_onstr,可选(默认值为“transform_train”)
对于结果序列的第
i
行,使用什么数据进行transformer
转换。值和含义与fit_on
相同。
- transformer继承自
- 属性:
is_fitted
是否已调用
fit
方法。
另请参阅
SummaryTransformer
计算时间序列的汇总值。
示例
>>> from sktime.transformations.series.summarize import SplitterSummarizer >>> from sktime.transformations.series.summarize import SummaryTransformer >>> from sktime.split import ExpandingWindowSplitter >>> from sktime.datasets import load_airline >>> y = load_airline() >>> transformer = SplitterSummarizer( ... transformer=SummaryTransformer(), ... splitter=ExpandingWindowSplitter()) >>> y_splitsummarized = transformer.fit_transform(y)
方法
transform(X)
(根据指定的)序列到原语转换器和分割器转换序列。
- check_is_fitted(method_name=None)[source]#
检查评估器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr,可选
调用此方法的函数名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果评估器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个不同的对象,没有共享引用,处于后初始化状态。此函数等同于返回
self
的sklearn.clone
。等同于使用
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
对
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。
- 状态变更
将状态更改为“fitted”。
写入 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
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
,元素为Series
类型的pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
,行索引为 3 级或更多级MultiIndex
(层级_1, ..., 层级_n, 时间)
有关数据格式的更多详细信息,请参见 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 的转换版本。
- 状态变更
将状态更改为“fitted”。
写入 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
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
,元素为Series
类型的pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
,行索引为 3 级或更多级MultiIndex
(层级_1, ..., 层级_n, 时间)
有关数据格式的更多详细信息,请参见 mtype 术语表。有关用法,请参见转换器教程
examples/03_transformers.ipynb
- y可选,
sktime
兼容数据格式的数据,默认值为 None 附加数据,例如用于转换的标签。如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,不是可选的。有关所需格式,请参阅类文档字符串了解详细信息。
- X
- 返回:
- X 的转换版本
- 类型取决于 X 的类型和 scitype:transform-output 标签
- X | tf-输出 | 返回类型 |
|----------|————–|------------------------| | 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_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]#
获取拟合参数。
- 所需状态
需要状态为“fitted”。
- 参数:
- deepbool,默认值为 True
是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名:值字典,包括可拟合组件(= BaseEstimator 类型参数)的拟合参数。
如果为 False,将返回此对象的参数名:值字典,但不包括组件的拟合参数。
- 返回:
- fitted_params键为 str 类型的字典
拟合参数字典,参数名:参数值键值对包括
始终:此对象的所有拟合参数,通过 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
。
- 引发:
- 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]#
返回转换器的测试参数设置。
- 参数:
- parameter_setstr,默认值为“default”
要返回的测试参数集名称,用于测试。如果未为某个值定义特殊参数,将返回
"default"
集。
- 返回:
- paramsdict 或 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 方法。
- 所需状态
需要状态为“fitted”。
访问 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
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
,元素为Series
类型的pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
,行索引为 3 级或更多级MultiIndex
(层级_1, ..., 层级_n, 时间)
有关数据格式的更多详细信息,请参见 mtype 术语表。有关用法,请参见转换器教程
examples/03_transformers.ipynb
- y可选,
sktime
兼容数据格式的数据,默认值为 None 附加数据,例如用于转换的标签。某些转换器需要此项,详细信息请参见类文档字符串。
- X
- 返回:
- 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,结果输出到
- classmethod load_from_serial(serial)[source]#
从序列化的内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第 1 个元素
- serial
- 返回:
- 反序列化 self,结果输出到
serial
,是cls.save(None)
的输出
- 反序列化 self,结果输出到
- 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) 创建一个 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则将在
/home/stored/
创建一个 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 如何显示自身的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认=True
打印自身时是否仅列出与默认值不同的自身参数(True),或列出所有参数名称和值(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: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自身的引用。
备注
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象和复合对象。对于复合对象,即包含其他对象的对象,可以使用参数键字符串
<component>__<parameter>
来访问组件<component>
中的<parameter>
。如果引用明确,例如没有两个组件参数同名<parameter>
,也可以使用不带<component>__
的字符串<parameter>
。- 参数:
- **paramsdict
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_policy
,适用于self
中的random_state
参数;当且仅当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自身的引用
- set_tags(**tag_dict)[source]#
将实例级别的标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储对象的元数据。标签是特定于实例
self
的键值对,它们是对象构造后不会改变的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中调用,即在构造期间或通过__init__
直接构造后调用。当前的标签值可以通过
get_tags
或get_tag
查看。- 参数:
- **tag_dictdict
标签名称 : 标签值对的字典。
- 返回:
- 自身
自身的引用。
- transform(X, y=None)[source]#
转换 X 并返回转换后的版本。
- 所需状态
需要状态为“fitted”。
访问 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
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
,元素为Series
类型的pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
,行索引为 3 级或更多级MultiIndex
(层级_1, ..., 层级_n, 时间)
有关数据格式的更多详细信息,请参见 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
,则返回是一个 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。
- 所需状态
需要状态为“fitted”。
访问 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
(实例, 时间)
,3D np.ndarray
(实例, 变量, 时间)
,list
,元素为Series
类型的pd.DataFrame
Hierarchical
scitype = 分层时间序列集合。pd.DataFrame
,行索引为 3 级或更多级MultiIndex
(层级_1, ..., 层级_n, 时间)
有关数据格式的更多详细信息,请参见 mtype 术语表。有关用法,请参见转换器教程
examples/03_transformers.ipynb
- y可选,
sktime
兼容数据格式的数据,默认值为 None 附加数据,例如用于转换的标签。某些转换器需要此项,详细信息请参见类文档字符串。
- X
- 返回:
- self评估器的拟合实例