-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmirapy.fitting.html
394 lines (268 loc) · 16.1 KB
/
mirapy.fitting.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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
<!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 name="viewport" content="width=device-width, initial-scale=1.0">
<title>mirapy.fitting package — MiraPy v0.1 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="mirapy.utils package" href="mirapy.utils.html" />
<link rel="prev" title="mirapy.classifiers package" href="mirapy.classifiers.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: #2D4264" >
<a href="index.html" class="icon icon-home"> MiraPy
</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" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="README.html">MiraPy: Python Package for Deep Learning in Astronomy</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#applications">Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#installation">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#contributing">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#about-us">About Us</a></li>
<li class="toctree-l1"><a class="reference internal" href="README.html#license">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="mirapy.html">MiraPy API</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="mirapy.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="mirapy.autoencoder.html">mirapy.autoencoder package</a></li>
<li class="toctree-l3"><a class="reference internal" href="mirapy.classifiers.html">mirapy.classifiers package</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">mirapy.fitting package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-mirapy.fitting.losses">mirapy.fitting.losses module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-mirapy.fitting.models">mirapy.fitting.models module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-mirapy.fitting.optimizers">mirapy.fitting.optimizers module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-mirapy.fitting">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="mirapy.utils.html">mirapy.utils package</a></li>
<li class="toctree-l3"><a class="reference internal" href="mirapy.visualization.html">mirapy.visualization package</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">MiraPy</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="index.html">Docs</a> »</li>
<li><a href="mirapy.html">MiraPy API</a> »</li>
<li>mirapy.fitting package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/mirapy.fitting.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="mirapy-fitting-package">
<h1>mirapy.fitting package<a class="headerlink" href="#mirapy-fitting-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-mirapy.fitting.losses">
<span id="mirapy-fitting-losses-module"></span><h2>mirapy.fitting.losses module<a class="headerlink" href="#module-mirapy.fitting.losses" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="mirapy.fitting.losses.mean_squared_error">
<code class="descclassname">mirapy.fitting.losses.</code><code class="descname">mean_squared_error</code><span class="sig-paren">(</span><em>y_true</em>, <em>y_pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.losses.mean_squared_error" title="Permalink to this definition">¶</a></dt>
<dd><p>Function for mean squared error.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>y_true</strong> – Array of true values.</p></li>
<li><p><strong>y_pred</strong> – Array of predicted values.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Float. Loss value.</p>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="mirapy.fitting.losses.negative_log_likelihood">
<code class="descclassname">mirapy.fitting.losses.</code><code class="descname">negative_log_likelihood</code><span class="sig-paren">(</span><em>y_true</em>, <em>y_pred</em><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.losses.negative_log_likelihood" title="Permalink to this definition">¶</a></dt>
<dd><p>Function for negative log-likelihood error.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>y_true</strong> – Array of true values.</p></li>
<li><p><strong>y_pred</strong> – Array of predicted values.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Float. Loss value.</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="module-mirapy.fitting.models">
<span id="mirapy-fitting-models-module"></span><h2>mirapy.fitting.models module<a class="headerlink" href="#module-mirapy.fitting.models" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="mirapy.fitting.models.Gaussian1D">
<em class="property">class </em><code class="descclassname">mirapy.fitting.models.</code><code class="descname">Gaussian1D</code><span class="sig-paren">(</span><em>amplitude=1.0</em>, <em>mean=0.0</em>, <em>stddev=1.0</em><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.models.Gaussian1D" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#mirapy.fitting.models.Model1D" title="mirapy.fitting.models.Model1D"><code class="xref py py-class docutils literal notranslate"><span class="pre">mirapy.fitting.models.Model1D</span></code></a></p>
<dl class="method">
<dt id="mirapy.fitting.models.Gaussian1D.evaluate">
<code class="descname">evaluate</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.models.Gaussian1D.evaluate" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the value of Gaussian model of the given input.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – Array of 1-D input values.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Return the output of the model.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mirapy.fitting.models.Gaussian1D.get_params_as_array">
<code class="descname">get_params_as_array</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.models.Gaussian1D.get_params_as_array" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the parameters of the model as an array.</p>
</dd></dl>
<dl class="method">
<dt id="mirapy.fitting.models.Gaussian1D.set_params_from_array">
<code class="descname">set_params_from_array</code><span class="sig-paren">(</span><em>params</em><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.models.Gaussian1D.set_params_from_array" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the parameters of the model from an array.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>params</strong> – Array of parameter values.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="mirapy.fitting.models.Model1D">
<em class="property">class </em><code class="descclassname">mirapy.fitting.models.</code><code class="descname">Model1D</code><a class="headerlink" href="#mirapy.fitting.models.Model1D" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="mirapy.fitting.models.Model1D.evaluate">
<code class="descname">evaluate</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.models.Model1D.evaluate" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the value of a model of the given input.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – Array of 1-D input values.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Return the output of the model.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mirapy.fitting.models.Model1D.get_params_as_array">
<code class="descname">get_params_as_array</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.models.Model1D.get_params_as_array" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the parameters of the model as an array.</p>
</dd></dl>
<dl class="method">
<dt id="mirapy.fitting.models.Model1D.set_params_from_array">
<code class="descname">set_params_from_array</code><span class="sig-paren">(</span><em>params</em><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.models.Model1D.set_params_from_array" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the parameters of the model from an array.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>params</strong> – Array of parameter values.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-mirapy.fitting.optimizers">
<span id="mirapy-fitting-optimizers-module"></span><h2>mirapy.fitting.optimizers module<a class="headerlink" href="#module-mirapy.fitting.optimizers" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="mirapy.fitting.optimizers.ParameterEstimation">
<em class="property">class </em><code class="descclassname">mirapy.fitting.optimizers.</code><code class="descname">ParameterEstimation</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>model</em>, <em>loss_function</em>, <em>callback=None</em><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.optimizers.ParameterEstimation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="mirapy.fitting.optimizers.ParameterEstimation.fit">
<code class="descname">fit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.optimizers.ParameterEstimation.fit" title="Permalink to this definition">¶</a></dt>
<dd><p>Fits the data into the model using regression.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Returns the result.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mirapy.fitting.optimizers.ParameterEstimation.get_model">
<code class="descname">get_model</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.optimizers.ParameterEstimation.get_model" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a copy of model used in estimation.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Model instance.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="mirapy.fitting.optimizers.ParameterEstimation.regression_function">
<code class="descname">regression_function</code><span class="sig-paren">(</span><em>params</em><span class="sig-paren">)</span><a class="headerlink" href="#mirapy.fitting.optimizers.ParameterEstimation.regression_function" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the output of loss function.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>params</strong> – Array of new parameters of the model.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Output of loss function.</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-mirapy.fitting">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-mirapy.fitting" title="Permalink to this headline">¶</a></h2>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="mirapy.utils.html" class="btn btn-neutral float-right" title="mirapy.utils package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="mirapy.classifiers.html" class="btn btn-neutral float-left" title="mirapy.classifiers package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, Swapnil Sharma, Akhil Singhal
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>