随机区间分割器#
- 类 RandomIntervalSegmenter(n_intervals='sqrt', min_length=None, max_length=None, random_state=None)[源代码]#
随机区间分割器变换器。
该变换器将时间序列分割成具有随机起始点和长度的随机区间。某些区间可能会重叠或重复。
- 参数:
- n_intervalsstr, int 或 float
生成的区间数量。 - 如果是“log”,则使用时间序列长度 m 的对数。 - 如果是“sqrt”,则使用 m 的平方根。 - 如果是“random”,则生成随机数量的区间。 - 如果是 int,则生成 n_intervals 个区间。 - 如果是 float,则使用 int(n_intervals * m),其中 n_intervals 表示区间数量占时间序列长度的比例。
对于所有与时间序列长度相关的参数,生成的区间数量始终至少为 1。
默认值为“sqrt”。
- random_stateint, RandomState 实例或 None, 可选 (默认为 None)
如果为 int,则 random_state 是随机数生成器使用的种子;如果为 RandomState 实例,则 random_state 是随机数生成器;如果为 None,则随机数生成器是
np.random
使用的 RandomState 实例。
- 属性:
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。
- 类方法 get_test_params(parameter_set='default')[源代码]#
返回评估器的测试参数设置。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回
"default"
集。
- 返回:
- paramsdict 或 list of dict, default = {}
用于创建类的测试实例的参数。每个 dict 是构造一个“有趣”测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。
- check_is_fitted(method_name=None)[源代码]#
检查评估器是否已经拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则抛出
NotFittedError
。- 参数:
- method_namestr, 可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 抛出:
- 未拟合错误
如果评估器尚未拟合。
- clone()[源代码]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个不同的对象,没有共享引用,处于初始化后状态。此函数等效于返回
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)[源代码]#
从另一个对象克隆标签作为动态覆盖。
每个
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, default = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回:
- self
对
self
的引用。
- 类方法 create_test_instance(parameter_set='default')[源代码]#
构造一个类的实例,使用第一个测试参数集。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- instance具有默认参数的类实例
- 类方法 create_test_instances_and_names(parameter_set='default')[源代码]#
创建所有测试实例列表及其名称列表。
- 参数:
- parameter_setstr, default=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
- 返回:
- objscls 实例列表
第 i 个实例是
cls(**cls.get_test_params()[i])
- namesstr 列表,与 objs 长度相同
第 i 个元素是测试中第 i 个 obj 实例的名称。如果实例多于一个,命名约定为
{cls.__name__}-{i}
,否则为{cls.__name__}
。
- fit(X, y=None)[源代码]#
将变换器拟合到 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")
。
- 参数:
- Xsktime 兼容数据容器格式的时间序列
要拟合变换的数据。
sktime
中的单个数据格式是所谓的mtype 规范,每个 mtype 实现一个抽象的scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的pd.DataFrame
列表Hierarchical
scitype = 分层时间序列集合。具有 3 个或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 mtype 词汇表。有关用法,请参见变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,default=None
附加数据,例如用于变换的标签。如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,不是可选的。所需格式请参见类文档字符串中的详细信息。
- 返回:
- self评估器的拟合实例
- fit_transform(X, y=None)[源代码]#
拟合数据,然后变换。
将变换器拟合到 X 和 y,并返回 X 的变换版本。
- 状态变化
将状态更改为“fitted”。
写入 self: _is_fitted : 标志设置为 True。 _X : X 的强制转换副本,如果 remember_data 标签为 True
如果可能,强制转换为内部类型或 update_data 兼容类型(通过引用)
模型属性(以“_”结尾):取决于评估器
- 参数:
- Xsktime 兼容数据容器格式的时间序列
要拟合变换的数据,以及要变换的数据。
sktime
中的单个数据格式是所谓的mtype 规范,每个 mtype 实现一个抽象的scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的pd.DataFrame
列表Hierarchical
scitype = 分层时间序列集合。具有 3 个或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 mtype 词汇表。有关用法,请参见变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,default=None
附加数据,例如用于变换的标签。如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,不是可选的。所需格式请参见类文档字符串中的详细信息。
- 返回:
- 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 个窗口
- 类方法 get_class_tag(tag_name, tag_value_default=None)[源代码]#
从类获取类标签值,具有来自父类的标签级别继承。
每个
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
。
- 类方法 get_class_tags()[源代码]#
从类获取类标签,具有来自父类的标签级别继承。
每个
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()[源代码]#
获取自身的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬态标志。get_config
返回动态配置,它覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下保留。- 返回:
- config_dictdict
配置名:配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后是 _onfig_dynamic 对象属性中的任何覆盖和新标签。
- get_fitted_params(deep=True)[源代码]#
获取拟合参数。
- 所需状态
要求状态为“拟合”。
- 参数:
- 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] 等
- 类方法 get_param_defaults()[源代码]#
获取对象的默认参数。
- 返回:
- default_dict: dict[str, Any]
键是
cls
的所有在__init__
中定义了默认值的参数。值是默认值,如在__init__
中定义的。
- 类方法 get_param_names(sort=True)[源代码]#
获取对象的参数名称。
- 参数:
- sortbool, default=True
是否按字母顺序排序(True)或按它们在类
__init__
中出现的顺序(False)返回参数名称。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,则按它们在类__init__
中出现的顺序排列。如果sort=True
,则按字母顺序排列。
- get_params(deep=True)[源代码]#
获取此对象的参数值字典。
- 参数:
- 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)[源代码]#
从实例获取标签值,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据或控制对象的行为。标签是实例
self
特有的键值对,它们是静态标志,在对象构造后不会改变。get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,优先级从高到低如下:通过
set_tags
或clone_tags
在实例上设置的标签,
在实例构造时。
类中的
_tags
属性中设置的标签。父类中的
_tags
属性中设置的标签,
按继承顺序。
- 参数:
- tag_namestr
要检索的标签名称
- tag_value_default任意类型,可选;默认=None
如果找不到标签的默认/备用值
- raise_errorbool
找不到标签时是否抛出
ValueError
- 返回:
- tag_value任意
self
中tag_name
标签的值。如果找不到,并且raise_error
为 True,则抛出错误,否则返回tag_value_default
。
- 抛出:
- ValueError,如果
raise_error
为True
。 如果
tag_name
不在self.get_tags().keys()
中,则抛出ValueError
。
- ValueError,如果
- get_tags()[源代码]#
从实例获取标签,具有标签级别继承和覆盖。
每个
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)[源代码]#
反向变换 X 并返回一个反向变换版本。
- 目前假定只有带有标签
“scitype:transform-input”=”Series”, “scitype:transform-output”=”Series”,
的变换器具有 inverse_transform。
- 所需状态
要求状态为“拟合”。
访问 self 中的属性
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
- 参数:
- Xsktime 兼容数据容器格式的时间序列
要拟合变换的数据。
sktime
中的单个数据格式是所谓的mtype 规范,每个 mtype 实现一个抽象的scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的pd.DataFrame
列表Hierarchical
scitype = 分层时间序列集合。具有 3 个或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 mtype 词汇表。有关用法,请参见变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,default=None
附加数据,例如用于变换的标签。某些变换器需要此数据,详情请参阅类文档字符串。
- 返回:
- X 的反向变换版本
与 X 类型相同,并符合 mtype 格式规范
- is_composite()[源代码]#
检查对象是否由其他 BaseObjects 组成。
复合对象是指包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool
对象是否具有任何参数,其值是
BaseObject
后代实例。
- 属性 is_fitted[源代码]#
fit
是否已被调用。检查对象的
_is_fitted` 属性,该属性应在对象构造期间初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。- 返回:
- bool
评估器是否已经 fit。
- 类方法 load_from_path(serial)[源代码]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open(“object”) 的结果
- 返回:
- 解序列化的 self,结果位于
path
,是cls.save(path)
的输出
- 解序列化的 self,结果位于
- 类方法 load_from_serial(serial)[源代码]#
从序列化的内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 解序列化的 self,结果为输出
serial
,是cls.save(None)
的输出
- 解序列化的 self,结果为输出
- reset()[源代码]#
将对象重置到干净的初始化后状态。
结果是将
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')[源代码]#
将序列化后的自身保存到类似字节的对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中序列化的自身;如果path
是文件位置,则将自身作为 zip 文件存储在该位置保存的文件是 zip 文件,包含以下内容:_metadata - 包含自身类,即 type(self) _obj - 序列化的自身。此类使用默认序列化(pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,则将自身保存到内存对象;如果为文件位置,则将自身保存到该文件位置。例如,如果
path=”estimator”,则将在当前工作目录创建一个 zip 文件
estimator.zip
。path=”/home/stored/estimator”,则将在
/home/stored/
存储一个 zip 文件estimator.zip
。
serialization_format: str, default = “pickle”
- 用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
如果
path
为 None - 内存中序列化的自身
- 返回:
- 配置名:配置值 对的字典。有效的配置、值及其含义如下所示
将配置标志设置为给定值。
- 参数:
- 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, 可选, default=”None”
- 用于广播/向量化时并行化的后端,可选值之一:
“None”:顺序执行循环,简单的列表推导式
“loky”, “multiprocessing” 和 “threading”:使用
joblib.Parallel
“joblib”:自定义和第三方
joblib
后端,例如spark
“dask”:使用
dask
,需要在环境中安装dask
包“ray”:使用
ray
,需要在环境中安装ray
包backend:parallel:paramsdict, 可选, default={} (不传递参数)
- 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 的引用。
Notes(注释)
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[源码]#
设置此对象的参数。
此方法适用于简单的 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')[源码]#
为自身设置 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, default=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)[源码]#
将实例级别标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储关于对象的元数据。标签是特定于实例
self
的键值对,它们是构造对象后不会改变的静态标志。它们可用于元数据检查,或用于控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,键是标签名称,字典值是要设置的标签值。应仅在对象的
__init__
方法中(构造期间)或通过__init__
直接调用后调用set_tags
方法。可以使用
get_tags
或get_tag
检查当前标签值。- 参数:
- **tag_dictdict
标签名称:标签值 对的字典。
- 返回:
- Self
指向 self 的引用。
- transform(X, y=None)[源码]#
变换 X 并返回一个变换版本。
- 所需状态
要求状态为“拟合”。
访问 self 中的属性
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
- 参数:
- Xsktime 兼容数据容器格式的时间序列
要转换的数据。
sktime
中的单个数据格式是所谓的mtype 规范,每个 mtype 实现一个抽象的scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的pd.DataFrame
列表Hierarchical
scitype = 分层时间序列集合。具有 3 个或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 mtype 词汇表。有关用法,请参见变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,default=None
附加数据,例如用于变换的标签。某些变换器需要此数据,详情请参阅类文档字符串。
- 返回:
- 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)[源码]#
使用 X 更新变换器,可选地使用 y。
- 所需状态
要求状态为“拟合”。
访问 self 中的属性
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True
写入 self
以“_”结尾的拟合模型属性。
如果
remember_data
标签为 True,则通过update_data
将数据写入self._X
,并用X
中的值进行更新。
- 参数:
- Xsktime 兼容数据容器格式的时间序列
用于更新转换的数据
sktime
中的单个数据格式是所谓的mtype 规范,每个 mtype 实现一个抽象的scitype。Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。具有 2 级行MultiIndex
(实例, 时间)
的pd.DataFrame
,3D np.ndarray
(实例, 变量, 时间)
,list
类型的pd.DataFrame
列表Hierarchical
scitype = 分层时间序列集合。具有 3 个或更多级别行MultiIndex
(层级_1, ..., 层级_n, 时间)
的pd.DataFrame
有关数据格式的更多详细信息,请参见 mtype 词汇表。有关用法,请参见变换器教程
examples/03_transformers.ipynb
- y可选,sktime 兼容数据格式的数据,default=None
附加数据,例如用于变换的标签。某些变换器需要此数据,详情请参阅类文档字符串。
- 返回:
- self评估器的拟合实例