---
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>是否进行数据集格式转换；时序预测、时序异常检测、时序分类支持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>
</tbody>
</table>
# Train
### 时序任务公共参数
<table>
<thead>
<tr>
<th>参数名</th>
<th>数据类型</th>
<th>描述</th>
<th>默认值</th>
</tr>
</thead>
<tbody>
<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>time_col</td>
<td>str</td>
<td>时间列，须结合自己的数据设置时间序列数据集的时间列的列名称。</td>
<td>yaml文件中指定的时间列</td>
</tr>
<tr>
<td>freq</td>
<td>str or int</td>
<td>频率，须结合自己的数据设置时间频率，如：1min、5min、1h。</td>
<td>yaml文件中指定的频率</td>
</tr>
</tbody>
</table>
### 时序预测参数
<table>
<thead>
<tr>
<th>参数名</th>
<th>数据类型</th>
<th>描述</th>
<th>默认值</th>
</tr>
</thead>
<tbody>
<tr>
<td>target_cols</td>
<td>str</td>
<td>目标变量列，须结合自己的数据设置时间序列数据集的目标变量的列名称，可以为多个，多个之间用','分隔</td>
<td>OT</td>
</tr>
<tr>
<td>input_len</td>
<td>int</td>
<td>对于时序预测任务，该参数表示输入给模型的历史时间序列长度；输入长度建议结合实际场景及预测长度综合考虑，一般来说设置的越大，能够参考的历史信息越多，模型精度通常越高。</td>
<td>96</td>
</tr>
<tr>
<td>predict_len</td>
<td>int</td>
<td>希望模型预测未来序列的长度；预测长度建议结合实际场景综合考虑，一般来说设置的越大，希望预测的未来序列越长，模型精度通常越低。</td>
<td>96</td>
</tr>
<tr>
<td>patience</td>
<td>int</td>
<td>early stop机制参数，指在停止训练之前，容忍模型在验证集上的性能多少次连续没有改进；耐心值越大，一般训练时间越长。</td>
<td>10</td>
</tr>
</tbody>
</table>
### 时序异常检测
<table>
<thead>
<tr>
<th>参数名</th>
<th>数据类型</th>
<th>描述</th>
<th>默认值</th>
</tr>
</thead>
<tbody>
<tr>
<td>input_len</td>
<td>int</td>
<td>对于时序异常检测任务，该参数表示输入给模型的时间序列长度，会按照该长度对时间序列切片，预测该长度下这一段时序序列是否有异常；输入长度建议结合实际场景考虑。如：输入长度为 96，则表示希望预测 96 个时间点是否有异常。</td>
<td>96</td>
</tr>
<tr>
<td>feature_cols</td>
<td>str</td>
<td>特征变量表示能够判断设备是否异常的相关变量，例如设备是否异常，可能与设备运转时的散热量有关。结合自己的数据，设置特征变量的列名称，可以为多个，多个之间用','分隔。</td>
<td>feature_0,feature_1</td>
</tr>
<tr>
<td>label_col</td>
<td>str</td>
<td>代表时序时间点是否异常的编号，异常点为 1，正常点为 0。</td>
<td>label</td>
</tr>
</tbody>
</table>
### 时序分类
<table>
<thead>
<tr>
<th>参数名</th>
<th>数据类型</th>
<th>描述</th>
<th>默认值</th>
</tr>
</thead>
<tbody>
<tr>
<td>target_cols</td>
<td>str</td>
<td>用于判别类别的特征变量列，须结合自己的数据设置时间序列数据集的目标变量的列名称，可以为多个，多个之间用','分隔</td>
<td>dim_0,dim_1,dim_2</td>
</tr>
<tr>
<td>freq</td>
<td>str or int</td>
<td>频率，须结合自己的数据设置时间频率，如：1min、5min、1h。</td>
<td>1</td>
</tr>
<tr>
<td>group_id</td>
<td>str</td>
<td>一个群组编号表示的是一个时序样本，相同编号的时序序列组成一个样本。结合自己的数据设置指定群组编号的列名称, 如：group_id。</td>
<td>group_id</td>
</tr>
<tr>
<td>static_cov_cols</td>
<td>str</td>
<td>代表时序的类别编号列，同一个样本的标签相同。结合自己的数据设置类别的列名称，如：label。</td>
<td>label</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>
</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>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>
