Skip to content

improve introduction of bfgs args #4677

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

Merged
merged 1 commit into from
May 10, 2022
Merged

improve introduction of bfgs args #4677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api/paddle/incubate/optimizer/functional/minimize_bfgs_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ minimize_bfgs

参数
:::::::::
- **objective_func** - 待优化的目标函数. 接受多元输入并返回一个标量。
- **initial_position** (Tensor) - 迭代的初始位置。
- **objective_func** (callable) - 待优化的目标函数，接受1维 Tensor 并返回一个标量。
Copy link
Collaborator

@zhwesky2010 zhwesky2010 May 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个是1D Tensor，还是一个元素的Tensor？

Copy link
Contributor Author

@betterpig betterpig May 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1D Tensor

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

返回
Expand Down
8 changes: 4 additions & 4 deletions docs/api/paddle/incubate/optimizer/functional/minimize_lbfgs_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ minimize_lbfgs

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

返回
Expand Down