File tree Expand file tree Collapse file tree 2 files changed +7
-7
lines changed Expand file tree Collapse file tree 2 files changed +7
-7
lines changed Original file line number Diff line number Diff line change @@ -40,7 +40,7 @@ API文档须包含以下几个模块(排列顺序为文档撰写顺序):
40
40
41
41
## 格式及示例
42
42
43
- API文档各模块格式及示例如下( 以下以fc为例进行说明):
43
+ API文档须使用rst格式撰写,该格式详情请参考 [ 链接 ] ( http://sphinx-doc-zh.readthedocs.io/en/latest/rest.html ) 。API文档各模块的内容格式及示例如下( 以下以fc为例进行说明):
44
44
45
45
- Python API Definition
46
46
@@ -137,7 +137,7 @@ API文档各模块格式及示例如下(以下以fc为例进行说明):
137
137
138
138
```
139
139
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 .
141
141
param_attr (ParamAttr|list of ParamAttr, default None): The parameter attribute for learnable
142
142
parameters/weights of this layer.
143
143
name (str, default None): The name of this layer.
@@ -186,7 +186,7 @@ API文档各模块格式及示例如下(以下以fc为例进行说明):
186
186
187
187
- 示例
188
188
189
- fc没有注意事项,故该模块省略不写。其他情况应明确给出,若有多条注意事项 ,须分条列出,以scaled\_dot\_product\_attention为例:
189
+ fc没有注意事项,故该模块省略不写。如有注意事项应明确给出,当有多条注意事项 ,须分条列出,以scaled\_dot\_product\_attention为例:
190
190
191
191
```
192
192
Note:
@@ -216,4 +216,4 @@ API文档各模块格式及示例如下(以下以fc为例进行说明):
216
216
217
217
## 完整示例
218
218
219
- fc 的完整注释见[示例](https://github.com/PaddlePaddle/Paddle/tree/develop/doc/fluid/dev/ src/fc.py)。
219
+ fc 的完整注释见[示例](src/fc.py)。
Original file line number Diff line number Diff line change @@ -48,8 +48,8 @@ def fc(input,
48
48
* :math:`Out`: The output tensor.
49
49
50
50
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.
53
53
num_flatten_dims (int, default 1): The fc layer can accept an input tensor with more than
54
54
two dimensions. If this happens, the multidimensional tensor will first be flattened
55
55
into a 2-dimensional matrix. The parameter `num_flatten_dims` determines how the input
@@ -62,7 +62,7 @@ def fc(input,
62
62
param_attr (ParamAttr|list of ParamAttr, default None): The parameter attribute for learnable
63
63
parameters/weights of this layer.
64
64
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.
66
66
act (str, default None): Activation to be applied to the output of this layer.
67
67
name (str, default None): The name of this layer.
68
68
You can’t perform that action at this time.
0 commit comments