ReducerTransform#
- class ReducerTransform(lags=0, freq=None, shifted_vars=None, shifted_vars_lag=0, shifted_vars_freq=None, transformers=None, impute_method='bfill')[source]#
用于预测降维的转换器。通过滞后和转换准备表格形式的 X/y。
- 参数:
- window_lengthint, 可选, 默认值=0
降维算法中使用的窗口长度
- lags滞后偏移量,或滞后偏移量的列表,可选,默认值=0(恒等转换)
“滞后偏移量”可以是以下之一: int - 要移动/滞后的周期数 类似时间:
DateOffset
、tseries.offsets
或timedelta
要移动/滞后的时间差偏移量要求转换后的数据的时间索引是类似时间的(而非 int)
str - 来自 pandas.tseries 模块的时间规则,例如,“EOM”
- freq频率描述符或频率描述符列表,可选,默认值=None
如果传递,必须是标量,或者与
lags
参数长度相等的列表freq
中的元素对应于lags
中的元素 如果freq
的第 i 个元素不是 None,则lags
的第 i 个元素必须是 int下面将此称为“相应的 lags 元素”
“频率描述符”可以是以下之一: 类似时间:
DateOffset
、tseries.offsets
或timedelta
移动时乘以相应的
lags
元素str - 来自 pd.tseries 模块的偏移量,例如,“D”、“M”,或时间规则,例如,“EOM”
- shifted_varsNone
- shifted_vars_lag0
- shifted_vars_freq
- transformerssktime 时间序列到时间序列转换器,或其列表
应用于
y
的附加转换。这些被添加到 lags 中,作为输出中的单独列,不应用于滞后数据。- impute_methodstr, None, 或 sktime 转换,可选
用于处理滞后数据中缺失值的插补方法
默认值=”bfill”
如果是 str,可接受的字符串是
Imputer.method
参数的值,请参阅那里。要传递更多参数,请直接传递Imputer
转换器,如下所述。如果是 sktime 转换器,则此转换器应用于滞后数据。这需要是一个移除缺失数据的转换器,并且可以是
Imputer
。如果是 None,则在应用
Lag
转换器时不进行插补
- 属性:
is_fitted
是否已调用
fit
。
示例
>>> from sktime.datasets import load_airline >>> from sktime.transformations.series.lag import Lag >>> X = load_airline()
单个滞后将产生一个具有相同变量的时间序列
>>> t = Lag(2) >>> Xt = t.fit_transform(X)
可以提供多个滞后,这将导致多列输出
>>> t = Lag([2, 4, -1]) >>> Xt = t.fit_transform(X)
index_out 的默认设置将在两侧扩展索引。为确保转换后索引保持不变,请使用 index_out=”original”
>>> t = Lag([2, 4, -1], index_out="original") >>> Xt = t.fit_transform(X)
滞后转换器可能会(并且通常会)创建 NA。(除非 index_out=”shift” 并且只有一个滞后,或在简单情况下)这可能需要处理,例如,如果后续的管道步骤不接受 NA。要处理 NA,请使用 Imputer 组合到管道中。
>>> from sktime.datasets import load_airline >>> from sktime.transformations.series.impute import Imputer >>> from sktime.transformations.series.lag import Lag >>> X = load_airline() >>> >>> t = Lag([2, 4, -1]) * Imputer("nearest") >>> Xt = t.fit_transform(X)
方法
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
。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__
故障导致克隆不符合要求,则运行时错误。
- 如果由于
- clone_tags(estimator, tag_names=None)[source]#
从另一个对象克隆标签作为动态覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。应仅在对象的
__init__
方法中、构造期间或通过__init__
直接调用后调用clone_tags
方法。动态标签被设置为
estimator
中标签的值,名称在tag_names
中指定。tag_names
的默认设置会将estimator
中的所有标签写入self
。可以通过
get_tags
或get_tag
检查当前标签值。estimator:class:BaseObject 或派生类的实例
- parameter_setstr,默认值=”default”
使用第一个测试参数集构建类的一个实例。
- objscls 实例列表
创建所有测试实例的列表及其名称列表。
- 状态变化
将转换器拟合到 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”科学类型 = 单个时间序列。
pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)“Panel”科学类型 = 时间序列集合。
pd.DataFrame
具有 2 级行MultiIndex
(instance, time
),3D np.ndarray
(instance, variable, time
), Series 类型的pd.DataFrame
list
“Hierarchical”科学类型 = 时间序列分层集合。
pd.DataFrame
具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time
)有关数据格式的更多详细信息,请参阅mtype词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
y可选,sktime 兼容数据格式的数据,默认值=None
- 附加数据,例如转换的标签 如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,非可选。所需格式,请参阅类文档字符串了解详细信息。 self估计器的拟合实例
- self
- 将转换器拟合到 X 和 y,并返回 X 的转换版本。
拟合到数据,然后对其进行转换。
写入自身: _is_fitted:标志设置为 True。 _X:X,X 的强制副本,如果 remember_data 标签为 True
- 将状态更改为“fitted”。
写入自身
如果可能,通过引用强制转换为内部类型或 update_data 兼容类型
模型属性(以“_”结尾):取决于估计器
用于拟合转换的数据以及要转换的数据。
- 参数:
- 用于拟合转换的数据。
X 的转换版本
“Series”科学类型 = 单个时间序列。
pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)“Panel”科学类型 = 时间序列集合。
pd.DataFrame
具有 2 级行MultiIndex
(instance, time
),3D np.ndarray
(instance, variable, time
), Series 类型的pd.DataFrame
list
“Hierarchical”科学类型 = 时间序列分层集合。
pd.DataFrame
具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time
)有关数据格式的更多详细信息,请参阅mtype词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
y可选,sktime 兼容数据格式的数据,默认值=None
- 附加数据,例如转换的标签 如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,非可选。所需格式,请参阅类文档字符串了解详细信息。 self估计器的拟合实例
- self
- 类型取决于 X 的类型和科学类型: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 实例)。示例: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
- 所需状态
获取已拟合的参数。
- 需要状态为“fitted”。
deepbool, 默认值=True
- 参数:
- 是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名 : 值字典,包括可拟合组件 (= BaseEstimator 值参数) 的拟合参数。
如果为 False,将返回此对象的参数名 : 值字典,但不包括组件的拟合参数。
fitted_params键为 str 类型的字典
- self
- 拟合参数字典,键值对包括 paramname : paramvalue
总是包含:此对象的所有拟合参数,如通过 get_param_names 获取的值为此对象该键的拟合参数值
- 获取对象的默认参数。
default_dict: dict[str, Any]
- 获取对象的参数名称。
sortbool, 默认值=True
- 是否返回组件的参数。
获取此对象的参数值字典。
- 参数:
- 是否返回组件的拟合参数。
如果为
True
,将返回此对象的参数名称 : 值 的dict
,包括组件(=BaseObject
值参数)的参数。如果为
False
,将返回此对象的参数名称 : 值 的dict
,但不包括组件的参数。params键为 str 类型的字典
- self
- 参数字典,键值对包括 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
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。
访问自身属性
- 需要状态为“fitted”。
deepbool, 默认值=True
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True附加数据,例如转换的标签。某些转换器需要此项,详细信息请参阅类文档字符串。
- 参数:
- 用于拟合转换的数据。
sktime 中的单个数据格式是所谓的mtype规范,每个 mtype 都实现了一个抽象的科学类型 (scitype)。
“Series”科学类型 = 单个时间序列。
pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)“Panel”科学类型 = 时间序列集合。
pd.DataFrame
具有 2 级行MultiIndex
(instance, time
),3D np.ndarray
(instance, variable, time
), Series 类型的pd.DataFrame
list
“Hierarchical”科学类型 = 时间序列分层集合。
pd.DataFrame
具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time
)有关数据格式的更多详细信息,请参阅mtype词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
y可选,sktime 兼容数据格式的数据,默认值=None
- 附加数据,例如转换的标签 如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,非可选。所需格式,请参阅类文档字符串了解详细信息。 X 的逆转换版本
- self
- 复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
检查对象是否由其他 BaseObjects 组成。
composite: bool
-
检查对象的
_is_fitted` 属性,该属性在对象构造期间应初始化为 ``False
,并在调用对象的 fit 方法时设置为 True。 是否已调用
fit
。bool
- serialZipFile(path).open(“object) 的结果
从文件位置加载对象。
-
serial
cls.save(None)
输出的第一个元素 从序列化内存容器加载对象。
-
将
self
设置为构造函数调用后直接的状态,具有相同的超参数。通过set_config
设置的配置值也会保留。 将对象重置为构造函数调用后的干净状态。
reset
调用会删除所有对象属性,除了超参数 = 写入自身
__init__
的参数,例如self.paramname
,其中paramname
是__init__
的一个参数包含双下划线的对象属性,即字符串 "__"。例如,名为 "__myattr" 的属性会被保留。
配置属性,配置会保持不变。也就是说,
get_config
在reset
前后的结果是相同的。类和对象方法以及类属性也不受影响。
相当于
clone
,不同之处在于reset
修改自身而不是返回一个新对象。类似于
clone
,区别在于reset
修改self
本身而不是返回一个新的对象。在调用
self.reset()
后,self
的值和状态将与构造函数调用``type(self)(**self.get_params(deep=False))`` 后获得的对象相等。- self
- 指向
self
的引用。 类实例被重置到干净的初始化后状态,但保留当前的超参数值。
- 指向
- save(path=None, serialization_format='pickle')[source]#
将序列化后的自身保存到字节类对象或 (.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/
中。- serialization_format: str,默认 = “pickle”
用于序列化的模块。可用选项有 “pickle” 和 “cloudpickle”。请注意,非默认格式可能需要安装其他软依赖。
- self
- 如果
path
为 None - 内存中的序列化 self - 如果
path
是文件位置 - 引用该文件的 ZipFile
- 如果
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- 配置名称 : 配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后从 _onfig_dynamic 对象属性收集任何覆盖和新标签。
配置名称 : 配置值对的字典。有效的配置、值及其含义如下所示
- displaystr,“diagram”(默认),或“text”
jupyter 内核如何显示 self 的实例
“diagram” = HTML 盒图表示
“text” = 字符串打印输出
- print_changed_onlybool,默认=True
打印 self 时是否只列出与默认值不同的 self 参数 (True 时),或列出所有参数名称和值 (False 时)。不进行嵌套,即只影响 self,不影响组件估计器。
- 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
- self对自身的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
此方法适用于简单的 skbase 对象以及复合对象。参数键字符串
<component>__<parameter>
可用于复合对象,即包含其他对象的对象,以访问组件<component>
中的<parameter>
。如果引用明确无歧义(例如,没有任何两个组件的参数名称相同),也可以使用不带<component>__
的字符串<parameter>
。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。如果__
后缀在 get_params 键中唯一,则可以作为完整字符串的别名。
- self
- 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
伪随机数生成器,用于控制随机整数的生成。传递整数以实现多次函数调用之间的可复现输出。
- 是否返回组件的拟合参数。
是否在 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)[source]#
将实例级别标签覆盖设置为给定值。
get_class_tag
方法是一个类方法,仅考虑类级别标签值和覆盖来检索标签的值。标签是特定于实例
self
的键值对,它们是对象构造后不改变的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法只能在对象的__init__
方法中,即在构造期间,或通过__init__
直接构造后调用。estimator:class:BaseObject 或派生类的实例
- 参数:
- **tag_dictdict
标签名称 : 标签值对的字典。
- self
- Self
对自身的引用。
- transform(X, y=None)[source]#
转换 X 并返回转换后的版本。
- 需要状态为“fitted”。
deepbool, 默认值=True
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True附加数据,例如转换的标签。某些转换器需要此项,详细信息请参阅类文档字符串。
- 参数:
- 用于拟合转换的数据。
要转换的数据。
“Series”科学类型 = 单个时间序列。
pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)“Panel”科学类型 = 时间序列集合。
pd.DataFrame
具有 2 级行MultiIndex
(instance, time
),3D np.ndarray
(instance, variable, time
), Series 类型的pd.DataFrame
list
“Hierarchical”科学类型 = 时间序列分层集合。
pd.DataFrame
具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time
)有关数据格式的更多详细信息,请参阅mtype词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
y可选,sktime 兼容数据格式的数据,默认值=None
- 附加数据,例如转换的标签 如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,非可选。所需格式,请参阅类文档字符串了解详细信息。 X 的逆转换版本
- self
- 类型取决于 X 的类型和科学类型:transform-output 标签
- X | tf-output | 返回类型 |
transform
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
,则返回的 Panel 实例数与X
相同(转换器应用于每个输入的 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。
- 需要状态为“fitted”。
deepbool, 默认值=True
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True附加数据,例如转换的标签。某些转换器需要此项,详细信息请参阅类文档字符串。
设置以“_”结尾的拟合模型属性,拟合属性可通过
get_fitted_params
检查。self.is_fitted
,必须为 True如果
remember_data
标签为 True,则通过update_data
将self._X
更新为X
中的值。
- 参数:
- 用于拟合转换的数据。
用于更新转换的数据
“Series”科学类型 = 单个时间序列。
pd.DataFrame
、pd.Series
或np.ndarray
(1D 或 2D)“Panel”科学类型 = 时间序列集合。
pd.DataFrame
具有 2 级行MultiIndex
(instance, time
),3D np.ndarray
(instance, variable, time
), Series 类型的pd.DataFrame
list
“Hierarchical”科学类型 = 时间序列分层集合。
pd.DataFrame
具有 3 级或更多级行MultiIndex
(hierarchy_1, ..., hierarchy_n, time
)有关数据格式的更多详细信息,请参阅mtype词汇表。有关用法,请参阅转换器教程
examples/03_transformers.ipynb
y可选,sktime 兼容数据格式的数据,默认值=None
- 附加数据,例如转换的标签 如果
self.get_tag("requires_y")
为True
,则必须在fit
中传递,非可选。所需格式,请参阅类文档字符串了解详细信息。 X 的逆转换版本
- self
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- 要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回 “default” 集。
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,将返回
"default"
集。目前没有为 transformer 保留的值。
- self
- paramsdict 或 dict 列表,默认 = {}
用于创建类测试实例的参数。每个 dict 都是构造一个“有趣的”测试实例的参数,即
MyClass(**params)
或MyClass(**params[i])
创建一个有效的测试实例。create_test_instance
使用params
中的第一个(或唯一一个)字典。