add optional for param attr args, test=document_fix (#31105)

revert-31068-fix_conv3d_windows
Chen Weihang 4 years ago committed by GitHub
parent 1d996637e6
commit 2168f08ac8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -46,7 +46,7 @@ class ParamAttr(object):
initializer (Initializer, optional): The method to initial this parameter. Default initializer (Initializer, optional): The method to initial this parameter. Default
None, meaning that the weight parameter is initialized by Xavier initializer, None, meaning that the weight parameter is initialized by Xavier initializer,
and the bias parameter is initialized by 0. and the bias parameter is initialized by 0.
learning_rate (float): The parameter's learning rate. The learning rate when learning_rate (float, optional): The parameter's learning rate. The learning rate when
optimize is the global learning rates times the parameter's learning rate times optimize is the global learning rates times the parameter's learning rate times
the factor of learning rate scheduler. Default 1.0. the factor of learning rate scheduler. Default 1.0.
regularizer (WeightDecayRegularizer, optional): Regularization strategy. There are two method: regularizer (WeightDecayRegularizer, optional): Regularization strategy. There are two method:
@ -54,10 +54,13 @@ class ParamAttr(object):
regularizer is also set in ``optimizer`` (such as :ref:`api_paddle_optimizer_SGD` ), regularizer is also set in ``optimizer`` (such as :ref:`api_paddle_optimizer_SGD` ),
that regularizer setting in optimizer will be ignored. Default None, meaning there is that regularizer setting in optimizer will be ignored. Default None, meaning there is
no regularization. no regularization.
trainable (bool): Whether this parameter is trainable. Default True. trainable (bool, optional): Whether this parameter is trainable. Default True.
do_model_average (bool): Whether this parameter should do model average do_model_average (bool, optional): Whether this parameter should do model average
when model average is enabled. Only used in ExponentialMovingAverage. Default True. when model average is enabled. Only used in ExponentialMovingAverage. Default True.
need_clip (bool): Whether the parameter gradient need to be cliped in optimizer. Default is True. need_clip (bool, optional): Whether the parameter gradient need to be cliped in optimizer. Default is True.
Returns:
ParamAttr Object.
Examples: Examples:
.. code-block:: python .. code-block:: python

Loading…
Cancel
Save