paddlepaddle / docs Goto Github PK
View Code? Open in Web Editor NEWDocumentations for PaddlePaddle
Home Page: https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/index_cn.html
License: Apache License 2.0
Documentations for PaddlePaddle
Home Page: https://www.paddlepaddle.org.cn/documentation/docs/zh/guides/index_cn.html
License: Apache License 2.0
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“数学操作”的API Guide
题目:数学操作
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
这个文档里面的连接很多都失效了
https://github.com/PaddlePaddle/FluidDoc/blob/develop/doc/fluid/getstarted/Developer's_Guide_to_Paddle_Fluid.md
Feedback from @chengduoZH
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“评价指标”的API Guide
题目:数学操作
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“数据输入输出”的API Guide
题目:数据输入输出
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“激活函数”的API Guide
题目:激活函数
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
1.2新增的文档命名用户体验需要优化:
1)LoD-Tensor ---> LoDTensor使用指南
2)API Guide---->API使用指南
3)(API Guide中的)fluid.layers ---->神经网络层
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
https://github.com/PaddlePaddle/Paddle/blob/develop/python/paddle/fluid/layers/control_flow.py#L44
Now it is in the control_flow.py
, but it doesn't belong to any types of control flow.
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
有用户反馈:
“
http://www.paddlepaddle.org/documentation/docs/zh/1.1/advanced_usage/development/profiling/timeline_cn.html#
更新一下吧,多卡下 fluid.ExecutionStrategy() num_threads 不设成 1 会卡住”
请 @typhoonzero @gongweibao 看下,谢谢!
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“卷积”的API Guide
题目:卷积
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“损失函数”的API Guide
题目:损失函数
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“模型保存读取”的API Guide
题目:模型保存读取
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“数据预处理”的API Guide
题目:数据预处理
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
There is problem about the lod of the cases. The right case should be:
Which can be infer from:
https://github.com/PaddlePaddle/Paddle/blob/develop/paddle/fluid/operators/sequence_expand_op.cc#L122
暂拟定名字:High/Low-level API简介
提交位置:https://github.com/PaddlePaddle/FluidDoc/tree/develop/doc/fluid/api_guides ,需要再添加index.rst加toctree
未来如果api guide加新内容,再根据实际情况调整位置。
很多文档在官网能搜到、能打开,但打开以后发现这篇文档在左侧导航栏里找不到
这是因为:
看看能否放到其他位置
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
The high-level API for dist train has not been verified, we need to refine the document with low-level distribute training API.
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“预测引擎”的API Guide
题目:预测引擎
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api_guides/low_level/inference ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
红框处加下面这段话:
Op的输入和输出可分别通过ExecutionContext::Input()和ExecutionContext::Output()获得。注意:若op的输入/输出的变量类型是LoDTensor(fluid默认所有的Tensor默认都是LoDTensor类型),请写成ExecutionContext::Input()和ExecutionContext::Output(),不要写ExecutionContext::Input()和ExecutionContext::Output()。因为若实际的变量类型为SelectedRows,Input()和Output()方法会将SelectedRows类型特化为Tensor,导致潜在的错误。
上图红框处,加代码注释:never use Input or Output if you want a to get a LoDTensor.
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“序列”的API Guide
题目:序列
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
背景:
需补充一篇 RNN 的 api_guide,讨论此篇 guide 中应说明哪些API。
暂定相关API:
dynamicRNN、staticRNN、dynamic_lstm、dynamic_lstmp、dynamic_gru、gru_unit、beem_search_decode、lstm_unit、beam_search
如需调整,请老师指出。
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“控制流”的API Guide
题目:控制流
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“NN”的API Guide
题目:NN
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
API Guide可以理解为是API的使用指南,旨在向用户说明API的设计思路、使用方法等
撰写计划共计约45篇。其中在PaddlePaddle v1.1中,已上线14篇,例如官网-API-API使用指南-卷积
一篇完整的API Guide,需要包含以下几个内容:
1)对本篇主题的简介,例如:
卷积有两组输入:特征图和卷积核,依据输入特征和卷积核的形状、Layout不同、计算方式的不同,在Fluid里,有针对变长序列特征的一维卷积,有针对定长图像特征的二维(2D Conv)、三维卷积(3D Conv),同时也有卷积计算的逆向过程,下面先介绍Fluid里的2D/3D卷积,再来介绍序列卷积。
2)对主题下每个API的介绍,例如
这个layer以一个mini batch的序列为输入,在每个序列内做softmax操作。其输出为一个mini batch相同shape的序列,但在序列内是经softmax归一化过的。 这个layer往往用于在每个sequence内做softmax归一化。 API Reference 请参考 sequence_softmax
完整例子:
1.1已上线的API Guide
文档题目:请见标题
语言:汉语
格式:rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
字数:不限
效果预览:
为提高Review效率,请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,不预览的pr不能合入
预览工具的使用方法请见这里
请注意:FluidDoc Repo的文档是通过Sphinx工具显示在官网上的。在Sphinx中,通过名为index.rst(或index_cn.rst等类似名称)的文件中的toctree来决定每一级显示哪几篇文档,在预览时,为了让文档能够正确预览,需要修改index,例如,如果新增一篇layers的API Guide,则需要修改doc/fluid/api/api_guides/low_level/layers/index.rst
这里的文件,并将自己文档的名字加入到index,如下图:
但在提交pr前,请不要git add 对index的修改,以避免多人同时修改这个文件引发conflict
提交分支:develop
提交位置:提交位置在FluidDoc/doc/fluid/api/api_guides/low_level
注:
layers文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/layers
多机文档,请提交到FluidDoc/doc/fluid/api/api_guides/low_level/cluster
pr提交截止日期:请见标题
merge截止时间:请见标题
需要特别注意的格式问题
在一篇API Guide中,需要给出链接跳转至API Reference,例如:
请注意:这里的超链接是用内链写成的,这样做的好处是,当某个API Reference的位置发生变化时,无需专门在文档里改超链接的路径,依然可以正确跳转。
用内链引用API Reference的方法: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。
您可以选择以下两种方式展示预览效果:贴图或者给出预览网址,以方便我们检查格式
在预览工具时,需要修改index以确保文档可以显示在预览工具中,但在提交pr时,请去掉对index的修改,只提交您新写的文档,这是为了避免多人同时修改index文件引发conflict
为了提高Review效率,请在PR提交时增加Reviewer:一个PR的Reviewer由Peer Reviewer+ RD Reviewer+PM Reviewer组成,分别负责检查技术、格式的问题
Peer Reviewer :1名,请找同方向的同学,例如NLP相关API请加kuke
RD Reviewer:luotao1
PM Reviewer:tink2123
为了方便管理API Guide进度,请在PR提交时增加Label API Guide
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“图像检测”的API Guide
题目:图像检测
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
背景:API Guide,向用户说明API的设计思路、使用方法等,内外部需求强烈。现收集到需求,第一版计划撰写37篇。第一版完整计划请见这里。
1.1版写哪些:计划1.1版新增14篇,包括layers13篇和预测引擎1篇。
任务说明:请参考API Guide-Executor ,写“池化”的API Guide
题目:池化
字数:不限,能说明白问题即可
pr提交截止日期:10月22日
merge截止时间:10月29日
提交位置:请先在本地预览,确认格式正确再提交pr,请将预览效果截图贴在pr中,提交位置在FluidDoc/doc/fluid/api/api_guides/low_level/layers ,不预览的pr不能合入。
提交分支:develop
语言:用汉语,rst格式(因官网对rst格式支持较好,推荐用rst格式,如不了解rst,请在这里学习)
引用 reference: 以 :ref:<api_name>
的格式引用reference(而不是其他格式:例如超链接、xxx
等),api_name
需与对应rst文件中的名字一致。参考示例:https://raw.githubusercontent.com/PaddlePaddle/FluidDoc/develop_doc/doc/fluid/api_guides/low_level/optimizer/optimizer_all.rst
reviewer:tink2123 luotao1 qingqing01 (图像相关) kuke (NLP相关)
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.