FCNRegressor#
- class FCNRegressor(n_epochs=2000, batch_size=16, callbacks=None, verbose=False, loss='mean_squared_error', metrics=None, random_state=None, activation='sigmoid', use_bias=True, optimizer=None)[source]#
全连接神经网络 (FCN),如 [1] 中所述。
改编自 Fawaz 等人的实现 hfawaz/dl-4-tsc
- 参数:
- 此处是否应列出继承的字段?
- n_epochsint,默认值 = 2000
模型训练的 epoch 数量
- batch_sizeint,默认值 = 16
每次梯度更新的样本数量。
- random_stateint 或 None,默认值=None
随机数生成的种子。
- verboseboolean,默认值 = False
是否输出额外信息
- lossstring,默认值=”mean_squared_error”
keras 模型的 fit 参数
- metricslist of strings,默认值=[“accuracy”],
- activationstring 或 tf 可调用对象,默认值=”sigmoid”
输出线性层中使用的激活函数。可用激活函数列表:https://keras.org.cn/api/layers/activations/
- use_biasboolean,默认值 = True
该层是否使用偏置向量。
- optimizerkeras.optimizers 对象,默认值 = Adam(lr=0.01)
指定要使用的优化器和学习率。
- 属性:
is_fitted
是否已调用
fit
方法。
参考文献
[1]Zhao 等人,时间序列分类的卷积神经网络,
系统工程与电子学报,28(1):2017。
方法
build_model
(input_shape, **kwargs)构建一个已编译、未经训练但可用于训练的 keras 模型。
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)使用训练数据拟合时间序列回归器。
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])返回估计器的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化的内存容器加载对象。
predict
(X)预测 X 中序列的标签。
reset
()将对象重置为干净的初始化后状态。
save
([path])将序列化的自身保存到字节类对象或 (.zip) 文件中。
score
(X, y[, multioutput])根据 X 上的真实标签对预测标签进行评分。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为自身设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级别的标签覆盖设置为给定值。
- build_model(input_shape, **kwargs)[source]#
构建一个已编译、未经训练但可用于训练的 keras 模型。
在 sktime 中,时间序列存储在形状为 (d,m) 的 numpy 数组中,其中 d 是维度数,m 是序列长度。Keras/tensorflow 假定数据形状为 (m,d)。此方法也假定为 (m,d)。转置应在 fit 方法中进行。
- 参数:
- input_shapetuple
输入层的数据形状,应为 (m,d)
- 返回:
- output一个已编译的 Keras 模型
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr,默认值=”default”
要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回
"default"
集。对于分类器,应提供一组“默认”参数用于通用测试,如果通用集无法产生适合比较的概率,则提供一组“结果比较”参数用于与先前记录的结果进行比较。
- 返回:
- paramsdict 或 list of 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
设置动态标签覆盖。The
clone_tags
method should be called only in the__init__
method of an object, during construction, or directly after construction via__init__
.The dynamic tags are set to the values of the tags in
estimator
, with the names specified intag_names
.The default of
tag_names
writes all tags fromestimator
toself
.Current tag values can be inspected by
get_tags
orget_tag
.estimator:class:BaseObject 或派生类的一个实例
- 要返回的测试参数集的名称,用于测试。如果某个值没有定义特殊参数,将返回 “default” 集。
使用第一个测试参数集构造类的一个实例。
- objscls 实例列表
创建所有测试实例的列表及其名称列表。
- 状态变化
使用训练数据拟合时间序列回归器。
- 将状态更改为“已拟合”。
写入 self
- 将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel
- 参数:
- 用于拟合估计器的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为 variables,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array (任意维度数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtypemtype 列表请参阅
datatypes.SCITYPE_REGISTER
详细规范请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板数据,详细信息请参阅标签参考。
ysktime 兼容的表格数据容器,scitype 为 Table
- 1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类标签,第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引,支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
self对自身的引用。
- 返回:
- 注意
通过创建一个已拟合模型来改变状态,该模型更新以“_”结尾的属性并将 is_fitted 标志设置为 True。
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
方法是一个类方法,它返回一个标签字典,其键是类或其任何父类中设置的任何_tags
属性的键。 从类中获取类标签,并继承父类的标签级别。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。值是相应的标签值,按以下降序优先级进行覆盖
实例可以根据超参数覆盖这些标签。
要检索可能带有实例覆盖的标签,请改用
get_tags
方法。在父类的
_tags
属性中设置的标签,按继承顺序。
不考虑实例上通过
set_tags
或clone_tags
设置的动态标签覆盖。要包含动态标签的覆盖,请使用
get_tags
。collected_tagsdict
要检索可能带有实例覆盖的标签值,请改用
get_tag
方法。标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性中收集。不受通过set_tags
或clone_tags
设置的动态标签覆盖。
-
get_config
返回动态配置,它们会覆盖默认配置。 获取自身的配置标志。
默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。Configs 在
clone
或reset
调用下保留。config_dictdict
配置名称:配置值对的字典。通过嵌套继承从 _config 类属性中收集,然后通过 _onfig_dynamic 对象属性收集任何覆盖和新标签。
- 需要状态为“已拟合”。
获取已拟合的参数。
- deepbool,默认值=True
是否返回组件的已拟合参数。
- 参数:
- 如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
如果为 False,将返回此对象的参数名称:值字典,但不包括组件的已拟合参数。
fitted_paramsdict,键为 str 类型
已拟合参数字典,键值对 paramname : paramvalue 包括
- 返回:
- default_dict: dict[str, Any]
键是
cls
中在__init__
中定义了默认值的所有参数。值是默认值,如在__init__
中定义的那样。
- sortbool,默认值=True
打印 self 时是仅列出自默认值不同的参数 (False),还是列出所有参数名称和值 (False)。不进行嵌套,即仅影响 self 而不影响组件估计器。
-
如果为
True
,将返回此对象的参数名称:值dict
,包括组件(=BaseObject
值参数)的参数。 获取此对象的参数值字典。
- 参数:
- 如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
如果为
False
,将返回此对象的参数名称:值dict
,但不包括组件的参数。paramsdict,键为 str 类型
参数字典,键值对 paramname : paramvalue 包括
- 返回:
-
通过实例上的
set_tags
或clone_tags
设置的标签, 从实例中获取标签值,带有标签级别的继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。在实例构造时。
要检索的标签名称
tag_value_default任意类型,可选;默认值=None
在父类的
_tags
属性中设置的标签,按继承顺序。
不考虑实例上通过
set_tags
或clone_tags
设置的动态标签覆盖。- 参数:
- 标签值的名称。
如果未找到标签,使用的默认/回退值
- raise_errorbool
未找到标签时是否引发
ValueError
- tag_valueAny
self
中tag_name
标签的值。如果未找到,且raise_error
为 True,则引发错误,否则返回tag_value_default
。
- 返回:
- ValueError,如果
raise_error
为True
。 如果
tag_name
不在self.get_tags().keys()
中,则引发ValueError
。
- ValueError,如果
- 引发:
- collected_tagsdict
从实例中获取标签,带有标签级别的继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储关于对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。标签名称:标签值对的字典。通过嵌套继承从
_tags
类属性中收集,然后通过_tags_dynamic
对象属性收集任何覆盖和新标签。要检索可能带有实例覆盖的标签,请改用
get_tags
方法。要检索的标签名称
tag_value_default任意类型,可选;默认值=None
在父类的
_tags
属性中设置的标签,按继承顺序。
不考虑实例上通过
set_tags
或clone_tags
设置的动态标签覆盖。
- composite: bool
检查对象是否由其他 BaseObject 组成。
对象是否具有任何参数,其值是
BaseObject
的派生实例。
-
反序列化的 self,结果输出到
path
,即cls.save(path)
的输出 从文件位置加载对象。
-
这是一个大小为 3 的元组。第一个元素表示 pickle 序列化的实例。第二个元素表示 h5py 序列化的
keras
模型。第三个元素表示 pickle 序列化的.fit()
的历史记录。 从序列化的内存容器加载对象。
- y_predsktime 兼容的表格数据容器,scitype 为 Table scitype
预测 X 中序列的标签。
- 参数:
- 用于拟合估计器的时间序列。
预测的回归标签
pd-multiindex: pd.DataFrame,列为 variables,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array (任意维度数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtypemtype 列表请参阅
datatypes.SCITYPE_REGISTER
详细规范请参阅
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持多变量或不等长序列的面板数据,详细信息请参阅标签参考。
ysktime 兼容的表格数据容器,scitype 为 Table
- 返回:
-
reset
调用会删除除以下属性外的所有对象属性 将对象重置为干净的初始化后状态。
超参数 = 写入
self
的__init__
参数,例如self.paramname
,其中paramname
是__init__
的参数包含双下划线(即字符串“__”)的对象属性。例如,名为“__myattr”的属性会被保留。
config 属性,配置不变。即,
reset
前后get_config
的结果相同。类和对象方法以及类属性也不受影响。
等同于
clone
,区别在于reset
修改self
,而不是返回一个新对象。
在
self.reset()
调用后,self
在值和状态上等同于构造函数调用``type(self)(**self.get_params(deep=False))`` 后获得的对象。类实例重置为干净的初始化后状态,但保留当前的超参数值。
- 返回:
self
的引用。行为:如果
path
为 None,返回一个内存中的序列化 self;如果path
是文件路径,则将该名称的 zip 文件存储在该位置。zip 文件内容包括:_metadata - 包含 self 的类,即 type(self)。_obj - 序列化的 self。此类使用默认序列化 (pickle)。keras/ - 模型、优化器和状态存储在此目录下。history - 序列化的 history 对象。
- pathNone 或文件位置 (str 或 Path)
将序列化的自身保存到字节类对象或 (.zip) 文件中。
如果为 None,则 self 保存到内存对象中;如果是文件位置,则 self 保存到该文件位置。例如
- pd-multiindex: pd.DataFrame,列为 variables,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引 numpy3D: 3D np.array (任意维度数,等长序列),形状为 [n_instances, n_dimensions, series_length] 或任何其他支持的 Panel mtype mtype 列表请参阅 datatypes.SCITYPE_REGISTER 详细规范请参阅 examples/AA_datatypes_and_datasets.ipynb
根据 X 上的真实标签对预测标签进行评分。
- 参数:
- y2D np.array,类型为 int,形状为 [n_instances, n_dimensions] - 回归标签
用于拟合的索引对应于 X 中的实例索引 或 1D np.array,类型为 int,形状为 [n_instances] - 用于拟合的回归标签,索引对应于 X 中的实例索引
- multioutputstr,可选 (默认值=”uniform_average”)
{“raw_values”, “uniform_average”, “variance_weighted”},形状为 (n_outputs,) 的类数组对象或 None,默认值=”uniform_average”。定义多输出分数的聚合方式。类数组值定义用于平均分数的权重。
- float (默认值) 或 1D np.array,类型为 float
predict(X) 与 y 的 R-squared 分数 如果 multioutput=”uniform_average” 或 “variance_weighted”,或 y 是单变量,则为 float;如果 multioutput=”raw_values” 且 y 是多变量,则为 1D np.array
- 返回:
- displaystr,“diagram”(默认值),或“text”
将配置标志设置为给定值。
- 参数:
- get_fitted_params(deep=True)[source]#
jupyter 内核如何显示 self 的实例
- “diagram” = html 框图表示
“text” = 字符串输出
print_changed_onlybool,默认值=True
打印 self 时是仅列出自默认值不同的参数 (False),还是列出所有参数名称和值 (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
的默认值。“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”:布尔值,默认为 True;False 会阻止
ray
在并行化后 关闭。
- “shutdown_ray”:布尔值,默认为 True;False 会阻止
“logger_name”:字符串,默认为“ray”;要使用的日志记录器名称。
“mute_warnings”:布尔值,默认为 False;如果为 True,则抑制警告
- 返回:
- **self**指向自身的引用。
通过创建一个已拟合模型来改变状态,该模型更新以“_”结尾的属性并将 is_fitted 标志设置为 True。
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- set_params(**params)[source]#
设置此对象的参数。
该方法适用于简单的 skbase 对象以及组合对象。参数键字符串
<component>__<parameter>
可用于组合对象,即包含其他对象的对象,以访问组件<component>
中的<parameter>
。如果引用是明确的,例如没有两个组件参数使用名称<parameter>
,则也可以使用不带<component>__
的字符串<parameter>
。- 参数:
- **params**字典
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
导出的整数。这些整数通过链式哈希(chain hashing)从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_state**int, RandomState 实例或 None,默认为 None
伪随机数生成器,用于控制随机整数的生成。传入 int 可在多次函数调用中获得可重现的输出。
- 如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
是否设置 skbase 对象值参数(即组件估计器)中的随机状态。
如果为 False,则仅设置
self
的random_state
参数(如果存在)。如果为 True,则也会设置组件对象中的
random_state
参数。
- **self_policy**字符串,为 {“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_dict**字典
标签名称:标签值对的字典。
- 返回:
- Self
指向自身的引用。