本地开发指南

    • 代码注释请遵守 Doxygen 的样式。
    • 确保编译器选项 WITH_STYLE_CHECK 已打开，并且编译能通过代码样式检查。
    • 所有代码必须具有单元测试。
    • 通过所有单元测试。
    • 请遵守。

    使用官方开发镜像（推荐）

    不同开发者启动docker的命令不一样，以上只是推荐命令。如果使用自己习惯的命令，一定要加参数—privileged（GPU的CUPTI库调用需要）

    推荐使用官方开发镜像 hub.baidubce.com/paddlepaddle/paddle:latest-dev 提交代码。

    以下教程将指导您提交代码。

    Fork

    跳转到 GitHub首页，然后单击 Fork 按钮，生成自己目录下的仓库，比如 https://github.com/USERNAME/Paddle。

    克隆（Clone）

    将远程仓库 clone 到本地：

    1. ➜  git clone https://github.com/USERNAME/Paddle
    2. ➜  cd Paddle

    Paddle 目前使用Git流分支模型进行开发，测试，发行和维护，具体请参考 。

    所有的 feature 和 bug fix 的开发工作都应该在一个新的分支上完成，一般从 develop 分支上创建新分支。

    使用 git checkout -b 创建并切换到新分支。

    1. ➜  git checkout -b my-cool-stuff

    使用 pre-commit 钩子

    Paddle 开发人员使用 工具来管理 Git 预提交钩子。 它可以帮助我们格式化源代码（C++，Python），在提交（commit）前自动检查一些基本事宜（如每个文件只有一个 EOL，Git 中不要添加大文件等）。

    pre-commit测试是 CI 中单元测试的一部分，不满足钩子的 PR 不能被提交到 Paddle，首先安装并在当前目录运行它：

    1. ➜  pip install pre-commit
    2. ➜  pre-commit install

    Paddle 使用 clang-format 来调整 C/C++ 源代码格式，请确保 clang-format 版本在 3.8 以上。

    注：通过pip install pre-commit和conda install -c conda-forge pre-commit安装的yapf稍有不同的，Paddle 开发人员使用的是pip install pre-commit，使用Paddle docker镜像会自带pre-commit不需要单独安装。

    开始开发

    在本例中，我删除了 README.md 中的一行，并创建了一个新文件。

    通过 git status 查看当前状态，这会提示当前目录的一些变化，同时也可以通过 git diff 查看文件具体被修改的内容。

    1. ➜  git status
    2. On branch test
    4.   (use "git checkout -- <file>..." to discard changes in working directory)
    6.     modified:   README.md
    8. Untracked files:
    9.   (use "git add <file>..." to include in what will be committed)
    11.     test
    13. no changes added to commit (use "git add" and/or "git commit -a")

    编译

    创建并进入/Paddle/build路径下：

    执行cmake：

    1. * 对于需要编译**CPU版本PaddlePaddle**的用户：
    3. For Python2: cmake .. -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release
    4. For Python3: cmake .. -DPY_VERSION=3.5 -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release
    6. * 对于需要编译**GPU版本PaddlePaddle**的用户：
    8. For Python2: cmake .. -DWITH_GPU=ON -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release
    9. For Python3: cmake .. -DPY_VERSION=3.5 -DWITH_GPU=ON -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release
    1. make -j$(nproc)
    3. 如：make -j16，使用16核编译

    安装编译好的whl包：首先进入/Paddle/build/python/dist目录下找到生成的.whl包后，然后当前机器或目标机器安装编译好的.whl包：

    1. For Python2: pip install -U（whl包的名字）

    关于编译 PaddlePaddle 的源码，请参见从源码编译 选择对应的操作系统。

    2. ctest --repeat-until-fail 100 -R test_xx

    关于单元测试，可参考 的运行方法。

    提交（commit）

    接下来我们取消对 README.md 文件的改变，然后提交新添加的 test 文件。

    Git 每次提交代码，都需要写提交说明，这可以让其他人知道这次提交做了哪些改变，这可以通过git commit 完成。

    1. ➜  git commit
    2. CRLF end-lines remover...............................(no files to check)Skipped
    3. yapf.................................................(no files to check)Skipped
    4. Check for added large files..............................................Passed
    5. Check for merge conflicts................................................Passed
    6. Check for broken symlinks................................................Passed
    7. Detect Private Key...................................(no files to check)Skipped
    8. Fix End of Files.....................................(no files to check)Skipped
    9. clang-formater.......................................(no files to check)Skipped
    10. [my-cool-stuff c703c041] add test file
    11.  1 file changed, 0 insertions(+), 0 deletions(-)
    12.  create mode 100644 233

    保持本地仓库最新

    在准备发起 Pull Request 之前，需要同步原仓库（https://github.com/PaddlePaddle/Paddle）最新的代码。

    首先通过 git remote 查看当前远程仓库的名字。

    1. ➜  git remote
    2. origin
    3. ➜  git remote -v
    4. origin    https://github.com/USERNAME/Paddle (fetch)
    5. origin    https://github.com/USERNAME/Paddle (push)

    这里 origin 是我们 clone 的远程仓库的名字，也就是自己用户名下的 Paddle，接下来我们创建一个原始 Paddle 仓库的远程主机，命名为 upstream。

    1. ➜  git remote add upstream https://github.com/PaddlePaddle/Paddle
    2. ➜  git remote
    3. origin
    4. upstream

    Push 到远程仓库

    将本地的修改推送到 GitHub 上，也就是 https://github.com/USERNAME/Paddle。