Skip to content

Commit e732a8e

Browse files
author
Logan Grado
committed
docs(userguide): Added documentation for args
1 parent f8e9ec7 commit e732a8e

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/userguide.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,14 @@ The :code:`solve` function has several optional arguments which the user may pro
6565

6666
.. code-block:: python
6767
68-
pybobyqa.solve(objfun, x0, bounds=None, npt=None, rhobeg=None,
69-
rhoend=1e-8, maxfun=None, nsamples=None,
68+
pybobyqa.solve(objfun, x0, args=(), bounds=None, npt=None,
69+
rhobeg=None, rhoend=1e-8, maxfun=None, nsamples=None,
7070
user_params=None, objfun_has_noise=False,
7171
scaling_within_bounds=False)
7272
7373
These arguments are:
7474

75+
* :code:`args` - a tuple of extra arguments passed to the objective function
7576
* :code:`bounds` - a tuple :code:`(lower, upper)` with the vectors :math:`a` and :math:`b` of lower and upper bounds on :math:`x` (default is :math:`a_i=-10^{20}` and :math:`b_i=10^{20}`). To set bounds for either :code:`lower` or :code:`upper`, but not both, pass a tuple :code:`(lower, None)` or :code:`(None, upper)`.
7677
* :code:`npt` - the number of interpolation points to use (default is :code:`2*len(x0)+1`). Py-BOBYQA requires :code:`n+1 <= npt <= (n+1)*(n+2)/2` for a problem with :code:`len(x0)=n`. Larger values are particularly useful for noisy problems.
7778
* :code:`rhobeg` - the initial value of the trust region radius (default is :math:`0.1\max(\|x_0\|_{\infty}, 1)`).

0 commit comments

Comments
 (0)