ProbabilityThresholdEarlyClassifier#
- class ProbabilityThresholdEarlyClassifier(probability_threshold=0.85, consecutive_predictions=1, estimator=None, classification_points=None, n_jobs=1, random_state=None)[source]#
概率阈值早期分类器。
一种早期分类器,它使用预测概率阈值来确定早期预测是否安全。
- 概述
构建 n 个分类器,其中 n 是分类点数。当预测仍被认为不安全时
使用分类点 i 的序列长度进行预测。使用 decide_prediction_safety 决定预测是否安全。
- 参数:
- probability_thresholdfloat, 默认=0.85
将预测视为安全所需的类别预测概率。
- consecutive_predictionsint, 默认=1
将预测视为安全所需的,连续高于阈值的同一类别的预测次数。
- estimator: sktime 分类器, 默认=None
用于使用变换后的数据构建的 sktime 评估器。默认为 CanonicalIntervalForest。
- classification_points列表 或 None, 默认=None
用于构建分类器并允许进行预测的整数时间序列时间戳列表。早期预测必须具有与 _classification_points 列表中值匹配的序列长度。重复值将被删除,如果不存在,将附加完整的序列长度。如果为 None,将使用从 0 到序列长度线性分布的 20 个阈值。
- n_jobsint, 默认=1
用于并行运行
fit
和predict
的作业数。-1
表示使用所有处理器。- random_stateint 或 None, 默认=None
随机数生成种子。
- 属性:
- n_classes_int
类别数量。
- classes_列表
唯一的类别标签。
示例
>>> from sktime.classification.early_classification import ( ... ProbabilityThresholdEarlyClassifier ... ) >>> from sktime.classification.interval_based import TimeSeriesForestClassifier >>> from sktime.datasets import load_unit_test >>> X_train, y_train = load_unit_test(split="train", return_X_y=True) >>> X_test, y_test = load_unit_test(split="test", return_X_y=True) >>> clf = ProbabilityThresholdEarlyClassifier( ... classification_points=[6, 16, 24], ... estimator=TimeSeriesForestClassifier(n_estimators=10) ... ) >>> clf.fit(X_train, y_train) ProbabilityThresholdEarlyClassifier(...) >>> y_pred = clf.predict(X_test)
方法
check_is_fitted
([method_name])检查评估器是否已拟合。
clone
()获取具有相同超参数和配置的对象的克隆。
clone_tags
(estimator[, tag_names])将另一个对象的标签克隆为动态覆盖。
create_test_instance
([parameter_set])使用第一个测试参数集构造类的一个实例。
create_test_instances_and_names
([parameter_set])创建所有测试实例的列表及其名称列表。
decide_prediction_safety
(X, X_probabilities, ...)决定早期分类的安全性。
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])从类中获取类标签值,具有来自父类的标签级别继承。
从类中获取类标签,具有来自父类的标签级别继承。
获取 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])返回评估器的测试参数设置。
检查对象是否由其他 BaseObjects 组成。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化的内存容器加载对象。
predict
(X)预测 X 中序列的标签。
预测 X 中序列的标签概率。
reset
()将对象重置到干净的初始化后状态。
save
([path, serialization_format])将序列化的 self 保存到类似字节的对象或 (.zip) 文件。
score
(X, y)根据 X 上的真实标签对预测标签进行评分。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])设置 self 的 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级标签覆盖设置为给定值。
- decide_prediction_safety(X, X_probabilities, state_info)[source]#
决定早期分类的安全性。
- 参数:
- X3D np.array (任意维度数量,等长序列),形状为 =
[n_instances,n_dimensions,series_length] 或 pd.DataFrame,其中每列为一个维度,每个单元格为一个 pd.Series (任意维度数量,等长或不等长序列)。预测时间序列数据。
- X_probabilities2D numpy 数组,形状为 = [n_instances,n_classes]。
X 的预测概率。
- state_info列表 或 None
一个包含 X 中每个决策的状态信息的列表。包含有关数据未来决策的信息。对于首次决策,输入应为 None,对于后续决策,应使用返回的列表 new_state_info。
- 返回:
- decisions列表
一个布尔值列表,包含关于预测是否可以安全使用的决定。
- new_state_info列表
一个包含 X 中每个决策的状态信息的列表,包含有关数据未来决策的信息。
- classmethod get_test_params(parameter_set='default')[source]#
返回评估器的测试参数设置。
- 参数:
- parameter_setstr, 默认=”default”
要返回的测试参数集的名称,用于测试。如果未为某个值定义特殊参数,则返回
"default"
集。
- 返回:
- paramsdict 或 dict 列表, 默认 = {}
创建类的测试实例的参数。
- 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
。- 引发:
- 如果克隆不符合规范,则引发 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 或 str 列表, 默认 = None
要克隆的标签名称。默认值 (
None
) 克隆estimator
中的所有标签。
- 返回:
- self
对
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 个元素是测试中 obj 的第 i 个实例的名称。如果实例多于一个,命名约定是
{cls.__name__}-{i}
,否则是{cls.__name__}
- fit(X, y)[source]#
将时间序列分类器拟合到训练数据。
- 状态变更
将状态更改为“fitted”。
- 写入 self
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,类型为 Panel scitype
用于拟合评估器的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array (任意维度数量,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
规范请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- ysktime 兼容的表格数据容器,类型为 Table scitype
1D 可迭代对象,形状为 [n_instances] 或 2D 可迭代对象,形状为 [n_instances, n_dimensions],用于拟合的类别标签。第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。支持的 sktime 类型:np.ndarray (1D, 2D), pd.Series, pd.DataFrame
- 返回:
- self对 self 的引用。
- fit_predict(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中序列的标签。
方便的方法,用于生成样本内预测和交叉验证的样本外预测。
- 如果 change_state=True,写入 self
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
如果 change_state=False,不更新状态。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,类型为 Panel scitype
用于拟合和预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array (任意维度数量,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
规范请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- ysktime 兼容的表格数据容器,类型为 Table scitype
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,则不会更改分类器的状态,即使用副本运行 fit/predict 序列,self 不改变
如果为 True,则将 self 拟合到完整的 X 和 y,结束状态将等同于运行 fit(X, y)
- 返回:
- y_predsktime 兼容的表格数据容器,类型为 Table scitype
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。
1D np.npdarray,如果 y 是单变量(一维);否则,与 fit 中传入的 y 类型相同
- fit_predict_proba(X, y, cv=None, change_state=True)[source]#
拟合并预测 X 中序列的标签概率。
方便的方法,用于生成样本内预测和交叉验证的样本外预测。
- 如果 change_state=True,写入 self
将 self.is_fitted 设置为 True。设置以“_”结尾的拟合模型属性。
如果 change_state=False,不更新状态。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,类型为 Panel scitype
用于拟合和预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array (任意维度数量,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
规范请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- ysktime 兼容的表格数据容器,类型为 Table scitype
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,则不会更改分类器的状态,即使用副本运行 fit/predict 序列,self 不改变
如果为 True,则将 self 拟合到完整的 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 的配置标志。
配置是
self
的键值对,通常用作控制行为的瞬时标志。get_config
返回动态配置,它们覆盖默认配置。默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用下被保留。- 返回:
- config_dictdict
配置名称:配置值对的字典。通过嵌套继承从 _config 类属性收集,然后是来自 _onfig_dynamic 对象属性的任何覆盖和新标签。
- get_fitted_params(deep=True)[source]#
获取拟合参数。
- 所需状态
要求状态为“fitted”。
- 参数:
- deepbool, 默认=True
是否返回组件的拟合参数。
如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值的参数)的拟合参数。
如果为 False,将返回此对象的参数名称:值字典,但不包括组件的拟合参数。
- 返回:
- fitted_params键为 str 的 dict
拟合参数字典,paramname : paramvalue 键值对包括
始终:此对象的所有拟合参数,如同通过
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]#
获取此对象的参数值字典。
- 参数:
- deepbool, 默认=True
是否返回组件的参数。
如果为
True
,将返回此对象的参数名称:值dict
,包括组件(=BaseObject
值的参数)的参数。如果为
False
,将返回此对象的参数名称:值dict
,但不包括组件的参数。
- 返回:
- params键为 str 的 dict
参数字典,paramname : paramvalue 键值对包括
始终:此对象的所有参数,如同通过
get_param_names
获取一样,值是此对象该键的参数值,值始终与构造时传入的值相同如果
deep=True
,还包含组件参数的键/值对,组件的参数索引为[componentname]__[paramname]
,componentname
的所有参数都显示为paramname
及其值如果
deep=True
,还包含任意级别的组件递归,例如[componentname]__[componentcomponentname]__[paramname]
等
- 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
对象属性的任何覆盖和新标签。
- is_composite()[source]#
检查对象是否由其他 BaseObjects 组成。
复合对象是包含其他对象作为参数的对象。在实例上调用,因为这可能因实例而异。
- 返回:
- 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) 的结果
- 返回:
- 反序列化的 self,结果存储在
path
,是cls.save(path)
的输出
- 反序列化的 self,结果存储在
- classmethod load_from_serial(serial)[source]#
从序列化的内存容器加载对象。
- 参数:
- serial
cls.save(None)
输出的第 1 个元素
- serial
- 返回:
- 反序列化的 self,结果为输出
serial
,是cls.save(None)
的输出
- 反序列化的 self,结果为输出
- predict(X)[source]#
预测 X 中序列的标签。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,类型为 Panel scitype
用于预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array (任意维度数量,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
规范请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- 返回:
- y_predsktime 兼容的表格数据容器,类型为 Table scitype
预测的类别标签
1D 可迭代对象,形状为 [n_instances],或 2D 可迭代对象,形状为 [n_instances, n_dimensions]。
第 0 个索引对应于 X 中的实例索引,第 1 个索引(如果适用)对应于 X 中的多输出向量索引。
1D np.npdarray,如果 y 是单变量(一维);否则,与 fit 中传入的 y 类型相同
- predict_proba(X)[source]#
预测 X 中序列的标签概率。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,类型为 Panel scitype
用于预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array (任意维度数量,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtype 列表请参见
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
调用会删除任何对象属性,除了超参数 = 写入
self
的__init__
参数,例如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) 下创建一个名为
estimator.zip
的 zip 文件。path=”/home/stored/estimator”,则将在
/home/stored/
中创建一个名为estimator.zip
的 zip 文件。
存储在
/home/stored/
中。- serialization_format: str, 默认 = “pickle”
用于序列化的模块。可用选项为“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 返回:
- 如果
path
为 None - 内存中的序列化自身 - 如果
path
为文件位置 - 包含文件引用的 ZipFile
- 如果
- score(X, y) float [source]#
根据 X 上的真实标签对预测标签进行评分。
- 参数:
- Xsktime 兼容的时间序列面板数据容器,类型为 Panel scitype
用于评分预测标签的时间序列。
可以是
Panel
scitype 的任何 mtype,例如pd-multiindex: pd.DataFrame,列为变量,索引为 pd.MultiIndex,第一层为实例索引,第二层为时间索引
numpy3D: 3D np.array (任意维度数量,等长序列),形状为 [n_instances, n_dimensions, series_length]
或任何其他支持的
Panel
mtype
mtype 列表请参见
datatypes.SCITYPE_REGISTER
规范请参见
examples/AA_datatypes_and_datasets.ipynb
并非所有评估器都支持具有多元或不等长序列的面板,详情请参见标签参考。
- ysktime 兼容的表格数据容器,类型为 Table scitype
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
在并行化后关闭。 shutting down after parallelization.
- “shutdown_ray”:bool,默认为 True;False 会阻止
“logger_name”:str,默认为“ray”;要使用的 logger 的名称。
“mute_warnings”:bool,默认为 False;如果为 True,则抑制警告
- 返回:
- 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]#
设置 self 的 random_state 伪随机种子参数。
通过
self.get_params
查找名为random_state
的参数,并通过set_params
将它们设置为从random_state
派生的整数。这些整数通过sample_dependent_seed
从链式哈希中采样,并保证 seeded 随机生成器的伪随机独立性。根据
self_policy
,适用于自身中的random_state
参数,并且当且仅当deep=True
时,适用于剩余的组件对象。注意:即使自身没有
random_state
参数,或者没有任何组件具有random_state
参数,也会调用set_params
。因此,set_random_state
将重置任何 scikit-base 对象,即使是那些没有random_state
参数的对象。- 参数:
- random_stateint, RandomState 实例或 None,默认为 None
伪随机数生成器,用于控制随机整数的生成。传递 int 以在多次函数调用中获得可重现的输出。
- deepbool, 默认=True
是否在 skbase 对象值参数(即组件估计器)中设置随机状态。
如果为 False,则仅设置自身的
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
自身的引用。