SeasonalDummiesOneHot#
- 类 SeasonalDummiesOneHot(sp: int | None = None, freq: str | None = None, drop: bool | None = True)[source]#
用于时间序列季节性的季节性哑变量特征。
捕捉季节性效应的标准方法是添加哑变量外生变量,每个季节一个。例如,对于月度季节性,添加二元哑变量 Jan, Feb, ...。对于时间“t”,如果“t”发生在该季节,则将这些变量设置为 1(反之则设置为 0)。为了避免共线性,当模型中包含截距时,会删除一个季节。
在机器学习的语言中,季节性哑变量的使用是对季节性分类变量进行独热编码。
目前支持以下频率: - 月度:‘M’ - 季度:‘Q’ - 每周:‘W’ - 每日:‘D’ - 每小时:‘H’
- 参数:
- spint, 可选, 默认值 = None
仅当传递给 _transform() 的 X(如果 X 为 None 则为 y)的索引是 DatetimeIndex 时使用。时间序列的季节性周期(例如,月度数据为 12)。即使在这种情况下,如果提供了 freq 也可以省略。(例如,如果 index.freq 可用,或 freq='M')
- freqstr, 可选, 默认值 = None
仅当传递给 _transform() 的 X(如果 X 为 None 则为 y)的索引是 DatetimeIndex 且未提供 sp 时使用。时间序列的频率(例如,月度数据为 'M')。即使在这种情况下,如果 index.freq 可用也可以省略。
- dropbool, 默认值 = True
删除第一个季节性哑变量?(如果模型包含截距,则应为 True)
- 属性:
is_fitted
是否已调用
fit
。
示例
>>> from sktime.transformations.series.dummies import SeasonalDummiesOneHot >>> from sktime.datasets import load_airline >>> y = load_airline() >>> transformer = SeasonalDummiesOneHot() >>> X = transformer.fit_transform(y=y, X=None)
方法
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)更新变换器。
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr, 默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则将返回
"default"
集。目前变换器没有保留值。
- 返回:
- paramsdict 或 dict 列表, 默认值 = {}
用于创建类测试实例的参数。每个 dict 都是构造一个“有趣”测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在调用对象的fit
方法时设置为True
。如果不是,则引发
NotFittedError
。- 参数:
- method_namestr, 可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- NotFittedError
如果估计器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是一个不同的对象,没有共享引用,处于初始化后状态。此函数等效于返回
self
的sklearn.clone
。等效于构造
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)[source]#
从另一个对象克隆标签作为动态覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。_
clone_tags
方法应仅在对象的__init__
方法中调用,即在构造期间或通过__init__
直接构造之后。动态标签被设置为
estimator
中标签的值,名称由tag_names
指定。tag_names
的默认设置将estimator
中的所有标签写入self
。当前标签值可以通过
get_tags
或get_tag
查看。estimator:class:BaseObject 或派生类的实例
- 要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,则将返回 “default” 集。
使用第一个测试参数集构造类的实例。
- objscls 的实例列表
创建所有测试实例的列表及其名称列表。
- 状态更改
将变换器拟合到 X,可选地拟合到 y。
- 将状态更改为“已拟合”。
写入自身
设置以“_”结尾的拟合模型属性,拟合属性可通过
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
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型的pd.DataFrame
的list
。Hierarchical
scitype = 分层时间序列集合。具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
。有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
y可选,sktime 兼容数据格式的数据,默认值=None
- 附加数据,例如用于变换的标签。某些变换器需要此数据,请参阅类文档字符串了解详细信息。如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,非可选。有关所需格式,请参阅类文档字符串了解详细信息。 self估计器的拟合实例
- 返回:
- 将变换器拟合到 X 和 y,并返回 X 的变换版本。
拟合数据,然后进行变换。
写入自身: _is_fitted :标志设置为 True。 _X :X,X 的强制副本,如果 remember_data 标签为 True
- 将状态更改为“已拟合”。
写入自身
如果可能,通过引用强制转换为内部类型或 update_data 兼容类型
模型属性(以“_”结尾):取决于估计器
用于拟合变换的数据,以及要变换的数据。
- 参数:
- 用于拟合变换的数据。
X 的变换版本
Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。具有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型的pd.DataFrame
的list
。Hierarchical
scitype = 分层时间序列集合。具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time)
的pd.DataFrame
。有关数据格式的更多详细信息,请参阅 mtype 词汇表。有关用法,请参阅变换器教程
examples/03_transformers.ipynb
y可选,sktime 兼容数据格式的数据,默认值=None
- 附加数据,例如用于变换的标签。某些变换器需要此数据,请参阅类文档字符串了解详细信息。如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,非可选。有关所需格式,请参阅类文档字符串了解详细信息。 self估计器的拟合实例
- 返回:
- 类型取决于 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 实例)。示例:对 Panel 中的所有时间序列进行单独去趋势
如果
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
-
_
get_class_tags
方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签的值。 从类中获取类标签,并从父类继承标签级别。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。它返回一个字典,其键是类或其任何父类中
_tags
的任何属性的键。值是对应的标签值,覆盖优先级从高到低如下:
实例可以根据超参数覆盖这些标签。
父类
_tags
属性中设置的标签,按照继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要检索可能包含实例覆盖的标签,请改用
get_tags
方法。要包含来自动态标签的覆盖,请使用
get_tags
。要检索可能包含实例覆盖的标签值,请改用
get_tag
方法。collected_tagsdict
-
配置是
self
的键值对,通常用作控制行为的瞬态标志。 获取自身的配置标志。
get_config
返回动态配置,它会覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并通过set_config
设置的动态配置进行覆盖。在
clone
或reset
调用下,配置会被保留。config_dictdict
- 所需状态
获取拟合参数。
- 要求状态为“已拟合”。
deepbool, 默认值=True
- 参数:
- 是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件的拟合参数(= BaseEstimator 类型参数)。
如果为 False,将返回此对象的参数名称:值字典,但不包括组件的拟合参数。
fitted_params键为 str 类型的 dict
- 返回:
- 拟合参数的字典,paramname : paramvalue 键值对包括
始终:此对象的所有拟合参数,如通过 get_param_names 获取的那样,值是此对象该键的拟合参数值
- 获取对象的默认参数。
default_dict: dict[str, Any]
- 获取对象的参数名称。
sortbool, 默认值=True
- 是否返回组件的参数。
获取此对象的参数值字典。
- 参数:
- 是否返回组件的拟合参数。
如果
True
,将返回此对象的参数名称:值dict
,包括组件的参数(=BaseObject
类型参数)。如果
False
,将返回此对象的参数名称:值dict
,但不包括组件的参数。params键为 str 类型的 dict
- 返回:
- 参数字典,paramname : paramvalue 键值对包括
始终:此对象的所有参数,如通过
get_param_names
获取的那样,值是此对象该键的参数值,这些值始终与构造时传递的值相同
-
_
get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,优先级从高到低如下: 从实例中获取标签值,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。通过
set_tags
或clone_tags
在实例上设置的标签,在实例构造时设置。
要检索的标签名称
父类
_tags
属性中设置的标签,按照继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。- 参数:
- 标签值的名称。
tag_value_default任意类型,可选;默认值=None
- 如果未找到标签,则使用的默认/回退值
raise_errorbool
- 当未找到标签时是否引发
ValueError
tag_valueAny
- 返回:
self
中tag_name
标签的值。如果未找到,并且raise_error
为 True,则引发错误,否则返回tag_value_default
。ValueError,如果
raise_error
为True
。
- 引发:
-
_
get_tags
方法返回一个标签字典,其键是类或其任何父类中_tags
的任何属性的键,或者通过set_tags
或clone_tags
设置的标签的键。 从实例中获取标签,具有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。collected_tagsdict
实例可以根据超参数覆盖这些标签。
在实例构造时设置。
要检索的标签名称
父类
_tags
属性中设置的标签,按照继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。
- 目前假定只有带有标签的变换器
对 X 进行逆变换并返回逆变换后的版本。
“scitype:transform-input”=”Series”,”scitype:transform-output”=”Series”,
具有 inverse_transform。
访问自身
- 要求状态为“已拟合”。
deepbool, 默认值=True
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True附加数据,例如用于变换的标签。某些变换器需要此数据,请参阅类文档字符串了解详细信息。
- 参数:
- 用于拟合变换的数据。
sktime 中的各种数据格式是所谓的mtype 规范,每种 mtype 都实现了一个抽象的scitype。
Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。具有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型的pd.DataFrame
的list
。Hierarchical
scitype = 分层时间序列集合。具有 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 的逆变换版本
- 返回:
- 复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
检查对象是否由其他 BaseObjects 组成。
composite: bool
-
检查对象在构造期间应初始化为
False
并在调用对象的 fit 方法时设置为 True 的_is_fitted` 属性。
是否已调用
fit
。bool
- serialZipFile(path).open(“object) 的结果
从文件位置加载对象。
-
serial
cls.save(None)
输出的第一个元素 从序列化内存容器加载对象。
-
结果是将
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))`` 后获得的对象相同。类实例重置为干净的初始化后状态,但保留当前超参数值。
-
行为:如果
path
为 None,则返回一个内存中的序列化自身;如果path
是文件位置,则将自身在该位置存储为 zip 文件 将序列化的自身保存到类字节对象或 (.zip) 文件。
保存的文件是 zip 文件,包含以下内容: _metadata - 包含自身的类,即 type(self) _obj - 序列化的自身。此类使用默认序列化(pickle)。
pathNone 或文件位置 (str 或 Path)
- 参数:
- 如果为 None,则将自身保存到内存对象;如果是文件位置,则将自身保存到该文件位置。如果
path=”estimator”,则将在当前工作目录创建
estimator.zip
zip 文件。path=”/home/stored/estimator”,则将在
/home/stored/
中存储estimator.zip
zip 文件。存储在
/home/stored/
中。
serialization_format: str, 默认值 = “pickle”
- 用于序列化的模块。可用选项是“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
如果
path
为 None - 内存中的序列化自身
- 返回:
- 如果
path
是文件位置 - 引用该文件的 ZipFile - 如果
path
是文件位置 - 引用该文件的 ZipFile 对象
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- 配置名称:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性获取任何覆盖和新标签。
配置名称与配置值配对的字典。有效的配置、值及其含义如下所示:
- displaystr, “diagram” (默认), 或 “text”
jupyter 内核如何显示实例自身
“diagram” = html 盒图表示
“text” = 字符串打印输出
- print_changed_onlybool, 默认=True
打印自身时是否只列出与默认值不同的参数 (False),还是列出所有参数名称和值 (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”; 要使用的日志记录器名称。
“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 值可在多次函数调用中获得可重现的输出。
- 是否返回组件的拟合参数。
是否在 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]#
将实例级别标签覆盖设置为给定值。
_
get_class_tag
方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签的值。标签是实例
self
特有的键值对,它们是构建对象后不会更改的静态标记。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法只能在对象的__init__
方法中(构造期间)或通过__init__
直接调用后调用。estimator:class:BaseObject 或派生类的实例
- 参数:
- **tag_dictdict
标签名称: 标签值 对的字典。
- 返回:
- 自身
自身引用。
- transform(X, y=None)[source]#
变换 X 并返回变换后的版本。
- 要求状态为“已拟合”。
deepbool, 默认值=True
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True附加数据,例如用于变换的标签。某些变换器需要此数据,请参阅类文档字符串了解详细信息。
- 参数:
- 用于拟合变换的数据。
要转换的数据。
Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。具有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型的pd.DataFrame
的list
。Hierarchical
scitype = 分层时间序列集合。具有 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 的类型和 scitype:transform-output 标签
- X | tf-output | 返回类型 |
转换
X
-输出
返回类型
Series
Primitives
pd.DataFrame (1行)
Panel
Primitives
pd.DataFrame
Series
Series
Series
Panel
Series
Panel
Series
Panel
Panel
- 表中未列出的组合目前不受支持
- 具体来说,带示例
- 如果
X
是Series
(例如pd.DataFrame
) 并且
transform-output
是Series
,则返回是相同 mtype 的单个 Series。示例:对单个时间序列进行去趋势
如果
X
是Panel
(例如pd-multiindex
)并且transform-output
是
Series
,则返回与X
实例数量相同的 Panel(变换器应用于每个输入的 Series 实例)。示例:对 Panel 中的所有时间序列进行单独去趋势
如果
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]#
- update(X, y=None, update_params=True)[source]#
使用 X(可选地使用 y)更新变换器。
- 要求状态为“已拟合”。
deepbool, 默认值=True
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True附加数据,例如用于变换的标签。某些变换器需要此数据,请参阅类文档字符串了解详细信息。
设置以“_”结尾的拟合模型属性,拟合属性可通过
get_fitted_params
查看。self.is_fitted
,必须为 True如果
remember_data
标签为 True,则通过update_data
将数据写入self._X
,用X
中的值更新。
- 参数:
- 用于拟合变换的数据。
用于更新转换的数据
Series
scitype = 单个时间序列。pd.DataFrame
,pd.Series
, 或np.ndarray
(1D 或 2D)Panel
scitype = 时间序列集合。具有 2 级行MultiIndex
(instance, time)
的pd.DataFrame
,3D np.ndarray
(instance, variable, time)
,或Series
类型的pd.DataFrame
的list
。Hierarchical
scitype = 分层时间序列集合。具有 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 的逆变换版本
- 返回: