Skip to content

Commit

Permalink
Polishing.
Browse files Browse the repository at this point in the history
  • Loading branch information
janosg committed Nov 5, 2024
1 parent 445747a commit 25e1151
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions docs/source/how_to/how_to_algorithm_selection.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,10 @@
"## Filtering algorithms \n",
"\n",
"An even more fine-grained version of the decision tree is built into optimagic's \n",
"algorithm selection tool, which let's you filter algorithms based on the properties of \n",
"algorithm selection tool, which can filter algorithms based on the properties of \n",
"your problem. To make this concrete, assume we are looking for a **local** optimizer for \n",
"a **differentiable scalar** problem with **bound constraints**. \n",
"a **differentiable** problem with a **scalar** objective function and \n",
"**bound constraints**. \n",
"\n",
"To find all algorithms that match our criteria, we can simply type:"
]
Expand All @@ -101,15 +102,16 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The filters you can apply are: GradientBased, GradientFree, Global, Local, Bounded, \n",
"The available filters are: GradientBased, GradientFree, Global, Local, Bounded, \n",
"LinearConstrained, NonlinearConstrained, Scalar, LeastSquares, Likelihood, and Parallel.\n",
"You can apply them in any order your want. They are also discoverable, i.e. the \n",
"autocomplete feature of your editor will show you all filters you can apply as well \n",
"as all algorithms that satisfy your current filters. \n",
"autocomplete feature of your editor will show you all filters you can apply on top of \n",
"your current selection.\n",
"\n",
"Using `.All` shows you all algorithms optimagic knows of. Some of them require optional \n",
"dependencies. To show only the algorithms that are available with the packages you have \n",
"currently installed, use `.Available` instead of `.All`."
"Using `.All` after applying filters shows you all algorithms optimagic knows of that \n",
"satisfy your criteria. Some of them require optional dependencies. To show only the \n",
"algorithms that are available with the packages you have currently installed, use \n",
"`.Available` instead of `.All`."
]
},
{
Expand Down

0 comments on commit 25e1151

Please sign in to comment.