---
comments: true
---

# PaddleX通用模型配置文件参数说明

# Global
<table>
<thead>
<tr>
<th>参数名</th>
<th>数据类型</th>
<th>描述</th>
<th>默认值</th>
</tr>
</thead>
<tbody>
<tr>
<td>model</td>
<td>str</td>
<td>指定模型名称</td>
<td>yaml文件中指定的模型名称</td>
</tr>
<tr>
<td>mode</td>
<td>str</td>
<td>指定模式（check_dataset/train/evaluate/export/predict）</td>
<td>check_dataset</td>
</tr>
<tr>
<td>dataset_dir</td>
<td>str</td>
<td>数据集路径</td>
<td>yaml文件中指定的数据集路径</td>
</tr>
<tr>
<td>device</td>
<td>str</td>
<td>指定使用的设备</td>
<td>yaml文件中指定的设备id</td>
</tr>
<tr>
<td>output</td>
<td>str</td>
<td>输出路径</td>
<td>"output"</td>
</tr>
</tbody>
</table>

# CheckDataset
<table>
<thead>
<tr>
<th>参数名</th>
<th>数据类型</th>
<th>描述</th>
<th>默认值</th>
</tr>
</thead>
<tbody>
<tr>
<td>convert.enable</td>
<td>bool</td>
<td>是否进行数据集格式转换；图像分类、行人属性识别、车辆属性识别、文档方向分类、主体检测、行人检测、车辆检测、人脸检测、异常检测、文本检测、印章文本检测、文本识别、表格识别、图像矫正、版面区域检测暂不支持数据格式转换；图像多标签分类支持COCO格式的数据转换；图像特征、语义分割、实例分割支持LabelMe格式的数据转换；目标检测和小目标检测支持VOC、LabelMe格式的数据转换；公式识别支持PKL格式的数据转换；时序预测、时序异常检测、时序分类支持xlsx和xls格式的数据转换</td>
<td>False</td>
</tr>
<tr>
<td>convert.src_dataset_type</td>
<td>str</td>
<td>需要转换的源数据集格式</td>
<td>null</td>
</tr>
<tr>
<td>split.enable</td>
<td>bool</td>
<td>是否重新划分数据集</td>
<td>False</td>
</tr>
<tr>
<td>split.train_percent</td>
<td>int</td>
<td>设置训练集的百分比，类型为0-100之间的任意整数，需要保证和val_percent值加和为100；</td>
<td>null</td>
</tr>
<tr>
<td>split.val_percent</td>
<td>int</td>
<td>设置验证集的百分比，类型为0-100之间的任意整数，需要保证和train_percent值加和为100；</td>
<td>null</td>
</tr>
<tr>
<td>split.gallery_percent</td>
<td>int</td>
<td>设置验证集中被查询样本的百分比，类型为0-100之间的任意整数，需要保证和train_percent、query_percent，值加和为100；该参数只有图像特征模块才会使用</td>
<td>null</td>
</tr>
<tr>
<td>split.query_percent</td>
<td>int</td>
<td>设置验证集中查询样本的百分比，类型为0-100之间的任意整数，需要保证和train_percent、gallery_percent，值加和为100；该参数只有图像特征模块才会使用</td>
<td>null</td>
</tr>
</tbody>
</table>

# Train
<table>
<thead>
<tr>
<th>参数名</th>
<th>数据类型</th>
<th>描述</th>
<th>默认值</th>
</tr>
</thead>
<tbody>
<tr>
<td>num_classes</td>
<td>int</td>
<td>数据集中的类别数；如果您需要在私有数据集进行训练，需要对该参数进行设置；图像矫正、文本检测、印章文本检测、文本识别、公式识别、表格识别、时序预测、时序异常检测、时序分类不支持该参数</td>
<td>yaml文件中指定类别数</td>
</tr>
<tr>
<td>epochs_iters</td>
<td>int</td>
<td>模型对训练数据的重复学习次数</td>
<td>yaml文件中指定的重复学习次数</td>
</tr>
<tr>
<td>batch_size</td>
<td>int</td>
<td>训练批大小</td>
<td>yaml文件中指定的训练批大小</td>
</tr>
<tr>
<td>learning_rate</td>
<td>float</td>
<td>初始学习率</td>
<td>yaml文件中指定的初始学习率</td>
</tr>
<tr>
<td>pretrain_weight_path</td>
<td>str</td>
<td>预训练权重路径</td>
<td>null</td>
</tr>
<tr>
<td>warmup_steps</td>
<td>int</td>
<td>预热步数</td>
<td>yaml文件中指定的预热步数</td>
</tr>
<tr>
<td>resume_path</td>
<td>str</td>
<td>模型中断后的恢复路径</td>
<td>null</td>
</tr>
<tr>
<td>log_interval</td>
<td>int</td>
<td>训练日志打印间隔</td>
<td>yaml文件中指定的训练日志打印间隔</td>
</tr>
<tr>
<td>eval_interval</td>
<td>int</td>
<td>模型评估间隔</td>
<td>yaml文件中指定的模型评估间隔</td>
</tr>
<tr>
<td>save_interval</td>
<td>int</td>
<td>模型保存间隔；异常检测、语义分割、图像矫正、时序预测、时序异常检测、时序分类暂不支持该参数</td>
<td>yaml文件中指定的模型保存间隔</td>
</tr>
</tbody>
</table>

# Evaluate
<table>
<thead>
<tr>
<th>参数名</th>
<th>数据类型</th>
<th>描述</th>
<th>默认值</th>
</tr>
</thead>
<tbody>
<tr>
<td>weight_path</td>
<td>str</td>
<td>评估模型路径</td>
<td>默认训练产出的本地路径，当指定为None时，表示使用官方权重</td>
</tr>
<tr>
<td>log_interval</td>
<td>int</td>
<td>评估日志打印间隔</td>
<td>yaml文件中指定的评估日志打印间隔</td>
</tr>
</tbody>
</table>

# Export
<table>
<thead>
<tr>
<th>参数名</th>
<th>数据类型</th>
<th>描述</th>
<th>默认值</th>
</tr>
</thead>
<tbody>
<tr>
<td>weight_path</td>
<td>str</td>
<td>导出模型的动态图权重路径</td>
<td>默认训练产出的本地路径，当指定为None时，表示使用官方权重</td>
</tr>
</tbody>
</table>

# Predict
<table>
<thead>
<tr>
<th>参数名</th>
<th>数据类型</th>
<th>描述</th>
<th>默认值</th>
</tr>
</thead>
<tbody>
<tr>
<td>batch_size</td>
<td>int</td>
<td>预测批大小</td>
<td>yaml文件中指定的预测批大小</td>
</tr>
<tr>
<td>model_dir</td>
<td>str</td>
<td>预测模型路径</td>
<td>默认训练产出的本地推理模型路径，当指定为None时，表示使用官方权重</td>
</tr>
<tr>
<td>input</td>
<td>str</td>
<td>预测输入路径</td>
<td>yaml文件中指定的预测输入路径</td>
</tr>

<tr>
<td>kernel_option</td>
<td>dict</td>
<td>推理引擎设置，如：“run_mode: paddle”</td>
<td></td>
</tr>

<tr>
<td>use_hpip</td>
<td>bool</td>
<td>是否启用高性能推理插件</td>
<td></td>
</tr>
<tr>
<td>hpip_config</td>
<td>dict | None</td>
<td>高性能推理配置</td>
<td></td>
</tr>

</tbody>
</table>
