API文档

关键信息抽取任务API

Config API

update_dataset(dataset_path, dataset_type=None)

更新数据集路径与数据集类型。

输入参数

• dataset_path (str)：数据集存储路径。支持使用绝对路径或相对路径。
• dataset_type (str|None)：数据集类型，备选项有：KieDataset。若为None，使用默认的数据集类型：KieDataset。默认值：None。

update_learning_rate(learning_rate)

更新学习率。

输入参数

• learning_rate (float)：学习率。如果模型训练使用学习率衰减策略，此参数指定的是基准学习率。

update_batch_size(batch_size, mode='train')

更新mini-batch大小。

输入参数

• batch_size (int)：Mini-batch大小。如果使用数据并行，此参数指定的是每个设备上的mini-batch大小。
• mode (str)：batch_size适用的阶段。备选项有：'train'。默认值：'train'。

update_pretrained_weights(pretrained_model)

更新用于模型初始化的预训练权重参数文件路径。

输入参数

• pretrained_model (str)：需要加载的权重参数文件路径。

_update_checkpoints(resume_path)

更新用于断点训练的权重参数文件路径。

输入参数

• resume_path (str)：需要加载的断点训练的权重参数文件路径。

update_class_path(class_path)

更新ser任务的类别字典。

输入参数

• class_path (str)：需要更新ser任务的类别字典路径。

Model API

train(batch_size=None, learning_rate=None, epochs_iters=None, ips=None, device='gpu', resume_path=None, dy2st=False, amp='OFF', num_workers=None, use_vdl=True, save_dir=None, **kwargs)

执行模型训练。

输入参数

• batch_size (int|None)：模型训练阶段使用的mini-batch大小。若为None，则使用默认配置。默认值：None。
• learning_rate (float|None)：模型训练阶段使用的学习率。如果使用学习率衰减策略，此参数指定的是基准学习率。若为None，则使用默认配置。默认值：None。
• epochs_iters (int|None)：模型训练阶段的总迭代次数。若为None，则使用默认配置。默认值：None。
• ips (str|None)：多机训练时各机器的IP地址，用,分隔。若为None，则使用默认配置。默认值：None。
• device (str)：指定模型训练阶段使用的设备，支持指定设备编号。请参考设备字符串。默认值：'gpu'。
• resume_path (str|None)：模型权重参数文件路径。训练将从resume_path指定的文件对应的检查点继续进行。若为None，则使用默认配置。默认值：None。
• dy2st (bool)：是否启用模型动转静训练。默认值：False。
• amp (str)：备选项有：'OFF'，'O1'，'O2'。若为'OFF'，则不启用自动混合精度训练；若为'O1'，则使用O1等级的自动混合精度训练；若为'O2'，则使用O2等级的自动混合精度训练。默认值：'OFF'。
• num_workers (int|None)：加载、预处理数据使用的子进程个数。若为None，则使用默认配置。默认值：None。
• use_vdl (bool)：是否启用VisualDL。默认值：True。
• save_dir (str|None)：输出存储目录。若为None，则使用默认配置。默认值：None。

• **kwargs：以键值对形式提供定制模型训练阶段行为的附加参数。支持的附加参数如下：

  • save_interval (int)：模型训练阶段执行周期性精度验证并存储模型的间隔迭代次数。

evaluate(weight_path, batch_size=None, ips=None, device='gpu', amp='OFF', num_workers=None, **kwargs)

执行模型精度验证。

输入参数

• weight_path (str)：需要加载的权重参数文件路径。
• batch_size (int|None)：模型精度验证阶段使用的mini-batch大小。若为None，则使用默认配置。默认值：None。
• ips (str|None)：多机验证时各机器的IP地址，用,分隔。若为None，则使用默认配置。默认值：None。
• device (str)：指定模型精度验证阶段使用的设备，支持指定设备编号。请参考设备字符串。默认值：'gpu'。
• amp (str)：备选项有：'OFF'，'O1'，'O2'。若为'OFF'，则不启用自动混合精度验证；若为'O1'，则使用O1等级的自动混合精度验证；若为'O2'，则使用O2等级的自动混合精度验证。默认值：'OFF'。
• num_workers (int|None)：加载、预处理数据使用的子进程个数。若为None，则使用默认配置。默认值：None。
• **kwargs：以键值对形式提供定制模型精度验证阶段行为的附加参数。目前暂时没有支持的附加参数。

predict(weight_path, input_path, device='gpu', save_dir=None, **kwargs)

执行动态图模型推理。

输入参数

• weight_path (str)：需要加载的权重参数文件路径。
• input_path (str)：输入图像路径。
• device (str)：指定动态图模型推理阶段使用的设备，不支持指定设备编号。请参考设备字符串。默认值：'gpu'。
• save_dir (str|None)：输出存储目录。若为None，则使用默认配置。默认值：None。
• **kwargs：以键值对形式提供定制动态图模型推理阶段行为的附加参数。目前暂时没有支持的附加参数。

export(weight_path, save_dir, **kwargs)

执行预测模型导出。

输入参数

• weight_path (str)：需要加载的权重参数文件路径。
• save_dir (str)：预测模型的存储目录。
• **kwargs：以键值对形式提供定制预测模型导出阶段行为的附加参数。目前暂时没有支持的附加参数。

infer(model_dir, input_path, device='gpu', save_dir=None, **kwargs)

执行预测模型推理。

输入参数

• model_dir (str)：预测模型的存储目录。
• input_path (str)：输入图像路径。
• device (str)：指定预测模型推理阶段使用的设备，不支持指定设备编号。请参考设备字符串。默认值：'gpu'。
• save_dir (str|None)：输出存储目录。若为None，则使用默认配置。默认值：None。
• **kwargs：以键值对形式提供定制预测模型推理阶段行为的附加参数。目前暂时没有支持的附加参数。

compression(weight_path, batch_size=None, learning_rate=None, epochs_iters=None, device='gpu', use_vdl=True, save_dir=None, **kwargs)

执行模型压缩。模型压缩分为2个步骤：首先执行量化感知训练，然后执行预测模型导出。

输入参数

• weight_path (str)：需要加载的权重参数文件路径。
• batch_size (int|None)：模型压缩阶段使用的mini-batch大小。若为None，则使用默认配置。默认值：None。
• learning_rate (float|None)：模型压缩阶段使用的学习率。如果使用学习率衰减策略，此参数指定的是基准学习率。若为None，则使用默认配置。默认值：None。
• epochs_iters (int|None)：模型压缩阶段的总迭代次数。若为None，则使用默认配置。默认值：None。
• device (str)：指定模型压缩阶段使用的设备，支持指定设备编号。请参考设备字符串。默认值：'gpu'。
• use_vdl (bool)：是否启用VisualDL。默认值：True。
• save_dir (str|None)：输出存储目录。若为None，则使用默认配置。默认值：None。
• **kwargs：以键值对形式提供定制模型压缩阶段行为的附加参数。目前暂时没有支持的附加参数。