Optimizer

class paddle.optimizer. Optimizer ( learning_rate, parameters=None, weight_decay=None, grad_clip=None, name=None )

优化器的基类。

参数

  • learning_rate (float|_LRSeduler) - 学习率,用于参数更新的计算。可以是一个浮点型值或者一个_LRScheduler 类,默认值为 0.001。

  • parameters (list|tuple,可选) - 指定优化器需要优化的参数。在动态图模式下必须提供该参数;在静态图模式下默认值为 None,这时所有的参数都将被优化。

  • weight_decay (float|WeightDecayRegularizer,可选) - 正则化方法。可以是 float 类型的 L2 正则化系数或者正则化策略:L1DecayL2Decay。如果一个参数已经在 ParamAttr 中设置了正则化,这里的正则化设置将被忽略; 如果没有在 ParamAttr 中设置正则化,这里的设置才会生效。默认值为 None,表示没有正则化。

  • grad_clip (GradientClipBase,可选) – 梯度裁剪的策略,支持三种裁剪策略:paddle.nn.ClipGradByGlobalNormpaddle.nn.ClipGradByNormpaddle.nn.ClipGradByValue 。 默认值为 None,此时将不进行梯度裁剪。

  • name (str,可选) - 具体用法请参见 Name,一般无需设置,默认值为 None。

代码示例

COPY-FROM: paddle.optimizer.Optimizer

方法

step()

注解

该 API 只在 Dygraph 模式下生效。

执行一次优化器并进行参数更新。

返回

无。

代码示例

COPY-FROM: paddle.optimizer.Optimizer.step

minimize(loss, startup_program=None, parameters=None, no_grad_set=None)

为网络添加反向计算过程,并根据反向计算所得的梯度,更新 parameters 中的 Parameters,最小化网络损失值 loss。

参数

  • loss (Tensor) - 需要最小化的损失值变量。

  • startup_program (Program,可选) - 用于初始化 parameters 中参数的 Program,默认值为 None,此时将使用 default_startup_program

  • parameters (list,可选) - 待更新的 Parameter 或者 Parameter.name 组成的列表,默认值为 None,此时将更新所有的 Parameter。

  • no_grad_set (set,可选) - 不需要更新的 Parameter 或者 Parameter.name 组成的集合,默认值为 None。

返回

tuple(optimize_ops, params_grads),其中 optimize_ops 为参数优化 OP 列表;param_grads 为由(param, param_grad)组成的列表,其中 param 和 param_grad 分别为参数和参数的梯度。在静态图模式下,该返回值可以加入到 Executor.run() 接口的 fetch_list 参数中,若加入,则会重写 use_prune 参数为 True,并根据 feedfetch_list 进行剪枝,详见 Executor 的文档。

代码示例

COPY-FROM: paddle.optimizer.Optimizer.minimize

clear_grad()

注解

该 API 只在 Dygraph 模式下生效。

清除需要优化的参数的梯度。

代码示例

COPY-FROM: paddle.optimizer.Optimizer.clear_grad

set_lr(value)

注解

该 API 只在 Dygraph 模式下生效。

手动设置当前 optimizer 的学习率。当使用_LRScheduler 时,无法使用该 API 手动设置学习率,因为这将导致冲突。

参数

value (float) - 需要设置的学习率的值。

返回

无。

代码示例

COPY-FROM: paddle.optimizer.Optimizer.set_lr

set_lr_scheduler(scheduler)

注解

该 API 只在 Dygraph 模式下生效。

手动设置当前 optimizer 的学习率为 LRScheduler 类。

参数

scheduler (LRScheduler) - 需要设置的学习率的 LRScheduler 类。

返回

无。

代码示例

COPY-FROM: paddle.optimizer.Optimizer.set_lr_scheduler

get_lr()

注解

该 API 只在 Dygraph 模式下生效。

获取当前步骤的学习率。当不使用_LRScheduler 时,每次调用的返回值都相同,否则返回当前步骤的学习率。

返回

float,当前步骤的学习率。

代码示例

COPY-FROM: paddle.optimizer.Optimizer.get_lr