TimeBinner#
- class TimeBinner(idx, aggfunc=None)[source]#
根据时间间隔将时间序列/面板数据转换为表格数据。
该估计器将包含时间序列/面板数据(数据框单元格中包含 numpy 数组或 pandas Series)的嵌套 pandas 数据框转换为表格 pandas 数据框,其单元格中仅包含原始数据类型。原始数据类型根据 IntervalIndex 定义的间隔计算,并通过 aggfunc 进行聚合。
这对于将时间序列/面板数据转换为标准验证学习算法(如 sklearn 中的算法)接受的格式非常有用。
- 参数:
- idxpd.IntervalIndex
定义 aggfunc 考虑的间隔的 IntervalIndex
- aggfunccallable
用于聚合间隔中值的函数。应具有 1D -> float 的签名,如果为 None 则默认为均值
- 属性:
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])从类中获取类标签值,带有从父类继承的标签级别。
从类中获取类标签,带有从父类继承的标签级别。
获取自身的配置标志。
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])将序列化的自身保存到字节类对象或 (.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。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,is_fitted
属性应设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, optional
调用此方法的函数名称。如果提供,错误消息将包含此信息。
- 引发:
- 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 或 list of str, 默认 = None
要克隆的标签名称。默认值(
None
)克隆estimator
中的所有标签。
- 返回:
- self
self
的引用。
- classmethod create_test_instance(parameter_set='default')[source]#
使用第一个测试参数集构造类的一个实例。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集名称,用于测试。如果未为某个值定义特殊参数,则返回 “default” 集。
- 返回:
- instance具有默认参数的类实例
- classmethod create_test_instances_and_names(parameter_set='default')[source]#
创建所有测试实例的列表以及它们的名称列表。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集名称,用于测试。如果未为某个值定义特殊参数,则返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例为
cls(**cls.get_test_params()[i])
- nameslist of str, 与 objs 长度相同
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
- fit(X, y=None)[source]#
将转换器拟合到 X,可选择拟合到 y。
- 状态改变
将状态更改为“fitted”。
写入自身
设置以“_”结尾的拟合模型属性,拟合属性可通过
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
科学类型 = 单个时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)Panel
科学类型 = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,Series
类型的pd.DataFrame
list
Hierarchical
科学类型 = 分层时间序列集合。带有 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 的转换版本。
- 状态改变
将状态更改为“fitted”。
写入自身:_is_fitted:标志设置为 True。_X:X,X 的强制副本,如果 remember_data 标签为 True
可能强制转换为内部类型或通过引用转换为 update_data 兼容类型(如果可能)
模型属性(以“_”结尾):取决于估计器
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于拟合转换的数据,以及要转换的数据。
sktime
中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。Series
科学类型 = 单个时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)Panel
科学类型 = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,Series
类型的pd.DataFrame
list
Hierarchical
科学类型 = 分层时间序列集合。带有 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
,
则返回结果是一个
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]#
获取自身的配置标志。
Configs 是
self
的键值对,通常用作控制行为的瞬态标志。get_config
返回动态配置,这些配置会覆盖默认配置。默认配置在类或其父类的
_config
类属性中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用时保留。- 返回:
- config_dictdict
配置名称:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性中收集任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取拟合参数。
- 所需状态
要求状态为“fitted”。
- 参数:
- deepbool, default=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]#
获取对象的参数名称。
- 参数:
- sortbool, default=True
是否按字母顺序(True)或按其在类
__init__
中出现的顺序(False)返回参数名称。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则与其在类__init__
中出现的顺序相同。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[source]#
获取此对象的参数值字典。
- 参数:
- deepbool, default=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_default任意类型,可选;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”
要返回的测试参数集名称,用于测试。如果未为某个值定义特殊参数,则返回
"default"
集。目前转换器没有保留值。
- 返回:
- paramsdict or list of dict, default = {}
用于创建类测试实例的参数。每个 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.is_fitted
,必须为 True
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于拟合转换的数据。
sktime
中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。Series
科学类型 = 单个时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)Panel
科学类型 = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,Series
类型的pd.DataFrame
list
Hierarchical
科学类型 = 分层时间序列集合。带有 3 级或更多行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 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) 的结果
- 返回:
- 反序列化后的自身,结果输出到
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))`` 获得的对象相同。- 返回:
- self
类实例重置为干净的初始化后状态,但保留当前的超参数值。
- save(path=None, serialization_format='pickle')[source]#
将序列化的自身保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化自身;如果path
是文件位置,则将自身以 zip 文件形式存储在该位置保存的文件是 zip 文件,包含以下内容:_metadata - 包含自身的类,即 type(self) _obj - 序列化自身。此类使用默认序列化(pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,则将自身保存到内存对象;如果为文件位置,则将自身保存到该文件位置。如果
path=”estimator” 则将在当前工作目录创建 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_dictdict
配置名称 : 配置值对的字典。有效配置、值及其含义如下所示
- displaystr,“diagram”(默认)或“text”
jupyter 内核如何显示自身的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, default=True
打印自身时是否仅列出与默认值不同的自身参数 (False),或列出所有参数名称和值 (False)。不嵌套,即仅影响自身而不影响组件估计器。
- warningsstr,“on”(默认)或“off”
是否引发警告,仅影响 sktime 的警告
“on” = 将引发 sktime 的警告
“off” = 将不引发 sktime 的警告
- backend:parallelstr, optional, default=”None”
用于广播/向量化时并行化的后端,以下之一
“None”:顺序执行循环,简单的列表理解
“loky”、“multiprocessing”和“threading”:使用
joblib.Parallel
“joblib”:自定义和第三方
joblib
后端,例如spark
“dask”:使用
dask
,需要在环境中安装dask
包“ray”:使用
ray
,需要在环境中安装ray
包
- backend:parallel:paramsdict, optional, default={}(未传递参数)
作为配置传递给并行化后端的附加参数。有效键取决于
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对自身的引用。
注意事项
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果引用是明确的,也可以使用不带<component>__
的字符串<parameter>
,例如,如果组件没有两个同名<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
中的random_state
参数,具体取决于self_policy
,并且仅当deep=True
时适用于剩余组件对象。注意:即使
self
没有random_state
参数,或者没有任何组件具有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何scikit-base
对象,即使是那些没有random_state
参数的对象。- 参数:
- random_stateint, RandomState instance or None, default=None
伪随机数生成器,用于控制随机整数的生成。传递 int 可在多次函数调用中获得可重复的输出。
- deepbool, default=True
是否在 scikit-base 对象值参数中设置随机状态,即组件估计器。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则同时设置组件对象中的
random_state
参数。
- self_policystr,以下之一 {"copy", "keep", "new"}, default="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
标签名称:标签值对的字典。
- 返回:
- Self
对自身的引用。
- transform(X, y=None)[source]#
转换 X 并返回转换后的版本。
- 所需状态
要求状态为“fitted”。
自身访问
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
- 参数:
- X
sktime
兼容数据容器格式的时间序列 要转换的数据。
sktime
中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。Series
科学类型 = 单个时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)Panel
科学类型 = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,Series
类型的pd.DataFrame
list
Hierarchical
科学类型 = 分层时间序列集合。带有 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
-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
,
则返回结果是一个
Panel
对象,类型为pd-multiindex
。示例:输出的第 i 个实例是运行在X
上的第 i 个窗口
- update(X, y=None, update_params=True)[source]#
使用 X 更新转换器,可选择使用 y。
- 所需状态
要求状态为“fitted”。
自身访问
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
写入自身
以“_”结尾的拟合模型属性。
如果
remember_data
标签为 True,则通过update_data
将self._X
更新为X
中的值。
- 参数:
- X
sktime
兼容数据容器格式的时间序列 用于更新转换的数据
sktime
中的单个数据格式是所谓的 mtype 规范,每个 mtype 实现一个抽象的 scitype。Series
科学类型 = 单个时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)Panel
科学类型 = 时间序列集合。带有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,Series
类型的pd.DataFrame
list
Hierarchical
科学类型 = 分层时间序列集合。带有 3 级或更多行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 mtype 词汇表。有关用法,请参见转换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,默认为 None
附加数据,例如用于转换的标签。某些转换器需要此项,详见类文档字符串。
- X
- 返回:
- self估计器的拟合实例