Skip to content
This repository has been archived by the owner on Feb 13, 2024. It is now read-only.

Latest commit

 

History

History
167 lines (102 loc) · 7.24 KB

README.md

File metadata and controls

167 lines (102 loc) · 7.24 KB

PaddlePaddle API 翻译项目

欢迎来到PaddlePaddle API reference翻译项目!

简介

  • 背景

由于PaddlePaddle的中文用户占比较大,用户对中文API文档的需求比较强烈,因而计划将PaddlePaddle英文版API Reference翻译成简体中文

  • 翻译内容

PaddlePaddle 1.0版 API Reference

  • 任务量和时间节点

计划翻译API约301个(不包含“别名”API,例如这里)。本项目于11月1日启动,包括翻译、review、润色的时间,共计约6周,计划于12月15日前完成。

翻译步骤

  • 写在前面

为了节约reviewer的成本,请大家在自己本地修改好以后,几乎定稿以后再提交pr

  • 文件的命名和提交位置

在官网英文版文档中,左侧导航栏显示fluid,fluid.layers等,每一行代表一种分类,对应Github 源文件的一个文件,例如fluid.layers对应layers.rst

中文翻译稿的源文件也需要按照类似的方式命名,例如中文版layers,其在Fluiddoc/doc/fluid/api下的文件名应为:layers_cn.rst

请按照大类(请参考Fluiddoc/doc/fluid/api)下面英文版的分类方式,来创建对应的中文版文档

请使用标准rst语法进行翻译,这里以layers中的一个api为例: array_read

上述rst文档在官网渲染后显示效果如下:

翻译时请严格遵照中文技术文档写作规范,部分深度学习专业词汇应保留英文说法,例如:activation(激活函数)

在翻译时,如发现英文版API reference不易理解,请参考python源代码 来帮助理解

注意!!

为了保证从其他文档可以正确跳转到某个API Reference(效果请参考这里从API Guide文档到API Reference文档的跳转),在每一个api中文翻译前,请首先为此api添加关键字。

关键字的格式为 .. _cn_api_fluid_layers_array_read:,写法为:

“cn”+“api所属类别”+“api的名字”,请注意英文名前有一个 _ 结尾有一个 :,这里以layers中的array_read为例:

  • 需要翻译的API

    请根据拿到的Excel中所列的API名称,在API Reference中查看

  • 如何提交

    PaddlePaddle文档使用Github中的Fluiddoc来统一管理,您需要了解git的基本操作,并通过Pull Request的方式提交您的翻译稿。提交Pull Request可通过git工具或网页两种方法提交,下面分别简单介绍:

使用Git工具

  1. 首先请 fork FluidDoc仓库 并在本地 clone 你fork的FluidDoc
git clone https://github.com/<username>/FluidDoc.git

<username>是你的git用户名

  1. 关联远程仓库(原FluidDoc)
git remote add upstream https://github.com/PaddlePaddle/FluidDoc.git

完成后在终端输入 git remote -v 应该可以看到下列状态:

$ git remote -v
origin  https://github.com/xxxxx/FluidDoc.git (fetch)
origin  https://github.com/xxxxx/FluidDoc.git (push)
upstream        [email protected]:PaddlePaddle/FluidDoc.git (fetch)
upstream        [email protected]:PaddlePaddle/FluidDoc.git (push)
  1. 创建新分支
git checkout -b translation
  1. 每次修改前请确定当前分支与远端最新状态保持同步
git fetch
git pull upstream Translation-wh/hy/dh/hy(选择自己的分支)
  1. 在当前分支进行您的操作

  2. 完成后提交修改

//查看当前修改状态
git status

//将需要的修改添加到暂缓区
git add <file_name>

//提交commit
git commit -m "wirte your commit message"

//上传到远端
git push origin yourbranch:newbranch
  1. 上传成功后进入FluidDoc,可以在首页看到一个提交PR的提醒:

点击compare&pull request,将进入下图所示页面:

请确认提交到自己的分支上!!!

确认没问题,可以回到页面顶端,补充PR名与说明信息,点击create pull request。这样就建立了一个pr:

  1. 提交成功,请您将pr的链接告知我们。 后续如果有review意见,您将会通过在github里留的邮箱得到反馈,请根据review意见及时提交您的修改稿

  2. 当这个pr中的内容基本完成,希望开始新一篇文档的修改,请重新在fork的仓库内创建一个新的分支,在新分支下修改将不会影响到之前提交的pr。否则所有的修改都将包含在同一个PR中。

使用网页提交

请参考这个说明

Review流程简介

  • 背景

请在提交pr时添加Reviewer,由于API文档正确性非常重要,因此每一篇中文翻译稿都需要API代码作者Review通过后才可以Merge

  • 我的PR应该添加谁为Reviewer?我应该怎样做?

请参考这篇文档

FAQ

1. 觉得英文版的API文档写得不够完善,我应该怎样做?

本项目的目标在于英译汉API Reference,如果觉得英文版文档写得不够完善,影响您的翻译,请

第一步:查看python源代码 来帮助理解,并在此基础上进行翻译。

第二步:将觉得有问题的地方,提Issue在Paddle repo

更多地,如果想修改英文版API Reference,为Paddle贡献代码,请在Paddle Repo中提交Pull Request