Skip to content

Commit 6db3d94

Browse files
author
betterpig
committed
improve introduction of bfgs args.
1 parent 9e8b71c commit 6db3d94

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/api/paddle/incubate/optimizer/functional/minimize_bfgs_cn.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ minimize_bfgs
2121

2222
参数
2323
:::::::::
24-
- **objective_func** - 待优化的目标函数. 接受多元输入并返回一个标量
25-
- **initial_position** (Tensor) - 迭代的初始位置。
24+
- **objective_func** (callable) - 待优化的目标函数,接受1维 Tensor 并返回一个标量
25+
- **initial_position** (Tensor) - 迭代的初始位置,与 ``objective_func`` 的输入形状相同
2626
- **max_iters** (int,可选) - BFGS迭代的最大次数。默认值:50。
2727
- **tolerance_grad** (float,可选) - 当梯度的范数小于该值时,终止迭代。当前使用正无穷范数。默认值:1e-7。
2828
- **tolerance_change** (float,可选) - 当函数值/x值/其他参数 两次迭代的改变量小于该值时,终止迭代。默认值:1e-9。
29-
- **initial_inverse_hessian_estimate** (Tensor,可选) - 函数在初始位置时的近似逆海森矩阵,必须满足对称性和正定性。默认值:None。
29+
- **initial_inverse_hessian_estimate** (Tensor,可选) - 函数在初始位置时的近似逆海森矩阵,必须满足对称性和正定性。当为None时,将使用N阶单位矩阵,其中N为 ``initial_position`` 的size。默认值:None。
3030
- **line_search_fn** (str,可选) - 指定要使用的线搜索方法,目前只支持值为'strong wolfe'方法,未来将支持'Hager Zhang'方法。默认值:'strong wolfe'。
3131
- **max_line_search_iters** (int,可选) - 线搜索的最大迭代次数。默认值:50。
3232
- **initial_step_length** (float,可选) - 线搜索中第一次迭代时的步长,不同的初始步长可能会产生不同的优化结果。对于高斯牛顿类方法初始的试验步长应该总是1。默认值:1.0。
33-
- **dtype** ('float32' | 'float64',可选) - 在算法中使用的数据类型。默认值:'float32'。
33+
- **dtype** ('float32' | 'float64',可选) - 在算法中使用的数据类型,输入参数的数据类型必须与dtype保持一致。默认值:'float32'。
3434
- **name** (str,可选) - 操作名称。 更多信息请参考 :ref:`api_guide_Name`。默认值:None。
3535

3636
返回

docs/api/paddle/incubate/optimizer/functional/minimize_lbfgs_cn.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ minimize_lbfgs
1919

2020
参数
2121
:::::::::
22-
- **objective_func** - 待优化的目标函数. 接受多元输入并返回一个标量
23-
- **initial_position** (Tensor) - 迭代的初始位置。
22+
- **objective_func** (callable) - 待优化的目标函数,接受1维 Tensor 并返回一个标量
23+
- **initial_position** (Tensor) - 迭代的初始位置,与 ``objective_func`` 的输入形状相同
2424
- **history_size** (Scalar,可选) - 指定储存的向量对{si,yi}数量。默认值:100。
2525
- **max_iters** (int,可选) - BFGS迭代的最大次数。默认值:50。
2626
- **tolerance_grad** (float,可选) - 当梯度的范数小于该值时,终止迭代。当前使用正无穷范数。默认值:1e-7。
2727
- **tolerance_change** (float,可选) - 当函数值/x值/其他参数 两次迭代的改变量小于该值时,终止迭代。默认值:1e-9。
28-
- **initial_inverse_hessian_estimate** (Tensor,可选) - 函数在初始位置时的近似逆海森矩阵,必须满足对称性和正定性。默认值:None。
28+
- **initial_inverse_hessian_estimate** (Tensor,可选) - 函数在初始位置时的近似逆海森矩阵,必须满足对称性和正定性。当为None时,将使用N阶单位矩阵,其中N为 ``initial_position`` 的size。默认值:None。
2929
- **line_search_fn** (str,可选) - 指定要使用的线搜索方法,目前只支持值为'strong wolfe'方法,未来将支持'Hager Zhang'方法。默认值:'strong wolfe'。
3030
- **max_line_search_iters** (int,可选) - 线搜索的最大迭代次数。默认值:50。
3131
- **initial_step_length** (float,可选) - 线搜索中第一次迭代时的步长,不同的初始步长可能会产生不同的优化结果。对于高斯牛顿类方法初始的试验步长应该总是1。默认值:1.0。
32-
- **dtype** ('float32' | 'float64',可选) - 在算法中使用的数据类型。默认值:'float32'。
32+
- **dtype** ('float32' | 'float64',可选) - 在算法中使用的数据类型,输入参数的数据类型必须与dtype保持一致。默认值:'float32'。
3333
- **name** (str,可选) - 操作名称。 更多信息请参考 :ref:`api_guide_Name`。默认值:None。
3434

3535
返回

0 commit comments

Comments
 (0)