You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,19 +40,19 @@ Cartis, C., Fiala, J., Marteau, B. and Roberts, L., `Improving the Flexibility a
40
40
41
41
If you use DFO-LS for problems with constraints, including bound constraints, please also cite:
42
42
43
-
Hough, M. and Roberts, L., `Model-Based Derivative-Free Methods for Convex-Constrained Optimization <https://arxiv.org/abs/2111.05443>`_, *arXiv preprint arXiv:2111.05443*, (2021).
43
+
Hough, M. and Roberts, L., `Model-Based Derivative-Free Methods for Convex-Constrained Optimization <https://doi.org/10.1137/21M1460971>`_, *SIAM Journal on Optimization*, 21:4 (2022), pp. 2552-2579.
44
44
45
45
Requirements
46
46
------------
47
47
DFO-LS requires the following software to be installed:
48
48
49
-
* Python 2.7 or Python 3 (http://www.python.org/)
49
+
* Python 3.9 or higher (http://www.python.org/)
50
50
51
51
Additionally, the following python packages should be installed (these will be installed automatically if using *pip*, see `Installation using pip`_):
52
52
53
-
* NumPy 1.11 or higher (http://www.numpy.org/)
54
-
* SciPy 1.11 or higher (http://www.scipy.org/)
55
-
* Pandas 0.17 or higher (http://pandas.pydata.org/)
53
+
* NumPy (http://www.numpy.org/)
54
+
* SciPy version 1.11 or higher (http://www.scipy.org/)
55
+
* Pandas (http://pandas.pydata.org/)
56
56
57
57
**Optional package:** DFO-LS versions 1.2 and higher also support the `trustregion <https://github.com/lindonroberts/trust-region>`_ package for fast trust-region subproblem solutions. To install this, make sure you have a Fortran compiler (e.g. `gfortran <https://gcc.gnu.org/wiki/GFortran>`_) and NumPy installed, then run :code:`pip install trustregion`. You do not have to have trustregion installed for DFO-LS to work, and it is not installed by default.
58
58
@@ -117,7 +117,7 @@ If you do not have root privileges or you want to install DFO-LS for your privat
117
117
118
118
instead.
119
119
120
-
To upgrade DFO-LS to the latest version, navigate to the top-level directory (i.e. the one containing :code:`setup.py`) and rerun the installation using :code:`pip`, as above:
120
+
To upgrade DFO-LS to the latest version, navigate to the top-level directory (i.e. the one containing :code:`pyproject.toml`) and rerun the installation using :code:`pip`, as above:
121
121
122
122
.. code-block:: bash
123
123
@@ -126,11 +126,12 @@ To upgrade DFO-LS to the latest version, navigate to the top-level directory (i.
126
126
127
127
Testing
128
128
-------
129
-
If you installed DFO-LS manually, you can test your installation by running:
129
+
If you installed DFO-LS manually, you can test your installation using the pytest package:
130
130
131
131
.. code-block:: bash
132
132
133
-
$ python setup.py test
133
+
$ pip install pytest
134
+
$ python -m pytest --pyargs dfols
134
135
135
136
Alternatively, the HTML documentation provides some simple examples of how to run DFO-LS.
136
137
@@ -150,7 +151,7 @@ If DFO-LS was installed manually you have to remove the installed files by hand
150
151
151
152
Bugs
152
153
----
153
-
Please report any bugs using GitHub's issue tracker.
154
+
Please report any bugs using `GitHub's issue tracker<https://github.com/numericalalgorithmsgroup/dfols/issues>`_.
Copy file name to clipboardExpand all lines: docs/advanced.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ Advanced Usage
2
2
==============
3
3
This section describes different optional user parameters available in DFO-LS.
4
4
5
-
In the last section (:doc:`userguide`), we introduced :code:`dfols.solve()`, which has the optional input :code:`user_params`. This is a Python dictionary of user parameters. We will now go through the settings which can be changed in this way. More details are available in the papers [CFMR2018]_ and [HR2021]_.
5
+
In the last section (:doc:`userguide`), we introduced :code:`dfols.solve()`, which has the optional input :code:`user_params`. This is a Python dictionary of user parameters. We will now go through the settings which can be changed in this way. More details are available in the papers [CFMR2018]_ and [HR2022]_.
6
6
7
7
The default values, used if no override is given, in some cases vary depending on whether :code:`objfun` has stochastic noise; that is, whether evaluating :code:`objfun(x)` several times at the same :code:`x` gives the same result or not. Whether or not this is the case is determined by the :code:`objfun_has_noise` input to :code:`dfols.solve()` (and not by inspecting :code:`objfun`, for instance).
8
8
@@ -119,5 +119,5 @@ References
119
119
.. [CFMR2018]
120
120
Coralia Cartis, Jan Fiala, Benjamin Marteau and Lindon Roberts, `Improving the Flexibility and Robustness of Model-Based Derivative-Free Optimization Solvers <https://doi.org/10.1145/3338517>`_, *ACM Transactions on Mathematical Software*, 45:3 (2019), pp. 32:1-32:41 [`preprint <https://arxiv.org/abs/1804.00154>`_]
121
121
122
-
.. [HR2021]
123
-
Hough, M. and Roberts, L., `Model-Based Derivative-Free Methods for Convex-Constrained Optimization <https://arxiv.org/abs/2111.05443>`_, *arXiv preprint arXiv:2111.05443*, (2021).
122
+
.. [HR2022]
123
+
Hough, M. and Roberts, L., `Model-Based Derivative-Free Methods for Convex-Constrained Optimization <https://doi.org/10.1137/21M1460971>`_, *SIAM Journal on Optimization*, 21:4 (2022), pp. 2552-2579 [`preprint <https://arxiv.org/abs/2111.05443>`_].
0 commit comments