TSCStrategy#
- class TSCStrategy(estimator, name=None)[source]#
时间序列分类策略。
- 参数:
- estimator一个估计器
策略中使用的低级估计器。
- namestr, 可选 (默认=None)
策略名称。如果为 None,则使用估计器的类名。
- 属性:
方法
check_is_fitted
([method_name])检查估计器是否已拟合。
clone
()获取具有相同超参数和配置的对象的克隆。
clone_tags
(estimator[, tag_names])从另一个对象克隆标签作为动态覆盖。
create_test_instance
([parameter_set])使用第一个测试参数集构建类的实例。
create_test_instances_and_names
([parameter_set])创建所有测试实例的列表以及它们的名称列表。
fit
(task, data)将策略拟合到给定的任务和数据。
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])返回 skbase 对象的测试参数设置。
检查对象是否由其他 BaseObject 组成。
load
(path)加载已保存的策略。
load_from_path
(serial)从文件位置加载对象。
load_from_serial
(serial)从序列化内存容器加载对象。
predict
(data)使用给定的测试数据进行预测。
reset
()将对象重置为干净的初始化后状态。
save
(path)将序列化的自身保存到字节类对象或 (.zip) 文件。
set_config
(**config_dict)将配置标志设置为给定值。
set_params
(**params)设置此对象的参数。
set_random_state
([random_state, deep, ...])为自身设置 random_state 伪随机种子参数。
set_tags
(**tag_dict)将实例级标签覆盖设置为给定值。
- check_is_fitted(method_name=None)[source]#
检查估计器是否已拟合。
检查
_is_fitted
属性是否存在且为True
。在调用对象的fit
方法时,is_fitted
属性应设置为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
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。clone_tags
方法应仅在对象的__init__
方法中,在构造期间,或通过__init__
构造后直接调用。动态标签被设置为
estimator
中标签的值,名称由tag_names
指定。tag_names
的默认值将estimator
中的所有标签写入self
。当前标签值可通过
get_tags
或get_tag
进行检查。estimator:class:BaseObject 或派生类的实例
- parameter_setstr, 默认=”default”
使用第一个测试参数集构建类的实例。
- objscls 实例的列表
创建所有测试实例的列表以及它们的名称列表。
- taskTask
将策略拟合到给定的任务和数据。
-
每个
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
。collected_tagsdict
要检索带有潜在实例覆盖的标签值,请改用
get_tag
方法。标签名称:标签值 对的字典。通过嵌套继承从
_tags
类属性收集。不会被set_tags
或clone_tags
设置的动态标签覆盖。
-
get_config
返回动态配置,这些配置会覆盖默认配置。 获取自身的配置标志。
默认配置在类或其父类的类属性
_config
中设置,并被通过set_config
设置的动态配置覆盖。配置在
clone
或reset
调用中保留。config_dictdict
配置名称:配置值 对的字典。通过嵌套继承从 _config 类属性收集,然后应用 _onfig_dynamic 对象属性中的任何覆盖和新标签。
- 需要状态为“已拟合”。
获取拟合参数。
- deepbool, 默认=True
是否返回组件的拟合参数。
- 参数:
- 如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值参数)的拟合参数。
如果为 False,将返回此对象的参数名称:值字典,但不包括组件的拟合参数。
fitted_params键为 str 的 dict
拟合参数字典,paramname : paramvalue 键值对包括
- self
- default_dict: dict[str, Any]
键是
cls
的所有在__init__
中定义了默认值的参数。值是在__init__
中定义的默认值。
- sortbool, 默认=True
是否按字母顺序(True)返回参数名称,或按它们在类的
__init__
中出现的顺序(False)返回。
-
如果为
True
,将返回此对象的参数名称:值dict
,包括组件(=BaseObject
值参数)的参数。 获取此对象的参数值字典。
- 参数:
- 如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值参数)的拟合参数。
如果为
False
,将返回此对象的参数名称:值dict
,但不包括组件的参数。params键为 str 的 dict
参数字典,paramname : paramvalue 键值对包括
- self
-
在实例上通过
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
。
- self
- ValueError, 如果
raise_error
为True
。 当
tag_name
不在self.get_tags().keys()
中时,会引发ValueError
。
- ValueError, 如果
- 引发:
- collected_tagsdict
从实例获取标签,并带有标签级别继承和覆盖。
每个
scikit-base
兼容对象都有一个标签字典。标签可用于存储对象的元数据,或控制对象的行为。clone_tags
从另一个对象estimator
设置动态标签覆盖。标签名称:标签值 对的字典。通过嵌套继承从
_tags
类属性收集,然后应用_tags_dynamic
对象属性中的任何覆盖和新标签。实例可以根据超参数覆盖这些标签。
要检索的标签名称
tag_value_default任意类型, 可选; 默认=None
在父类的
_tags
属性中设置的标签,按继承顺序排列。
不考虑在实例上设置的动态标签覆盖,这些覆盖通过
set_tags
或clone_tags
在实例上定义。
-
get_test_params
应返回单个dict
或dict
列表。 返回 skbase 对象的测试参数设置。
每个
dict
都是一个用于测试的参数配置,可用于构造一个“有趣”的测试实例。对于get_test_params
返回中的所有字典params
,调用cls(**params)
应是有效的。get_test_params
不需要返回固定的字典列表,它也可以返回动态或随机的参数设置。paramsdict 或 dict 列表, 默认 = {}
用于创建类的测试实例的参数。每个 dict 是用于构造“有趣”测试实例的参数,即 MyClass(**params) 或 MyClass(**params[i]) 创建一个有效的测试实例。create_test_instance 使用 params 中的第一个(或唯一一个)字典
- composite: bool
检查对象是否由其他 BaseObject 组成。
对象是否具有任何参数,其值是
BaseObject
的派生实例。
- 策略保存到磁盘上的位置
加载已保存的策略。
-
反序列化自身,结果位于
path
,来自cls.save(path)
从文件位置加载对象。
-
反序列化自身,结果为
serial
,来自cls.save(None)
从序列化内存容器加载对象。
- data一个 pandas.DataFrame
只读名称属性。
-
包含传递给
fit
的任务中指定的特征变量和目标变量的 DataFrame。 使用给定的测试数据进行预测。
-
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
- 对
self
的引用。 行为:如果
path
为 None,则返回内存中的序列化自身;如果path
是文件位置,则将自身保存到该位置作为 zip 文件
- 对
- 保存的文件是 zip 文件,包含以下内容:_metadata - 包含自身的类,即 type(self) _obj - 序列化的自身。此类别使用默认序列化(pickle)。
将序列化的自身保存到字节类对象或 (.zip) 文件。
pathNone 或文件位置 (str 或 Path)
如果为 None,则将自身保存到内存对象 如果是文件位置,则将自身保存到该文件位置。如果
- 参数:
- path=”estimator”,则将在当前工作目录创建 zip 文件
estimator.zip
。 path=”/home/stored/estimator”,则 zip 文件
estimator.zip
将存储在
/home/stored/
中。serialization_format: str, 默认 = “pickle”
用于序列化的模块。可用选项有“pickle”和“cloudpickle”。请注意,非默认格式可能需要安装其他软依赖项。
- 如果
path
为 None - 内存中的序列化自身 如果
path
是文件位置 - ZipFile,引用该文件
- path=”estimator”,则将在当前工作目录创建 zip 文件
- self
- displaystr, “diagram” (默认), 或 “text”
将配置标志设置为给定值。
- 参数:
- get_fitted_params(deep=True)[source]#
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
在并行化后关闭。“logger_name”: str, 默认=”ray”; 要使用的日志记录器名称。
- “mute_warnings”: bool, 默认=False; 如果为 True,则抑制警告
self对自身的引用。
注意
改变对象状态,将 config_dict 中的配置复制到 self._config_dynamic。
- self
此方法适用于简单的 skbase 对象以及复合对象。对于复合对象(即包含其他对象的对象),可使用参数键字符串
<component>__<parameter>
来访问组件<component>
中的<parameter>
。如果引用明确,例如组件参数中没有两个同名<parameter>
,也可以使用字符串<parameter>
,而不带<component>__
。**paramsdict
-
BaseObject 参数,键必须是
<component>__<parameter>
字符串。__
后缀可以作为完整字符串的别名,前提是在 get_params 键中是唯一的。 设置此对象的参数。
self对自身的引用(设置参数后)
-
注意:即使
self
没有random_state
参数,或者没有任何组件有random_state
参数,也会调用set_params
。因此,set_random_state
会重置任何scikit-base
对象,即使那些没有random_state
参数的对象。 为自身设置 random_state 伪随机种子参数。
random_stateint, RandomState 实例或 None, 默认=None
伪随机数生成器,用于控制随机整数的生成。传递 int 可在多次函数调用中获得可重现的输出。
是否在 skbase 对象值参数中设置随机状态,即组件估计器。
- 参数:
- 如果为 False,则仅设置
self
的random_state
参数(如果存在)。 如果为 True,还将设置组件对象中的
random_state
参数。- 如果为 True,将返回此对象的参数名称:值字典,包括可拟合组件(= BaseEstimator 值参数)的拟合参数。
self_policystr, 以下之一 {“copy”, “keep”, “new”}, 默认=”copy”
“copy” :
self.random_state
设置为输入random_state
“keep” :
self.random_state
保持不变
- “new” :
self.random_state
设置为新的随机状态, -
标签是实例
self
特有的键值对,它们是静态标志,在对象构造后不会改变。它们可用于元数据检查或控制对象的行为。
- 如果为 False,则仅设置
- self
- 自身对自身的引用
- set_tags(**tag_dict)[source]#
将实例级标签覆盖设置为给定值。
get_class_tag
方法是一个类方法,它仅考虑类级别标签值和覆盖来检索标签的值。标签是键值对,特定于实例
self
,它们是对象构建后不会更改的静态标志。它们可用于元数据检查或控制对象的行为。set_tags
将动态标签覆盖设置为tag_dict
中指定的值,其中键是标签名称,字典值是要将标签设置成的值。set_tags
方法应仅在对象的__init__
方法中(在构建期间)调用,或在通过__init__
构建后立即调用。estimator:class:BaseObject 或派生类的实例
- 参数:
- **tag_dict字典
标签名称:标签值对的字典。
- self
- 自身
对自身的引用。