Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make a general framework for doc in how_to_use_capi. #385

Closed

Conversation

peterzhang2029
Copy link
Contributor

resolve #372

@hedaoyuan
Copy link

hedaoyuan commented Nov 20, 2017

赞这个文档。
在Mobile上用户同样遇到how_to_use_capi的问题 See Inference API。另外,我有几个问题:

  1. 这个PR还在开发吗?还是只差Review了?我可以来Review。
  2. 这个文档可以移到Paddle Repo中吗?我觉得直接放到capi那个目录里面可能比较好。
  3. 建议可以加一个图,解释整个编程模型的步骤,包括序列化模型->初始化->create gradient machine -> 组织输入数据 -> 前向计算 -> 获取数据 -> 清理。
  4. 可以有独立的章节解释多线程计算,Batch Computing等。

@lcy-seso
Copy link
Collaborator

@hedaoyuan 这个PR会继续开发,README 我来继续写完。最近就搞定。

@wangkuiyi
Copy link
Collaborator

We will need English documentation. It could be in this PR, or a future PR.

For some old PRs in the PaddlePaddle/mobile repo, it was me who added the English document. It would be better if the original author can give an English draft, and I can help polish them.

@lcy-seso
Copy link
Collaborator

lcy-seso commented Nov 22, 2017

@wangkuiyi We will have a discussion with @hedaoyuan and @qingqing01 in this week to better organize this documentation and finally move it into the PaddlePaddle repo. We will add the English version documentation into the plan.

@hedaoyuan gave us some suggestions to re-organize the documentation to make it more informative by explaining the programming model and core concepts in PaddlePaddle rather than just copying our example codes. The outline and contents of this documentation will further be re-organized in the next PR.

make
make install
```
其中,`DEST_ROOT` 表示编译得到的动态链接库和头文件的存储目录。`PADDLE_ROOT` 表示 PaddlePaddle 源码所在目录。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里是否可以把每个选项的意思介绍一下,比如WITH_PYTHON=OFF为什么要关掉,WITH_AVX是该打开还是该关闭等

@lcy-seso lcy-seso closed this Dec 18, 2017
@peterzhang2029 peterzhang2029 deleted the capi_readme branch December 19, 2017 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the documentation of "How to use CAPI" in PaddleModel repo.
5 participants