# 在GitHub上贡献模型代码


飞桨非常欢迎大家在开源生态GitHub中贡献代码，与大量开发者分享深度学习项目的成功应用和您的奇思妙想。在飞桨生态中的研发者们大都具备“人人为我，我为人人”的精神，在从生态中获得大量现成模型用于业务应用的同时，也有很多开发者将自己研发的或特殊优化过的模型放到飞桨的模型库中，与其它开发者分享自己的工作成果。

下面以`PaddlePaddle/models` repo为例（读者研发了新模型，想分享给飞桨生态中的其它开发者），详细介绍在GitHub上提交代码的操作方法，流程如下图所示。

![image](https://developer.qcloudimg.com/http-save/yehe-1476826/0024cf634e6d2af3b100c5ed7b730180.jpg)

图2：GitHub贡献代码


----

**说明：**

在执行如下操作前，请确保本地已经安装GIT，下载路径：https://git-scm.com/download/win，选择与PC系统对应的版本。


----

## 创建本地GitHub环境


----

**说明：**

如果您首次使用飞桨GitHub，需要先创建飞桨本地GitHub环境。如果您已经创建了飞桨本地GitHub，此步骤可忽略。


----


1. Fork仓库


登录[飞桨GitHub](https://github.com/PaddlePaddle/models)首页，单击 `Fork`，生成自己目录下的仓库，如 https://github.com/USERNAME/models 。


1. Clone远程仓库到本地


任意选择一个本地目录，将远程仓库`clone`到本地，命令如下：

```
➜  git clone https://github.com/USERNAME/models
➜  cd Paddle
```

1. 创建本地分支


飞桨使用[Git流分支模型](http://nvie.com/posts/a-successful-git-branching-model/)进行开发、测试、发布和维护，特性开发和问题修复都要求在一个新的分支上完成。代码如下：

在 `develop` 分支上，使用 `git checkout -b new_branch_name` 创建并切换到新分支，如下所示。

```
➜  git checkout -b my-cool-stuff
```


----

**说明：**

在 `checkout` 之前，需要保持当前分支目录 `clean`，否则会把 `untracked` 的文件也带到新分支上，可以通过 `git status` 查看。


----


1. 安装代码格式化插件


飞桨使用 [pre-commit](http://pre-commit.com/) 管理 Git 预提交钩子，格式化源代码（C++，Python），在`commit`前自动检查代码基础质量的满足度（如每个文件只有一个 EOL，Git 中不允许添加大文件等）。

`pre-commit`测试是 Travis-CI 中单元测试的一部分，不满足钩子的 PR 不允许提交到飞桨。请在当前目录运行如下代码：

```
➜  pip install pre-commit
➜  pre-commit install
```


----

说明：


1. 飞桨使用 `clang-format` 参数调整 C/C++ 源代码格式，请确保 `clang-format` 版本在 3.8 以上。

2. 通过`pip install pre-commit`和`conda install -c conda-forge pre-commit`安装的`yapf`稍有不同。建议使用`pip install pre-commit`。


----

## 更新本地仓库


----

**说明：**

如果您是首次创建本地GitHub环境，代码已经和原仓库代码同步，此步骤可忽略。


----

同步[原仓库](https://github.com/PaddlePaddle/models)代码如下：


1. 通过 `git remote` 查看当前远程仓库的名字。


```
➜  git remote
origin
➜  git remote -v
origin	https://github.com/USERNAME/models (fetch)
origin	https://github.com/USERNAME/models (push)
```
这里 origin 是 clone 的远程仓库的名字，也就是自己用户名下的 PaddlePaddle。


1. 创建一个原始 PaddlePaddle 仓库的远程主机，命名为 upstream。


```
➜  git remote add upstream https://github.com/PaddlePaddle/models
➜  git remote
origin
upstream
```

1. 获取 upstream 的最新代码并更新当前分支。


```
➜  git fetch upstream
➜  git pull upstream develop
```
## 开始开发


在本例中，删除了 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)

	test21	···						

no changes added to commit (use "git add" and/or "git commit -a")
```
## 代码提交


### 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
```
需要注意的是：您需要在commit中添加说明（commit message）以触发CI单测，写法如下：

```
# 触发develop分支的CI单测
➜  git commit -m "test=develop"
```
### Push代码到远程仓库


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

```
# 推送到远程仓库 origin 的 my-cool-stuff 分支上
➜  git push origin my-cool-stuff
```
### 完成Pull Request


此时，可以去 https://github.com/USERNAME/models 下查看，会发现`my-cool-stuff` 分支，切换到所建分支，单击 `New pull request`，如下图所示。

![image](https://developer.qcloudimg.com/http-save/yehe-1476826/bd1b008239195529c93fb0a177dff3b8.png) 
选择`目标分支`，如下图所示。

![image](https://developer.qcloudimg.com/http-save/yehe-1476826/bb456be84bb2dbd6cd2db0959bf78114.png) 


----

**说明：**

可以在**PR描述**中标识PR的功能，接下来等待 review。如果有需要修改的地方，参照上述步骤更新origin中的对应分支即可。


----

#### **签署CLA**


首次向飞桨GitHhub提交Pull Request时，需要签署CLA(Contributor License Agreement)协议，以保证您的代码可以正常合入，操作方式如下：


- 查看PR中的 **Check** 部分，选择 **license/cla** ，单击`detail`，进入CLA网站，如下图所示。


![image](https://developer.qcloudimg.com/http-save/yehe-1476826/a17ede3abae5f436a69dee50f713e400.png) 


- 点击CLA网站中的 `Sign in with GitHub to agree` ，完成后跳转到 **Pull Request** 页面，如下图所示。


![image](https://developer.qcloudimg.com/http-save/yehe-1476826/08bfab500f3c58d9bb27056508cb5f1e.jpg) 


## CI测试


在Pull Request中每提交一次新的commit，都会触发CI单元测试，请确保commit message中已加入必要的修改说明。


----

**注意：**

Pull Request中的CI单元测试进程会持续几个小时，请您及时关注。当测试结果都出现了绿色的对勾，表示您本次的commit通过了CI单元测试。


----

## 后续处理


### 代码审查(Code Review)


提交PR后，开发人员会进行代码审查，如果提出修改意见，需要相应的进行确认或修改，再次提交代码。一旦code review通过，PR会被开发人员合入仓库。

### 删除远程分支


在 PR 被 merge 进主仓库后，我们可以在 PR 的页面删除远程仓库的分支。也可以使用 `git push origin :分支名` 删除远程分支，如：

```
➜  git push origin :my-cool-stuff
```
### 删除本地分支


最后，删除本地分支。

```
# 切换到 develop 分支
➜  git checkout develop

# 删除 my-cool-stuff 分支
➜  git branch -D my-cool-stuff
```
## 注意模型文件组织和代码/文档的规范


为了使其他开发者便捷的使用模型，提交的模型最好遵守官方模型的研发规范。这样会给其他开发者一致的使用体验，也会使他们更快的掌握大家贡献的模型。
官方研发规范：在文件组织、代码编写、文档编写等方面的要求，具体可参考[官方模型库开发及API使用规范](https://github.com/PaddlePaddle/book/tree/develop/0.coding_guideline)。

![image](https://developer.qcloudimg.com/http-save/yehe-1476826/12602e761afc91dbb7efb8d500422d6c.jpg)

学习完本章内容，您已经可以轻松实现在飞桨GitHub贡献代码了。赶快动手实践一下，把自己编写的创新模型分享给其他深度学习的小伙伴吧！

飞桨非常欢迎大家在开源生态GitHub中贡献代码，与大量开发者分享深度学习项目的成功应用和您的奇思妙想。在飞桨生态中的研发者们大都具备“人人为我，我为人人”的精神，在从生态中获得大量现成模型用于业务应用的同时，也有很多开发者将自己研发的或特殊优化过的模型放到飞桨的模型库中，与其它开发者分享自己的工作成果。

在GitHub上贡献模型代码

前端开发工程

前端

学习如何在GitHub上为飞桨(PaddlePaddle)贡献深度学习模型代码，包括Fork仓库、创建分支、代码格式化、提交PR等完整流程。掌握开源协作规范，分享您的AI创新成果，共建深度学习生态。

深度学习

单元测试

Python

GitHub

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

在GitHub上贡献模型代码-腾讯云开发者社区-腾讯云

在GitHub上贡献模型代码

在GitHub上贡献模型代码

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐