Update the documentation of "How to use CAPI" in PaddleModel repo.
Created by: lcy-seso
- 我们计划在 models repo 的
how_to_use_capi
目录下增加更加丰富的,与CAPI使用相关的文档和例子,保证能够覆盖到 PaddlePaddle 所有输入数据类型。 - 在这个issue 中,先提出我们能够想到的,需要包含的最小信息。请大家不吝提出更好的建议,帮助我们做好“CAPI使用”相关的文档和例子。
-
how_to_use_capi
会含有二级目录,对应不同的可以完整运行的示例代码; - 一级目录下的 README 需要介绍与CAPI使用相关的通用信息。
- 以下是关于一级目录下 README 的一个基础提纲:
1. 编译paddle lib
2. CAPI 使用流程指南
- 序列化模型配置;
- 组织数据数据;
- 初始化/加载模型;
- 前向计算;
- 清理;
3. 从python 用户接口的输入数据类型,到 C++ 端输入数据类型对应
- 首先,需要一个
[ 12 x 2]
的表格,第一列是用户在 python 端看到的,PaddlePaddle 支持的所有 12 种输入数据类型;第二列对应了 12 种输入数据在 C++ 代码中如何组织的tips。 - 关键代码片段和一定的解释说明;