Skip to content

Commit a78b760

Browse files
author
ranqiu
committed
Refine api_doc_std_cn
1 parent 686a3ad commit a78b760

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

doc/fluid/dev/api_doc_std_cn.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ API文档须包含以下几个模块(排列顺序为文档撰写顺序):
4040

4141
## 格式及示例
4242

43-
API文档各模块格式及示例如下(以下以fc为例进行说明):
43+
API文档须使用rst格式撰写,该格式详情请参考[链接](http://sphinx-doc-zh.readthedocs.io/en/latest/rest.html)。API文档各模块的内容格式及示例如下(以下以fc为例进行说明):
4444

4545
- Python API Definition
4646

@@ -137,7 +137,7 @@ API文档各模块格式及示例如下(以下以fc为例进行说明):
137137
138138
```
139139
Args:
140-
input (Tensor): The input tensor(s) of the layer.
140+
input (Variable|list of Variable): This layer's input tensor(s) which is at least 2-dimensional.
141141
param_attr (ParamAttr|list of ParamAttr, default None): The parameter attribute for learnable
142142
parameters/weights of this layer.
143143
name (str, default None): The name of this layer.
@@ -186,7 +186,7 @@ API文档各模块格式及示例如下(以下以fc为例进行说明):
186186
187187
- 示例
188188
189-
fc没有注意事项,故该模块省略不写。其他情况应明确给出,若有多条注意事项,须分条列出,以scaled\_dot\_product\_attention为例:
189+
fc没有注意事项,故该模块省略不写。如有注意事项应明确给出,当有多条注意事项,须分条列出,以scaled\_dot\_product\_attention为例:
190190
191191
```
192192
Note:
@@ -216,4 +216,4 @@ API文档各模块格式及示例如下(以下以fc为例进行说明):
216216
217217
## 完整示例
218218
219-
fc 的完整注释见[示例](https://github.com/PaddlePaddle/Paddle/tree/develop/doc/fluid/dev/src/fc.py)。
219+
fc 的完整注释见[示例](src/fc.py)。

doc/fluid/dev/src/fc.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ def fc(input,
4848
* :math:`Out`: The output tensor.
4949
5050
Args:
51-
input (Tensor|list of Tensor): The input tensor(s) to this layer.
52-
size(int): The number of output units in the fully connected layer.
51+
input (Variable|list of Variable): This layer's input tensor(s) which is at least 2-dimensional.
52+
size(int): The number of output units in this layer.
5353
num_flatten_dims (int, default 1): The fc layer can accept an input tensor with more than
5454
two dimensions. If this happens, the multidimensional tensor will first be flattened
5555
into a 2-dimensional matrix. The parameter `num_flatten_dims` determines how the input
@@ -62,7 +62,7 @@ def fc(input,
6262
param_attr (ParamAttr|list of ParamAttr, default None): The parameter attribute for learnable
6363
parameters/weights of this layer.
6464
bias_attr (ParamAttr|list of ParamAttr, default None): The parameter attribute for the bias
65-
parameter of this layer. If set None, no bias will be added to the output units.
65+
of this layer. If it is set to None, no bias will be added to the output units.
6666
act (str, default None): Activation to be applied to the output of this layer.
6767
name (str, default None): The name of this layer.
6868

0 commit comments

Comments
 (0)