<hyperparameters>及其子标签

<< Click to Display Table of Contents >>

当前位置:  深度分析 > 插件开发 > 插件工程模板详解 > manifest.xml配置详解 > <manifest>及其子标签 > <node>及其子标签 

<hyperparameters>及其子标签

复制链接

Hyperparameters的嵌套标签结构如下所示。

<hyperparameters>
    <parameter>
        <alias> </alias>
        <name> </name>
        <role> </role>
        <string-type>
            <default-value> </default-value>
            <optional-values>
                <value> </value>
            </optional-values>
            <dependent-parameters>
                <item>
                    <selected-value> </selected-value>
                    <dependent-name> </dependent-name>
                </item>
            </dependent-parameters>
        </string-type>
<integer-type>
            <default-value></default-value>
            <scope></scope>
            <regular></regular>
            <value-error></value-error>
 </integer-type>
<bool-type>
            <default-value> </default-value>
</bool-type>
<complex-type>
            <default-value></default-value>
            <regular></regular>
            <value-error> </value-error>
</complex-type>
        <description> </description>
    </parameter>

1)<parameter>

必选项,如果有多个参数就对应定义多个<parameter>标签。

2)<alias>

必选项,定义参数的用户可见的名字。

3)<name>

必选项,定义参数在程序中使用的名字。

4)<role>

必选项,定义参数的角色。参数的角色可选值:control、 system、op_hyper、undefined。

control:控制参数,比如是否自动调参、是否输出特征字段等的控制算子功能切换、算子输入输出的参数;

system:用于设置系统资源如并发线程数、CPU数、内存用量等的参数项;

op_hyper:算子本身的数学计算模型中的参数,设置学习率、选择优化器、选择目标函数等等需要;

undefined:旧版本算子如果不存在该<role>标签,则其默认值为defined;

<string-type>

当参数值需要是若干个枚举值时,选用此标签。定义参数的类型为字符串型枚举值,在页面中将以列表形式展示所有枚举值。包括4个子标签。

<default-value>:定义参数的默认值;

<optional-values>:用多个子标签定义参数的所有枚举值;

<value>:定义参数的枚举值,一个<value>标签值对应一个枚举值。

< dependent-parameters >:定义参数依赖关系,即当前参数选择某个枚举值时,另一个依赖该枚举值的参数也必须对用户可见并且可配置;当依赖的枚举值未被用户选中时,依赖参数对用户不可见。

5)< integer-type >

当参数值需要是整数时,选用此标签。该标签定义填写的参数值必须为整数,否则将抛出错误提示。包括4个子标签。

<default-value>:定义参数的默认值;

<scope>:定义参数的取值范围,取值范围类似于数学符号表示, 但无穷大符号不需要省略,比如“0到正无穷大且包含0”表示为“[0,]”,又比如“-5到5之间任意值,包含边界值5,不包含-5”表示为“(-5, 5]”

<regular>:与<scope>标签互斥,用正则表达式定义参数的取值范围;

< value-error >:定义用户输入的参数值不合法时应该提示的信息。

6)< bool-type >

当参数值需要是布尔类型(true/false)时,选用此标签。包含1个子标签。

<default-value>:定义参数的默认值;

7)< complex-type >

当参数值需要是任意类型时,选用此标签。包括4个子标签。

<default-value>:定义参数的默认值;

<regular>:用正则表达式定义参数要满足的取值范围或者特定格式;

< value-error >:定义用户输入的参数值不符合<regular>条件时应该提示的信息。

8)< description >

必选项,描述参数的意义,帮助插件的使用者快速了解参数的用法。建议意义描述包含这几个要素:默认值,取值范围,参数含义,如何取值,建议用法。