本地开发指南¶
本文将指导你如何在本地进行代码开发
Fork¶
跳转到PaddlePaddle GitHub首页,然后单击 Fork
按钮,生成自己目录下的仓库,比如 https://github.com/USERNAME/Paddle。
创建本地分支¶
Paddle 目前使用Git流分支模型进行开发,测试,发行和维护,具体请参考 Paddle 分支规范。
所有的 feature 和 bug fix 的开发工作都应该在一个新的分支上完成,一般从 develop
分支上创建新分支。
使用 git checkout -b
创建并切换到新分支。
➜ git checkout -b my-cool-stuff
值得注意的是,在 checkout 之前,需要保持当前分支目录 clean,否则会把 untracked 的文件也带到新分支上,这可以通过 git status
查看。
使用 pre-commit
钩子¶
Paddle 开发人员使用 pre-commit 工具来管理 Git 预提交钩子。 它可以帮助我们格式化源代码(C++,Python),在提交(commit)前自动检查一些基本事宜(如每个文件只有一个 EOL,Git 中不要添加大文件等)。
pre-commit
测试是 CI 中单元测试的一部分,不满足钩子的 PR 不能被提交到 Paddle,Paddle使用的pre-commit是1.10.4版本。首先安装并在当前目录运行它:
➜ pip install pre-commit==1.10.4
➜ 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
。
开始开发¶
在本例中,我删除了 README.md 中的一行,并创建了一个新文件。
通过 git status
查看当前状态,这会提示当前目录的一些变化,同时也可以通过 git diff
查看文件具体被修改的内容。
➜ git status
On branch test
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)
modified: README.md
Untracked files:
(use "git add <file>..." to include in what will be committed)
test
no changes added to commit (use "git add" and/or "git commit -a")
单测¶
python/paddle/fluid/tests/unittests/
目录下新增的 test_*.py
单元测试会被自动加入工程进行编译。
注意事项:
运行单元测试测时需要编译整个工程,并且编译时需要打开
WITH_TESTING
。执行单测一定要用ctest命令,不可直接
python test_*.py
。
参考上述编译过程,编译成功后,在build
目录下执行下面的命令来运行单元测试:
执行:
ctest -R test_mul_op -V
提交(commit)¶
接下来我们取消对 README.md 文件的改变,然后提交新添加的 test 文件。
➜ git checkout -- README.md
➜ git status
On branch test
Untracked files:
(use "git add <file>..." to include in what will be committed)
test
nothing added to commit but untracked files present (use "git add" to track)
➜ git add test
Git 每次提交代码,都需要写提交说明,这可以让其他人知道这次提交做了哪些改变,这可以通过git commit
完成。
➜ git commit
CRLF end-lines remover...............................(no files to check)Skipped
yapf.................................................(no files to check)Skipped
Check for added large files..............................................Passed
Check for merge conflicts................................................Passed
Check for broken symlinks................................................Passed
Detect Private Key...................................(no files to check)Skipped
Fix End of Files.....................................(no files to check)Skipped
clang-formater.......................................(no files to check)Skipped
[my-cool-stuff c703c041] add test file
1 file changed, 0 insertions(+), 0 deletions(-)
create mode 100644 233
保持本地仓库最新¶
在准备发起 Pull Request 之前,需要同步原仓库(https://github.com/PaddlePaddle/Paddle)最新的代码。
首先通过 git remote
查看当前远程仓库的名字。
➜ git remote
origin
➜ git remote -v
origin https://github.com/USERNAME/Paddle (fetch)
origin https://github.com/USERNAME/Paddle (push)
这里 origin 是我们 clone 的远程仓库的名字,也就是自己用户名下的 Paddle,接下来我们创建一个原始 Paddle 仓库的远程主机,命名为 upstream。
➜ git remote add upstream https://github.com/PaddlePaddle/Paddle
➜ git remote
origin
upstream
获取 upstream 的最新代码并更新当前分支。
➜ git fetch upstream
➜ git pull upstream develop
Push 到远程仓库¶
将本地的修改推送到 GitHub 上,也就是 https://github.com/USERNAME/Paddle。
# 推送到远程仓库 origin 的 my-cool-stuff 分支上
➜ git push origin my-cool-stuff