特征选择#
- class FeatureSelection(method='feature-importances', n_columns=None, regressor=None, random_state=None, columns=None)[source]#
选择外生特征。
用于对外生数据进行可调特征选择的转换器。FeatureSelection 实现了多种选择特征(列)的方法。如果 X 是 pd.Series,则直接通过,除非 method=”none”,此时 transform() 返回 None。
- 参数:
- method字符串, 必需
选择特征的方法。已实现的方法有
“feature-importances”:使用回归器(元模型)的 feature_importances_ 来选择 n_columns 个重要性值最高的特征。需要参数 n_columns。
“random”:随机选择 n_columns 个特征。需要参数 n_columns。
“columns”:按给定的名称选择特征。
“none”:移除所有列,transform 返回 None。
“all”:选择所有给定特征。
- regressor类似 sklearn 的回归器,可选,默认为 None。
用作方法“feature-importances”的元模型。给定的回归器必须有一个属性“feature_importances_”。如果为 None,则使用 GradientBoostingRegressor(max_depth=5)。
- n_columns整型,可选
要选择的特征(列)数量。n_columns 必须 <= X 的列数。有些方法需要给定 n_columns。
- random_state整型,RandomState 实例或 None,默认为 None
用于设置默认回归器的 random_state,如果 method=”random”,则设置 random.seed()。
- columns字符串列表
要选择的列列表。如果指定了 columns。
- 属性:
- columns_字符串列表
已选择作为特征的列列表。
- regressor_类似 sklearn 的回归器
已拟合的回归器(元模型)。
- n_columns_: 整型
如果 n_columns 为 None,则从特征数量派生而来,n_columns_ 将计算为 int(math.ceil(Z.shape[1] / 2))。因此,默认情况下只取给定特征的一半。
- feature_importances_字典或 None
一个字典,键为列名,值为特征重要性值。字典按值降序排序。如果 method=”feature-importances”,此属性为字典,否则为 None。
示例
>>> from sktime.transformations.series.feature_selection import FeatureSelection >>> from sktime.datasets import load_longley >>> y, X = load_longley() >>> transformer = FeatureSelection(method="feature-importances", n_columns=3) >>> Xt = transformer.fit_transform(X, y)
方法
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])从类获取类标签值,带有来自父类的标签级别继承。
从类获取类标签,带有来自父类的标签级别继承。
获取 self 的配置标志。
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 并返回逆向转换后的版本。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
reset
()将对象重置为干净的初始化后状态。
save
([path, serialization_format])将序列化的 self 保存到字节类对象或 (.zip) 文件。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])设置 self 的 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_set字符串,默认值="default"
要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,则返回
"default"
集。
- 返回:
- params字典或字典列表,默认值 = {}
用于创建类测试实例的参数。每个字典都是用于构造一个“有趣的”测试实例的参数,即
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_name字符串,可选
调用此方法的名称。如果提供,错误消息将包含此信息。
- 引发:
- 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
设置动态标签覆盖。应仅在对象的
__init__
方法中调用clone_tags
方法,即在构造期间,或在通过__init__
构造后直接调用。动态标签设置为
estimator
中指定tag_names
的标签的值。tag_names
的默认设置是将estimator
中的所有标签写入self
。当前标签值可以通过
get_tags
或get_tag
查看。estimator:class:BaseObject 或派生类的实例
- 要返回的测试参数集的名称,用于测试。如果没有为某个值定义特殊参数,则返回“default”集。
构造类的实例,使用第一个测试参数集。
- objscls 实例列表
创建所有测试实例的列表及其名称列表。
- 状态改变
将转换器拟合到 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
(instance, time
)的pd.DataFrame
,3Dnp.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 的转换后版本。
拟合到数据,然后对其进行转换。
写入 self:_is_fitted:标志设为 True。_X:X,X 的强制副本,如果 remember_data 标签为 True
- 将状态改为“fitted”。
写入 self
如果可能,强制转换为内部类型或 update_data 兼容类型(按引用)
模型属性(以“_”结尾):取决于估计器
用于拟合转换的数据,以及要转换的数据。
- 参数:
- 用于拟合转换的数据。
X 的转换后版本
Series
scitype = 个体时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D或2D)Panel
scitype = 时间序列集合。具有2级行MultiIndex
(instance, time
)的pd.DataFrame
,3Dnp.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 实例)。示例:面板中的所有时间序列都被单独去趋势
如果
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_name字符串
-
get_class_tags
方法是一个类方法,它只考虑类级别的标签值和覆盖来检索标签的值。 从类获取类标签,带有来自父类的标签级别继承。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。它返回一个字典,其中键是在类或其任何父类中设置的任何
_tags
属性的键。值是相应的标签值,按以下降序优先级进行覆盖:
实例可以根据超参数覆盖这些标签。
在父类的
_tags
属性中设置的标签,按继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。要检索可能包含实例覆盖的标签,请使用
get_tags
方法代替。要包含来自动态标签的覆盖,请使用
get_tags
。要检索可能包含实例覆盖的标签值,请使用
get_tag
方法代替。collected_tags字典
-
Configs 是
self
的键值对,通常用作控制行为的瞬态标志。 获取 self 的配置标志。
get_config
返回动态配置,它覆盖默认配置。默认配置在类或其父类的
_config
类属性中设置,并通过set_config
设置的动态配置进行覆盖。Configs 在
clone
或reset
调用下保留。config_dict字典
- 所需状态
获取已拟合参数。
- 要求状态为“fitted”。
deep布尔型,默认为 True
- 参数:
- 是否返回组件的拟合参数。
如果为 True,则返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值参数)的拟合参数。
如果为 False,则返回此对象的参数名称:值字典,但不包括组件的拟合参数。
fitted_params键为字符串的字典
- 返回:
- 获取对象的默认参数。
default_dict: 字典[字符串, 任意类型]
- 获取对象的参数名称。
sort布尔型,默认为 True
- 是否返回组件的参数。
获取此对象的参数值字典。
- 参数:
- 是否返回组件的拟合参数。
如果
True
,将返回此对象的参数名称:值dict
,包括组件(=BaseObject
值参数)的参数。如果
False
,将返回此对象的参数名称:值dict
,但不包括组件的参数。params键为字符串的字典
- 返回:
- 参数字典,包含参数名:参数值键值对
始终包含:此对象的所有参数,如
get_param_names
所示,值是此对象该键的参数值,值始终与构造时传递的值相同
-
get_tag
方法从实例中检索名称为tag_name
的单个标签的值,考虑标签覆盖,按以下降序优先级: 从实例获取标签值,带有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。通过
set_tags
或clone_tags
在实例上设置的标签,即在实例构造时设置的标签。
要检索的标签名称
在父类的
_tags
属性中设置的标签,按继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。
-
get_tags
方法返回一个标签字典,其中键是在类或其任何父类中设置的任何_tags
属性的键,或通过set_tags
或clone_tags
设置的标签。 从实例获取标签,带有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。collected_tags字典
实例可以根据超参数覆盖这些标签。
即在实例构造时设置的标签。
要检索的标签名称
在父类的
_tags
属性中设置的标签,按继承顺序。
不考虑通过
set_tags
或clone_tags
在实例上设置的动态标签覆盖。
- 目前假定只有带有标签
逆向转换 X 并返回逆向转换后的版本。
- “scitype:transform-input”=”Series”,“scitype:transform-output”=”Series”,
的转换器具有 inverse_transform。
在 self 中的访问
- 要求状态为“fitted”。
deep布尔型,默认为 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
,3Dnp.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 的逆向转换后版本
- 返回:
- 复合对象是一个包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
检查对象是否由其他 BaseObject 组成。
composite: 布尔型
-
fit
是否已被调用。 检查对象的
_is_fitted` 属性,该属性应在对象构造期间初始化为 ``False
,并在调用对象的fit方法时设置为 True。布尔型
- serialZipFile(path).open(“object) 的结果
从文件位置加载对象。
- serialcls.save(None) 输出的第 1 个元素
从序列化内存容器加载对象。
- 参数:
- 反序列化的 self,其输出为
serial
,来自cls.save(None)
- 反序列化的 self,其输出为
- 返回:
- 反序列化 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]#
将序列化的 self 保存到字节类对象或 (.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” 则会生成一个 zip 文件
estimator.zip
并
存储在
/home/stored/
。- serialization_format: str, 默认值 = “pickle”
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
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>
。字符串<parameter>
,不带<component>__
,如果这使得引用明确无误,也可以使用,例如,没有两个组件参数具有名称<parameter>
。- 参数:
- **paramsdict
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,如果在 get_params 键中是唯一的。
- 返回:
- self对 self 的引用(参数设置后)
- set_random_state(random_state=None, deep=True, self_policy='copy')[source]#
设置 self 的 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_state整型,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对 self 的引用
- set_tags(**tag_dict)[source]#
将实例级别标签覆盖设置为给定值。
get_class_tag
方法是一个类方法,它只考虑类级别的标签值和覆盖来检索标签的值。标签是特定于实例
self
的键值对,它们是对象构造后不会更改的静态标志。它们可用于元数据检查,或用于控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要将标签设置到的值。应仅在对象的
__init__
方法中调用set_tags
方法,在构造期间,或通过__init__
直接在构造后调用。estimator:class:BaseObject 或派生类的实例
- 参数:
- **tag_dictdict
标签名称 : 标签值 对的字典。
- 返回:
- Self
对 self 的引用。
- transform(X, y=None)[source]#
转换 X 并返回转换后的版本。
- 要求状态为“fitted”。
deep布尔型,默认为 True
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True额外数据,例如用于转换的标签。有些转换器需要此项,请参见类文档字符串了解详情。
- 参数:
- 用于拟合转换的数据。
要转换的数据。
Series
scitype = 个体时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D或2D)Panel
scitype = 时间序列集合。具有2级行MultiIndex
(instance, time
)的pd.DataFrame
,3Dnp.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 实例)。示例:面板中的所有时间序列都被单独去趋势
如果
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”。
deep布尔型,默认为 True
以“_”结尾的拟合模型属性。
self.is_fitted
,必须为 True额外数据,例如用于转换的标签。有些转换器需要此项,请参见类文档字符串了解详情。
设置以“_”结尾的已拟合模型属性,已拟合属性可通过
get_fitted_params
查看。self.is_fitted
,必须为 True如果
remember_data
标签为 True,则写入self._X
,根据X
中的值进行更新,通过update_data
。
- 参数:
- 用于拟合转换的数据。
用于更新转换的数据
Series
scitype = 个体时间序列。pd.DataFrame
、pd.Series
或np.ndarray
(1D或2D)Panel
scitype = 时间序列集合。具有2级行MultiIndex
(instance, time
)的pd.DataFrame
,3Dnp.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 的逆向转换后版本
- 返回: