TSInterpolator#
- class TSInterpolator(length)[source]#
时间序列插值器/重采样器。
用于将时间序列重采样到另一个点数目的转换器。对于 dataframe 中的每个单元格,转换器使用 scipy 的线性 interp1d 进行拟合,并采样用户定义的点数。点通过 numpy.linspace 生成。
转换后,每个单元格将是一个给定长度的 pd.Series。pd.Series 的索引将被更改为整数索引。
- 参数:
- length整数,要调整大小的时间序列的长度。
- 属性:
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
()从实例获取标签,具有标签级别继承和覆盖。
返回估计器的测试参数设置。
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。
- classmethod get_test_params()[source]#
返回估计器的测试参数设置。
- 返回:
- paramsdict 或 list of dict,默认={}
用于创建类的测试实例的参数。每个 dict 都是构造一个“有趣”测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一的)字典。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,应将is_fitted
属性设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, optional
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- 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 个元素是测试中 obj 的第 i 个实例的名称。命名约定为
{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")
。
- 参数:
- Xsktime 兼容数据容器格式的时间序列
用于拟合转换的数据。
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
中传递,不可选。有关所需格式,请参阅类文档字符串以获取详细信息。
- 返回:
- self估计器的已拟合实例
- fit_transform(X, y=None)[source]#
拟合数据,然后对其进行转换。
将转换器拟合到 X 和 y,并返回 X 的转换版本。
- 状态变更
将状态更改为“fitted”。
写入自身: _is_fitted : 标志设置为 True。 _X : X 的强制副本 X,如果 remember_data 标签为 True
如果可能,通过引用强制转换为内部类型或 update_data 兼容类型
模型属性(以“_”结尾): 取决于估计器
- 参数:
- Xsktime 兼容数据容器格式的时间序列
用于拟合转换的数据,以及要转换的数据。
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 的类型和 scitype:transform-output 标签
- | X | tf-output | 返回类型 |
|----------|————–|------------------------| | Series | Primitives | pd.DataFrame (1-row) | | 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
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,它会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并会被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下会被保留。- 返回:
- config_dictdict
配置名 : 配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性收集任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取已拟合的参数。
- 所需状态
要求状态为“已拟合”。
- 参数:
- deepbool, default=True
是否返回组件的已拟合参数。
如果为 True,将返回此对象的参数名:值字典,包括可拟合组件的已拟合参数(= 值为 BaseEstimator 的参数)。
如果为 False,将返回此对象的参数名:值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_paramsdict with str-valued keys
已拟合参数的字典,包含 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
,但不包括组件的参数。
- 返回:
- paramsdict with str-valued keys
参数的字典,包含 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_defaultany type, optional; 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
- 参数:
- Xsktime 兼容数据容器格式的时间序列
用于拟合转换的数据。
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 类型相同,并符合 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]#
从文件位置加载对象。
- 参数:
- serialresult of ZipFile(path).open(“object)
- 返回:
- 反序列化后的 self,其输出位于
path
,来自cls.save(path)
- 反序列化后的 self,其输出位于
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial1st element of output of
cls.save(None)
- serial1st element of output of
- 返回:
- 反序列化后的 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]#
将序列化后的自身保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回一个内存中的序列化 self;如果path
是文件位置,则将 self 作为 zip 文件存储在该位置保存的文件是 zip 文件,包含以下内容:_metadata - 包含 self 的类,即 type(self);_obj - 序列化的 self。此类使用默认序列化(pickle)。
- 参数:
- pathNone or file location (str or Path)
如果为 None,self 将保存到内存对象中;如果是文件位置,self 将保存到该文件位置。如果
path=”estimator” 则将在当前工作目录创建
estimator.zip
zip文件。path=”/home/stored/estimator” 则将在
存储在
/home/stored/
中。创建estimator.zip
zip文件。- serialization_format: str, default = “pickle”
用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化 self - 如果
path
是文件位置 - ZipFile 对象,引用该文件
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名 : 配置值对的字典。有效的配置、值及其含义如下所列
- displaystr, “diagram” (default), or “text”
jupyter 内核如何显示 self 的实例
“diagram” = html 框图表示
“text” = 字符串打印输出
- print_changed_onlybool, default=True
打印 self 时是否只列出与默认值不同的 self 参数 (False),或列出所有参数名称和值 (False)。不进行嵌套,即只影响 self 而不影响组件估计器。
- warningsstr, “on” (default), or “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={} (no parameters passed)
作为配置传递给并行化后端的附加参数。有效键取决于
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, one of “on” (default), “off”, or valid mtype string
控制输入检查和转换,适用于
_fit
、_transform
、_inverse_transform
、_update
"on"
- 执行输入检查和转换"off"
- 在将数据传递给内部方法之前,不执行输入检查和转换有效 mtype 字符串 - 输入假定为指定的 mtype,执行转换但不进行检查
- output_conversionstr, one of “on”, “off”, valid mtype string
控制
_transform
、_inverse_transform
的输出转换"on"
- 如果 input_conversion 为“on”,则执行输出转换"off"
- 直接返回_transform
、_inverse_transform
的输出有效 mtype 字符串 - 输出转换为指定的 mtype
- 返回:
- selfreference to self.
注意事项
更改对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
该方法适用于简单的 skbase 对象以及组合对象。参数键字符串
<component>__<parameter>
可用于组合对象(即包含其他对象的对象),以访问组件<component>
中的<parameter>
。如果引用明确(例如,没有两个组件参数的名称为<parameter>
),也可以使用字符串<parameter>
,不带<component>__
。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。如果__
后缀在 get_params 键中唯一,则可以作为完整字符串的别名。
- 返回:
- selfreference to self (after parameters have been set)
- 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
是否在值为 skbase 对象的参数(即组件估计器)中设置随机状态。
如果为 False,将仅设置
self
的random_state
参数(如果存在)。如果为 True,还将设置组件对象中的
random_state
参数。
- self_policystr, one of {“copy”, “keep”, “new”}, default=”copy”
“copy” :
self.random_state
设置为输入的random_state
“keep” :
self.random_state
保持不变“new” :
self.random_state
设置为一个新的随机状态,
从输入的
random_state
派生,通常与输入不同
- 返回:
- selfreference to 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
- 参数:
- Xsktime 兼容数据容器格式的时间序列
要进行变换的数据。
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 的类型和 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。
- 所需状态
要求状态为“已拟合”。
在 self 中访问
以 “_” 结尾的已拟合模型属性。
self.is_fitted
,必须为 True
写入自身
以 “_” 结尾的已拟合模型属性。
如果
remember_data
标签为 True,则通过update_data
将X
中的值写入并更新到self._X
。
- 参数:
- Xsktime 兼容数据容器格式的时间序列
用于更新变换的数据
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估计器的已拟合实例