/
index.html
301 lines (216 loc) · 11.3 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="Pure Julia implementations of optimization algorithms.">
<meta name="author" content="JuliaNLSolvers">
<link rel="shortcut icon" href="./img/favicon.ico">
<title>Home - Optim.jl</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="./css/theme.css" type="text/css" />
<link rel="stylesheet" href="./css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="./css/highlight.css">
<script>
// Current page data
var mkdocs_page_name = "Home";
var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = "/";
</script>
<script src="./js/jquery-2.1.1.min.js"></script>
<script src="./js/modernizr-2.8.3.min.js"></script>
<script type="text/javascript" src="./js/highlight.pack.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href="." class="icon icon-home"> Optim.jl</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current">
<a class="current" href=".">Home</a>
<ul class="subnav">
<li class="toctree-l2"><a href="#optimjl">Optim.jl</a></li>
<ul>
<li><a class="toctree-l3" href="#what">What</a></li>
<li><a class="toctree-l3" href="#why">Why</a></li>
<li><a class="toctree-l3" href="#how">How</a></li>
<li><a class="toctree-l3" href="#but">But...</a></li>
</ul>
</ul>
</li>
<li class="toctree-l1">
<span class="caption-text">General information</span>
<ul class="subnav">
<li class="">
<a class="" href="user/minimization/">Minimizing a function</a>
</li>
<li class="">
<a class="" href="user/config/">Configurable Options</a>
</li>
<li class="">
<a class="" href="user/tipsandtricks/">Tips and tricks</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<span class="caption-text">Algorithms</span>
<ul class="subnav">
<li class="">
<span class="caption-text">Solvers</span>
<ul class="subnav">
<li class="toctree-l3">
<span class="caption-text">Gradient Free</span>
<ul class="subnav">
<li class="toctree-l4">
<a class="" href="algo/nelder_mead/">Nelder Mead</a>
</li>
<li class="toctree-l4">
<a class="" href="algo/simulated_annealing/">Simulated Annealing</a>
</li>
</ul>
</li>
<li class="toctree-l3">
<span class="caption-text">Gradient Required</span>
<ul class="subnav">
<li class="toctree-l4">
<a class="" href="algo/cg/">Conjugate Gradient</a>
</li>
<li class="toctree-l4">
<a class="" href="algo/gradientdescent/">Gradient Descent</a>
</li>
<li class="toctree-l4">
<a class="" href="algo/lbfgs/">(L-)BFGS</a>
</li>
<li class="toctree-l4">
<a class="" href="algo/ngmres/">Acceleration</a>
</li>
</ul>
</li>
<li class="toctree-l3">
<span class="caption-text">Hessian Required</span>
<ul class="subnav">
<li class="toctree-l4">
<a class="" href="algo/newton/">Newton</a>
</li>
<li class="toctree-l4">
<a class="" href="algo/newton_trust_region/">Newton with Trust Region</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="">
<a class="" href="algo/autodiff/">Automatic Differentiation</a>
</li>
<li class="">
<a class="" href="algo/linesearch/">Linesearch</a>
</li>
<li class="">
<a class="" href="algo/precondition/">Preconditioners</a>
</li>
<li class="">
<a class="" href="algo/complex/">Complex optimization</a>
</li>
<li class="">
<a class="" href="algo/manifolds/">Manifolds</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<span class="caption-text">Contributing</span>
<ul class="subnav">
<li class="">
<a class="" href="dev/contributing/">Contributing</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<a class="" href="LICENSE/">License</a>
</li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">Optim.jl</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href=".">Docs</a> »</li>
<li>Home</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/JuliaNLSolvers/Optim.jl/edit/master/docs/index.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p><a id='Optim.jl-1'></a></p>
<h1 id="optimjl">Optim.jl</h1>
<p><a id='What-1'></a></p>
<h2 id="what">What</h2>
<p>Optim is a Julia package for optimizing functions of various kinds. While there is some support for box constrained and Riemannian optimization, most of the solvers try to find an $x$ that minimizes a function $f(x)$ without any constraints. Thus, the main focus is on unconstrained optimization. The provided solvers, under certain conditions, will converge to a local minimum. In the case where a global minimum is desired, global optimization techniques should be employed instead (see e.g. <a href="https://github.com/robertfeldt/BlackBoxOptim.jl">BlackBoxOptim</a>).</p>
<p><a id='Why-1'></a></p>
<h2 id="why">Why</h2>
<p>There are many solvers available from both free and commercial sources, and many of them are accessible from Julia. Few of them are written in Julia. Performance-wise this is rarely a problem, as they are often written in either Fortran or C. However, solvers written directly in Julia does come with some advantages.</p>
<p>When writing Julia software (packages) that require something to be optimized, the programmer can either choose to write their own optimization routine, or use one of the many available solvers. For example, this could be something from the <a href="https://github.com/JuliaOpt/NLopt.jl">NLOpt</a> suite. This means adding a dependency which is not written in Julia, and more assumptions have to be made as to the environment the user is in. Does the user have the proper compilers? Is it possible to use GPL'ed code in the project? Optim is released under the MIT license, and installation is a simple <code>Pkg.add</code>, so it really doesn't get much freer, easier, and lightweight than that.</p>
<p>It is also true, that using a solver written in C or Fortran makes it impossible to leverage one of the main benefits of Julia: multiple dispatch. Since Optim is entirely written in Julia, we can currently use the dispatch system to ease the use of custom preconditioners. A planned feature along these lines is to allow for user controlled choice of solvers for various steps in the algorithm, entirely based on dispatch, and not predefined possibilities chosen by the developers of Optim.</p>
<p>Being a Julia package also means that Optim has access to the automatic differentiation features through the packages in <a href="http://www.juliadiff.org/">JuliaDiff</a>.</p>
<p><a id='How-1'></a></p>
<h2 id="how">How</h2>
<p>Optim is registered in <a href="https://github.com/JuliaLang/METADATA.jl">METADATA.jl</a>. This means that all you need to do to install Optim, is to run</p>
<div class="codehilite"><pre><span></span><span class="n">Pkg</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s">"Optim"</span><span class="p">)</span>
</pre></div>
<p><a id='But...-1'></a></p>
<h2 id="but">But...</h2>
<p>Optim is a work in progress. There are still some rough edges to be sanded down, and features we want to implement. There are also planned breaking changes that are good to be aware of. Please see the section on Planned Changes.</p>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="user/minimization/" class="btn btn-neutral float-right" title="Minimizing a function">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a href="https://github.com/JuliaNLSolvers/Optim.jl/" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span style="margin-left: 15px"><a href="user/minimization/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
<script>var base_url = '.';</script>
<script src="./js/theme.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS_HTML"></script>
<script src="./assets/mathjaxhelper.js"></script>
<script src="./search/require.js"></script>
<script src="./search/search.js"></script>
</body>
</html>
<!--
MkDocs version : 0.17.2
Build Date UTC : 2018-02-07 16:05:04
-->