New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

modify doc for paddle.nn.Layer #27624

Merged

phlrain merged 10 commits into PaddlePaddle:develop from wanghuancoder:develop_Layer_doc

Oct 8, 2020

Contributor

wanghuancoder commented Sep 27, 2020 •

edited

Loading

PR types

Others

PR changes

Docs

Describe

根据2.0API要求，修改paddle.nn.Layer代码示例
为没有代码示例的函数添加代码示例。forward、backward无实际意义，没有添加代码示例
将构造函数中dtype的默认值改成”float32“

预览图:


          modify doc for Layer, test=develop

b18dbc6

paddle-bot-old bot commented Sep 27, 2020

Thanks for your contribution!
Please wait for the result of CI firstly. See Paddle CI Manual for details.

wanghuancoder added 4 commits

September 27, 2020 12:11


          modify doc for Layer2, test=develop

01c30a2


          set dtype default value to float32, test=develop

6ef6898


          add example code for paddle.nn.Layer, test=develop

28bb9c2


          set create_parameter and create_variable dtype default value to None,…

aed94a4

… test=develop

phlrain reviewed

View reviewed changes

python/paddle/fluid/dygraph/layers.py

@@ @@ -62,10 +62,6 @@ def remove(self): @@
               class Layer(core.Layer):
                   """
-                  :alias_main: paddle.nn.Layer

Collaborator

phlrain Sep 29, 2020

为啥要移除这个alias

Contributor Author

wanghuancoder Sep 29, 2020

这个是2.0API文档中要求的。说会有自动生成工具。这里让删掉。

python/paddle/fluid/dygraph/layers.py Outdated

-                                  print(layer_list)
+                              layer_list = list(model.children())
+                              print(layer_list)

Collaborator

phlrain Sep 29, 2020

最好有一个注释的说明

Contributor Author

wanghuancoder Sep 29, 2020

done,thx!

python/paddle/fluid/dygraph/layers.py Outdated

-                                  model = fluid.dygraph.Sequential(fc1, fc2)
-                                  layer_list = list(model.children())
+                              fc1 = paddle.nn.Linear(10, 3)

Collaborator

phlrain Sep 29, 2020

变量名称最好叫 linear1 毕竟后面的类名是Linear

Contributor Author

wanghuancoder Sep 29, 2020

done,thx!

python/paddle/fluid/dygraph/layers.py Outdated

+                                          'alpha': 1,
+                                      }
+                                      tmp = self.create_variable(name = "linear_tmp_0", dtype=self._dtype)
+                                      paddle.fluid.default_main_program().current_block().append_op(

Collaborator

phlrain Sep 29, 2020

示例中不要使用append op，对于普通用户来说，他们不需要了解这种用法

Contributor Author

wanghuancoder Sep 29, 2020

已整体修改示例。

python/paddle/fluid/dygraph/layers.py Outdated

+                                      self.weight = self.create_parameter(
+                                          shape=[in_features, out_features],
+                                          is_bias=False)
+                                      self.bias = self.create_parameter(

Collaborator

phlrain Sep 29, 2020

forward中没有使用 bias，bias 可以不写

Contributor Author

wanghuancoder Sep 29, 2020

已整体修改示例。

python/paddle/fluid/dygraph/layers.py


		Example::
		.. code-block:: python

Collaborator

phlrain Sep 29, 2020

这个train 可以和下面的eval用同样的MyLayer

Contributor Author

wanghuancoder Sep 29, 2020

done,thx!

python/paddle/fluid/dygraph/layers.py Outdated

+                                      inputs = {'X': [input], 'Y': [self.weight]}
+                                      attrs = {
+                                          'transpose_X': False,
+                                          'transpose_Y': False,

Collaborator

phlrain Sep 29, 2020

这个forward里面可以直接写 paddle.matmul( input, self.self.weight), 不用append op

Contributor Author

wanghuancoder Sep 29, 2020

已整体修改示例。

python/paddle/fluid/dygraph/layers.py Outdated


		import paddle

		linear = paddle.nn.Linear(1, 1)

Collaborator

phlrain Sep 29, 2020

这个 add_parameter 建议卸载一个class里面，不建议直接放在class 外面用

Contributor Author

wanghuancoder Sep 29, 2020

done,thx!

python/paddle/fluid/dygraph/layers.py Outdated

    
                                  state_dict = emb.state_dict()

                                  fluid.save_dygraph( state_dict, "paddle_dy")

                              state_dict = emb.state_dict()

                              paddle.save( state_dict, "paddle_dy")

Collaborator

phlrain Sep 29, 2020

"paddle_dy" 建议改成 "paddle_dy.pdparams"

Contributor Author

wanghuancoder Sep 29, 2020

done,thx!

wanghuancoder added 2 commits

September 29, 2020 05:17


          modify some example code, tet=develop

e65903f


          refine, test=develop

97df129

phlrain reviewed

View reviewed changes

python/paddle/fluid/dygraph/layers.py Outdated

+                                  def forward(self, input):
+                                      return self._linear(input)
+                              x = paddle.randn([10, 1], 'float32')

Collaborator

phlrain Sep 29, 2020

这行好像没有用

Contributor Author

wanghuancoder Sep 29, 2020

done,thx!


          del no ues code, test=develop

5c927f3

XiaoguangHu01 previously approved these changes

View reviewed changes

Contributor

XiaoguangHu01 left a comment

LGTM

lanxianghit previously approved these changes

View reviewed changes

jzhang533 reviewed

View reviewed changes

python/paddle/fluid/dygraph/layers.py

@@ @@ -77,13 +73,13 @@ class Layer(core.Layer): @@
                       dtype(str or core.VarDesc.VarType, optional): data type of this parameter.
                               If set str, it can be "bool",  "float16", "float32", "float64",
                               "int8", "int16", "int32", "int64", "uint8" or "uint16".
-                              Default: ``core.VarDesc.VarType.FP32``
+                              Default: "float32"

Contributor

jzhang533 Sep 30, 2020

73 行，不需要暴露core.VarDesc.Vartype给用户。

Contributor Author

wanghuancoder Sep 30, 2020

done,thx！

python/paddle/fluid/dygraph/layers.py


		paddle.disable_static()

Contributor

jzhang533 Sep 30, 2020

201行
用paddle.full

Contributor Author

wanghuancoder Sep 30, 2020

done,thx！

python/paddle/fluid/dygraph/layers.py

		@@ -305,6 +361,26 @@ def create_parameter(self,

		Returns:
		:ref:`api_guide_Variable_en` : created parameter.

Contributor

jzhang533 Sep 30, 2020

353行：:ref:api_fluid_ParamAttr 现在是:ref:api_paddle_ParamAttr
354行： core.VarDesc.VarType 不需要暴露， str写了两次
359行：:ref:api_fluid_initializer_XavierInitializer and :ref:api_fluid_initializer_ConstantInitializer 更新成paddle.nn.initializer下的API

Contributor Author

wanghuancoder Sep 30, 2020

done,thx！

python/paddle/fluid/dygraph/layers.py Outdated

		@@ -326,11 +402,32 @@ def create_variable(self,
		dtype(str or core.VarDesc.VarType, optional): data type of this parameter.

Contributor

jzhang533 Sep 30, 2020

core.VarDesc.VarType不暴露给用户

Contributor Author

wanghuancoder Sep 30, 2020

done,thx！

python/paddle/fluid/dygraph/layers.py Outdated

@@ @@ -326,11 +402,32 @@ def create_variable(self, @@
                           dtype(str or core.VarDesc.VarType, optional): data type of this parameter.
                               If set str, it can be "bool",  "float16", "float32", "float64",
                               "int8", "int16", "int32", "int64", "uint8" or "uint16".
-                              If set None, it will be ``core.VarDesc.VarType.FP32``. Default: None
+                              If set None, it will be "float32". Default: None
                           type(core.VarDesc.VarType, optional): type of the variable. No need to set this parameter. Default: ``core.VarDesc.VarType.LOD_TENSOR``

Contributor

jzhang533 Sep 30, 2020

这个参数可以直接从参数列表中去掉吧？
2.0里暂时没有LODTensor

Contributor Author

wanghuancoder Sep 30, 2020

done.和红雨商议后，将接口部分的改参数做了删除

python/paddle/fluid/dygraph/layers.py Outdated

		@@ -349,6 +446,15 @@ def parameters(self, include_sublayers=True):

		Returns:
		list of :ref:`api_guide_Variable_en` : a list of Parameters.

Contributor

jzhang533 Sep 30, 2020

list of :ref:api_guide_Variable_en :
这个建议先删掉。

Contributor Author

wanghuancoder Sep 30, 2020

done,thx！

python/paddle/fluid/dygraph/layers.py

                           .. code-block:: python
                               import numpy as np
-                              import paddle.fluid as fluid
+                              import paddle

Contributor

jzhang533 Sep 30, 2020

641行，应该是non-trainable parameters?

Contributor Author

wanghuancoder Sep 30, 2020

done。同时将所有Variable改成Tensor

python/paddle/fluid/dygraph/layers.py Outdated

		@@ -585,6 +708,20 @@ def buffers(self, include_sublayers=True):

		Returns:
		list of :ref:`api_guide_Variable_en` : a list of buffers.

Contributor

jzhang533 Sep 30, 2020

list of :ref:api_guide_Variable_en : 建议去掉

Contributor Author

wanghuancoder Sep 30, 2020

done,thx！

python/paddle/fluid/dygraph/layers.py

                           .. code-block:: python
                               import numpy as np
-                              import paddle.fluid as fluid
+                              import paddle

Contributor

jzhang533 Sep 30, 2020

named_buffer这个API文档里的variable，应该称为tensor 还是 buffer？variable有些不合适。

Contributor Author

wanghuancoder Sep 30, 2020

done。已将所有Variable改成Tensor

python/paddle/fluid/dygraph/layers.py Outdated

+                                                          parameters=linear.parameters())
+                              out = linear(a)
+                              out.backward()
+                              adam.minimize(out)

Contributor

jzhang533 Sep 30, 2020

现在推荐用adam.step()

Contributor Author

wanghuancoder Sep 30, 2020

done,thx！


          modify doc, example code, args, test=develop

c80b84a

wanghuancoder dismissed stale reviews from lanxianghit and XiaoguangHu01 via

c80b84a

September 30, 2020 03:21

jzhang533 reviewed

View reviewed changes

python/paddle/fluid/dygraph/layers.py Outdated

@@ @@ -198,7 +198,7 @@ def apply(self, fn): @@
                             def init_weights(layer):
                                 if type(layer) == nn.Linear:
                                     print('before init weight:', layer.weight.numpy())
-                                    new_weight = paddle.fill_constant(layer.weight.shape, layer.weight.dtype, value=0.9)
+                                    new_weight = paddle.fill(layer.weight.shape, layer.weight.dtype, value=0.9)

Contributor

jzhang533 Sep 30, 2020

paddle里只有paddle.full没有paddle.fill

Contributor Author

wanghuancoder Sep 30, 2020

抱歉，已修改

python/paddle/fluid/dygraph/layers.py Outdated

    
                              If set str, it can be "bool",  "float16", "float32", "float64",

                              "int8", "int16", "int32", "int64", "uint8" or "uint16". Default: "float32".

                          is_bias(bool, optional): if this is a bias parameter. Default: False.

                          default_initializer(Initializer, optional): the default initializer for this parameter.

                              If set None, default initializer will be set to :ref:`api_fluid_initializer_XavierInitializer` and :ref:`api_fluid_initializer_ConstantInitializer`

                              If set None, default initializer will be set to :ref:`_api_paddle_fluid_initializer_Xavier` and :ref:`_api_paddle_fluid_initializer_Constant`

Contributor

jzhang533 Sep 30, 2020

没改对啊。

Contributor Author

wanghuancoder Sep 30, 2020

经沟通，暂时使用
paddle.nn.initializer.Constant
paddle.nn.initializer.Xavier


          modify doc, test=develop

c95819c

jzhang533 approved these changes

View reviewed changes

Contributor

jzhang533 left a comment

lgtm

wanghuancoder requested review from phlrain, lanxianghit and XiaoguangHu01

September 30, 2020 07:48

lanxianghit approved these changes

View reviewed changes

XiaoguangHu01 approved these changes

View reviewed changes

Contributor

XiaoguangHu01 left a comment

LGTM

phlrain approved these changes

View reviewed changes

phlrain merged commit 7698e19 into PaddlePaddle:develop

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet