MultiplexClassifier (多路复用分类器)#
- class MultiplexClassifier(classifiers: list, selected_classifier=None)[source]#
用于在不同模型之间进行选择的 MultiplexClassifier。
MultiplexClassifier 提供了一个框架,用于在不同的模型类别上执行模型选择过程。应与 GridSearchCV 结合使用以充分发挥其作用。它可用于单变量和多变量分类器、单输出和多输出分类器。
MultiplexClassifier 使用一个(命名)的分类器列表和一个
selected_classifier
超参数指定,该超参数是分类器名称之一。MultiplexClassifier 随后会精确地表现为名称为selected_classifier
的分类器,而忽略其他分类器的功能。与 GridSearchCV 结合使用时,MultiplexClassifier 提供了跨多个估计器进行调优的能力,即通过调优
selected_classifier
超参数来执行 AutoML。这种组合随后将通过调优算法选择传入的分类器之一。- 参数:
- classifierssktime 分类器列表,或
sktime 分类器的元组列表 (str, estimator) MultiplexClassifier 可以在这些分类器之间切换(“多路复用”)。这些是“蓝图”分类器,调用
fit
时状态不会改变。- selected_classifier: str 或 None,可选,默认值=None。
- 如果为 str,必须是分类器名称之一。
如果未提供名称,则必须与自动生成的名称字符串一致。要检查自动生成的名称字符串,请调用
get_params
。
如果为 None,则表现为列表中的第一个分类器被选中。选择 MultiplexClassifier 所表现的分类器。
- 属性:
- classifier_sktime 分类器
用于拟合和分类的所选分类器的克隆。
_classifiers
(str, classifier) 元组列表转换为名称/估计器元组的分类器。
方法
check_is_fitted
([method_name]) (检查是否已拟合)检查估计器是否已拟合。
获取具有相同超参数和配置的对象的克隆。
clone_tags
(estimator[, tag_names]) (克隆标签)从另一个对象克隆标签作为动态覆盖。
create_test_instance
([parameter_set]) (创建测试实例)构造类的实例,使用第一个测试参数集。
create_test_instances_and_names
([parameter_set]) (创建测试实例和名称)创建所有测试实例列表及其名称列表。
fit
(X, y) (拟合)将时间序列分类器拟合到训练数据。
fit_predict
(X, y[, cv, change_state]) (拟合预测)对 X 中的序列进行拟合并预测标签。
fit_predict_proba
(X, y[, cv, change_state]) (拟合预测概率)对 X 中的序列进行拟合并预测标签概率。
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_test_params
([parameter_set]) (获取测试参数)返回估计器的测试参数设置。
检查对象是否为复合对象。
load_from_path
(serial) (从路径加载)从文件位置加载对象。
load_from_serial
(serial) (从序列化数据加载)从序列化内存容器加载对象。
predict
(X) (预测)预测 X 中序列的标签。
predict_proba
(X) (预测概率)预测 X 中序列的标签概率。
将对象重置为干净的初始化后状态。
save
([path, serialization_format]) (保存)将序列化的自身保存到字节类对象或 (.zip) 文件。
score
(X, y) (评分)对 X 上的预测标签与真实标签进行评分。
set_config
(**config_dict) (设置配置)将配置标志设置为给定值。
set_params
(**kwargs) (设置参数)设置估计器的参数。
set_random_state
([random_state, deep, ...]) (设置随机状态)为自身设置 random_state 伪随机种子参数。
set_tags
(**tag_dict) (设置标签)将实例级别标签覆盖设置为给定值。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。is_fitted
属性应在对象的fit
方法调用中设置为True
。如果未拟合,则抛出
NotFittedError
。- 参数:
- method_namestr,可选
调用此函数的方法的名称。如果提供,错误消息将包含此信息。
- 抛出:
- NotFittedError (未拟合错误)
如果估计器尚未拟合。
- clone()[source]#
获取具有相同超参数和配置的对象的克隆。
克隆是具有相同超参数和配置的不同对象,处于初始化后状态。此函数等同于返回
self
的sklearn.clone
。等同于使用
self
的参数构造一个type(self)
的新实例,即type(self)(**self.get_params(deep=False))
。如果
self
上设置了配置,克隆也会具有与原始对象相同的配置,等同于调用cloned_self.set_config(**self.get_config())
。在值上也等同于调用
self.reset
,区别在于clone
返回一个新对象,而reset
会改变self
。- 抛出:
- 如果克隆不符合规范,则抛出 RuntimeError,这是由于
__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
的引用。
- 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 个元素是第 i 个 obj 实例在测试中的名称。如果实例多于一个,命名约定是
{cls.__name__}-{i}
,否则是{cls.__name__}
- fit(X, y)[source]#
将时间序列分类器拟合到训练数据。
- 状态改变
将状态改为“已拟合”。
- 写入自身
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel
用于拟合估计器的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array (任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtypes 列表请参见
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对自身的引用。
- fit_predict(X, y, cv=None, change_state=True)[source]#
对 X 中的序列进行拟合并预测标签。
方便的方法,用于生成样本内预测和交叉验证的样本外预测。
- 写入自身,如果 change_state=True
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel
用于拟合和预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array (任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtypes 列表请参见
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
- cvNone、int 或 sklearn 交叉验证对象,可选,默认值=None
None:预测是样本内预测,等同于
fit(X, y).predict(X)
cv:预测等同于
fit(X_train, y_train).predict(X_test)
,其中多个X_train
、y_train
、X_test
从cv
折叠中获得。返回的y
是所有测试折叠预测的并集,cv
测试折叠必须不相交int:等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即 k 折交叉验证样本外预测,并且random_state
x
取自self
(如果存在),否则x=None
- change_statebool,可选(默认值=True)
如果为 False,则不会改变分类器的状态,即拟合/预测序列是使用副本运行的,self 不会改变
如果为 True,则会将自身拟合到完整的 X 和 y,结束状态将等同于运行 fit(X, y)
- 返回:
- y_predsktime 兼容的表格数据容器,scitype 为 Table scitype
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
0 索引对应 X 中的实例索引,1 索引(如果适用)对应 X 中的多输出向量索引。
如果 y 是单变量(一个维度),则为 1D np.npdarray;否则,类型与 fit 中传入的 y 相同
- fit_predict_proba(X, y, cv=None, change_state=True)[source]#
对 X 中的序列进行拟合并预测标签概率。
方便的方法,用于生成样本内预测和交叉验证的样本外预测。
- 写入自身,如果 change_state=True
将 self.is_fitted 设置为 True。设置以“_”结尾的已拟合模型属性。
如果 change_state=False,则不更新状态。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel
用于拟合和预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array (任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtypes 列表请参见
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
- cvNone、int 或 sklearn 交叉验证对象,可选,默认值=None
None:预测是样本内预测,等同于
fit(X, y).predict(X)
cv:预测等同于
fit(X_train, y_train).predict(X_test)
,其中多个X_train
、y_train
、X_test
从cv
折叠中获得。返回的y
是所有测试折叠预测的并集,cv
测试折叠必须不相交int:等同于
cv=KFold(cv, shuffle=True, random_state=x)
,即 k 折交叉验证样本外预测,并且random_state
x
取自self
(如果存在),否则x=None
- change_statebool,可选(默认值=True)
如果为 False,则不会改变分类器的状态,即拟合/预测序列是使用副本运行的,self 不会改变
如果为 True,则会将自身拟合到完整的 X 和 y,结束状态将等同于运行 fit(X, y)
- 返回:
- y_pred2D np.array of int,形状为 [n_instances, n_classes]
预测的类别标签概率 0 索引对应 X 中的实例索引 1 索引对应类别索引,顺序与 self.classes_ 中的顺序相同 条目是预测的类别概率,总和为 1
- 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,默认值=True
是否返回组件的已拟合参数。
如果为 True,则返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值参数)的已拟合参数。
如果为 False,则返回此对象的参数名称:值字典,但不包括组件的已拟合参数。
- 返回:
- fitted_params键为 str 的字典
已拟合参数字典,参数名称:参数值 键值对包括
总是:此对象的所有已拟合参数,通过
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,默认值=True
是否按字母顺序排序返回参数名称 (True),或者按它们在类的
__init__
中出现的顺序返回 (False)。
- 返回:
- param_names: list[str]
cls
的参数名称列表。如果sort=False
,顺序与它们在类的__init__
中出现的顺序相同。如果sort=True
,按字母顺序排序。
- get_params(deep=True)[source]#
获取估计器的参数。
- 参数:
- deep布尔值,可选
如果为 True,则返回此估计器及其包含的子估计器的参数。
- 返回:
- paramsstring 到任意类型的映射
参数名称映射到其值。
- 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_default任意类型,可选;默认值=None
未找到标签时的默认/备用值
- 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,如果
- get_tags()[source]#
从实例获取标签,并继承标签级别和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储有关对象的元数据,或控制对象的行为。标签是实例
self
特有的键值对,它们是静态标志,在对象构造后不会改变。get_tags
方法返回一个标签字典,键是类或其任何父类中设置的任何_tags
属性的键,或者通过set_tags
或clone_tags
设置的标签。值是相应的标签值,覆盖的优先级按降序排列:
通过实例上的
set_tags
或clone_tags
设置的标签,
在实例构造时。
在类的
_tags
属性中设置的标签。在父类的
_tags
属性中设置的标签,
按继承顺序排列。
- 返回:
- collected_tagsdict
标签名称:标签值对字典。通过嵌套继承从
_tags
类属性收集,然后是_tags_dynamic
对象属性中的任何覆盖和新标签。
- classmethod get_test_params(parameter_set='default')[source]#
返回估计器的测试参数设置。
- 参数:
- parameter_setstr,默认值="default"
要返回的测试参数集的名称,用于测试。如果某个值未定义特殊参数,则返回
"default"
集。
- 返回:
- paramsdict 或 list of dict
- is_composite()[source]#
检查对象是否为复合对象。
复合对象是指其参数包含其他对象的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- composite: bool,自身是否包含一个参数是 BaseObject
- property is_fitted[source]#
是否已调用
fit
。检查对象的
_is_fitted` 属性,该属性应在对象构造期间初始化为 ``False
,并在对象的 fit 方法调用中设置为 True。- 返回:
- bool
估计器是否已 fit。
- classmethod load_from_path(serial)[source]#
从文件位置加载对象。
- 参数:
- serialZipFile(path).open("object) 的结果
- 返回:
- 反序列化的自身,结果输出在
path
,来自cls.save(path)
- 反序列化的自身,结果输出在
- classmethod load_from_serial(serial)[source]#
从序列化内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第一个元素
- serial
- 返回:
- 反序列化的自身,结果输出为
serial
,来自cls.save(None)
- 反序列化的自身,结果输出为
- predict(X)[source]#
预测 X 中序列的标签。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel
用于预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array (任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtypes 列表请参见
datatypes.SCITYPE_REGISTER
规范请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- 返回:
- y_predsktime 兼容的表格数据容器,scitype 为 Table scitype
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
0 索引对应 X 中的实例索引,1 索引(如果适用)对应 X 中的多输出向量索引。
如果 y 是单变量(一个维度),则为 1D np.npdarray;否则,类型与 fit 中传入的 y 相同
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel
用于预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array (任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtypes 列表请参见
datatypes.SCITYPE_REGISTER
规范请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有估计器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- 返回:
- y_pred2D np.array of int,形状为 [n_instances, n_classes]
预测的类别标签概率 0 索引对应 X 中的实例索引 1 索引对应类别索引,顺序与 self.classes_ 中的顺序相同 条目是预测的类别概率,总和为 1
- 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))
后获得的对象。- 返回:
- 自身
类实例重置为干净的初始化后状态,但保留当前的超参数值。
- save(path=None, serialization_format='pickle')[source]#
将序列化的自身保存到字节类对象或 (.zip) 文件。
行为:如果
path
为 None,则返回内存中的序列化自身;如果path
是文件位置,则将自身作为 zip 文件存储在该位置保存的文件是 zip 文件,包含以下内容:_metadata - 包含自身的类,即 type(self) _obj - 序列化的自身。此类使用默认的序列化方式 (pickle)。
- 参数:
- pathNone 或文件位置 (str 或 Path)
如果为 None,则将自身保存到内存对象中 如果是文件位置,则将自身保存到该文件位置。如果
path="estimator",则会在当前工作目录下创建 zip 文件
estimator.zip
。path="/home/stored/estimator",则会在
/home/stored/
存储 zip 文件
estimator.zip
。- serialization_format: str,默认值 = “pickle”
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化自身 - 如果
path
是文件位置 - 包含文件引用的 ZipFile
- 如果
- score(X, y) float [source]#
对 X 上的预测标签与真实标签进行评分。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,scitype 为 Panel
用于对预测标签进行评分的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一级为实例索引,第二级为时间索引
numpy3D: 3D np.array (任意维数,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtypes 列表请参见
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
- 返回:
- float,predict(X) 与 y 相比的准确率分数
- set_config(**config_dict)[source]#
将配置标志设置为给定值。
- 参数:
- config_dictdict
配置名称:配置值对字典。下面列出了有效的配置、值及其含义
- 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,则抑制警告
- 返回:
- self对自身的引用。
注意
改变对象状态,将config_dict中的配置复制到self._config_dynamic。
- 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可在多次函数调用中获得可重现的输出。
- deepbool,默认值=True
是否在scikit-base对象值参数中设置随机状态,即组件估计器中。
如果为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]#
将实例级别标签覆盖设置为给定值。
每个
scikit-base
兼容对象都有一个标签字典,用于存储有关对象的元数据。标签是特定于实例
self
的键值对,它们是静态标志,在对象构建后不会更改。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要设置的标签值。set_tags
方法应仅在对象的__init__
方法中、构建期间或通过__init__
直接调用后调用。可以通过
get_tags
或get_tag
检查当前的标签值。- 参数:
- **tag_dictdict
标签名称: 标签值对的字典。
- 返回:
- Self
对自身的引用。