diff --git a/doc/README b/doc/README index fa6392de292dc1be934174c8c41fdf87261c3841..3a2f67669f85919131c217c996b6db2cb8470eb7 100644 --- a/doc/README +++ b/doc/README @@ -4,8 +4,15 @@ Markdown (.md) files for NLopt documentation live in $(top_src_dir)/doc/docs. To build and visualize the HTML documentation locally using the mkdocs package (useful for verifying on your local machine before -committing), install the `mkdocs` package, then run the -following command from the top-level meep repository tree: +committing): + +1. Install the `mkdocs` package, together with the requirements in +requirements.txt: + +% pip install mkdocs +% pip install -r requirements.txt + +2. Run the following command from the top-level NLopt repository tree: % mkdocs serve diff --git a/doc/docs/NLopt_Algorithms.md b/doc/docs/NLopt_Algorithms.md index 2d07f50c7ba7237a38083f905caad42e0994045f..c39ac54a8fca0152c33ab3b407ab6ad627459d97 100644 --- a/doc/docs/NLopt_Algorithms.md +++ b/doc/docs/NLopt_Algorithms.md @@ -186,6 +186,8 @@ Local derivative-free optimization Of these algorithms, only COBYLA currently supports arbitrary nonlinear inequality and equality constraints; the rest of them support bound-constrained or unconstrained problems only. (However, any of them can be applied to nonlinearly constrained problems by combining them with the [augmented Lagrangian method](#Augmented_Lagrangian_algorithm.md) below.) +A unique consideration when using local derivative-free algorithms is that the optimizer must somehow decide on an initial step size. By default, NLopt chooses this initial step size heuristically, but this may not always be the best choice. If you run into trouble, you can modify the initial step size, as described in the [NLopt reference](NLopt_Reference.md#initial-step-size). + ### COBYLA (Constrained Optimization BY Linear Approximations) This is a derivative of Powell's implementation of the COBYLA (Constrained Optimization BY Linear Approximations) algorithm for derivative-free optimization with nonlinear inequality and equality constraints, by M. J. D. Powell, described in: