-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmodels-train-cfg.html
476 lines (407 loc) · 17.5 KB
/
models-train-cfg.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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>Cfg - Deep.Net</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="description" content=""/>
<meta name="author" content="Deep.Net developers"/>
<script src="https://code.jquery.com/jquery-1.8.0.js"></script>
<script src="https://code.jquery.com/ui/1.8.23/jquery-ui.js"></script>
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/js/bootstrap.min.js"></script>
<link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap-combined.min.css" rel="stylesheet"/>
<link type="text/css" rel="stylesheet" href="http://www.deepml.net/content/style.css" />
<script type="text/javascript" src="http://www.deepml.net/content/tips.js"></script>
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" async
src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML">
</script>
</head>
<body>
<div class="container">
<div class="masthead">
<ul class="nav nav-pills pull-right">
<li><a href="http://github.com/DeepMLNet/DeepNet">github page</a></li>
</ul>
<h3 class="muted"><a href="http://www.deepml.net/index.html">Deep.Net</a></h3>
</div>
<hr />
<div class="row">
<div class="span9" id="main">
<h1>Cfg</h1>
<p>
<span>Namespace: Models</span><br />
<span>Parent Module: <a href="models-train.html">Train</a></span>
</p>
<div class="xmldoc">
<p>Training configuration.</p>
</div>
<h3>Record Fields</h3>
<table class="table table-bordered member-list">
<thead>
<tr><td>Record Field</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '964', 964)" onmouseover="showTip(event, '964', 964)">
BatchSize
</code>
<div class="tip" id="964">
<strong>Signature:</strong> int64<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L119-119" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>batch size</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '965', 965)" onmouseover="showTip(event, '965', 965)">
BestOn
</code>
<div class="tip" id="965">
<strong>Signature:</strong> Partition<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L135-135" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>partition to use for determination of best loss</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '966', 966)" onmouseover="showTip(event, '966', 966)">
CheckpointFile
</code>
<div class="tip" id="966">
<strong>Signature:</strong> string option<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L149-149" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Path to a checkpoint file (HDF5 format).
Used to save the training state if training is interrupted and/or periodically.
If the file exists, the training state is loaded from it and training resumes.
The string %ITER% in the filename is replaced with the iteration number.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '967', 967)" onmouseover="showTip(event, '967', 967)">
CheckpointInterval
</code>
<div class="tip" id="967">
<strong>Signature:</strong> int option<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L151-151" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>number of iterations between automatic writing of checkpoints</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '968', 968)" onmouseover="showTip(event, '968', 968)">
DiscardCheckpoint
</code>
<div class="tip" id="968">
<strong>Signature:</strong> bool<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L153-153" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>If true, checkpoint is not loaded from disk.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '969', 969)" onmouseover="showTip(event, '969', 969)">
DumpPrefix
</code>
<div class="tip" id="969">
<strong>Signature:</strong> string option<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L161-161" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>If set, during each iteration the dump prefix will be set to the given string
concatenated with the iteration number.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '970', 970)" onmouseover="showTip(event, '970', 970)">
LearningRates
</code>
<div class="tip" id="970">
<strong>Signature:</strong> float list<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L144-144" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Learning rates that will be used. After training terminates with
one learning rate, it continues using the next learning rate from this list.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '971', 971)" onmouseover="showTip(event, '971', 971)">
LoadCheckpointIter
</code>
<div class="tip" id="971">
<strong>Signature:</strong> int option<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L156-156" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>If specified, loads the checkpoint corresponding to the specified iteration.
Otherwise, the latest checkpoint is loaded.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '972', 972)" onmouseover="showTip(event, '972', 972)">
LossRecordFunc
</code>
<div class="tip" id="972">
<strong>Signature:</strong> Entry -> unit<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L125-125" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>function that is called after loss has been evaluated</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '973', 973)" onmouseover="showTip(event, '973', 973)">
LossRecordInterval
</code>
<div class="tip" id="973">
<strong>Signature:</strong> int<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L123-123" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>number of iterations between evaluation of the loss</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '974', 974)" onmouseover="showTip(event, '974', 974)">
MaxIters
</code>
<div class="tip" id="974">
<strong>Signature:</strong> int option<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L141-141" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>maximum training iterations</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '975', 975)" onmouseover="showTip(event, '975', 975)">
MinImprovement
</code>
<div class="tip" id="975">
<strong>Signature:</strong> float<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L133-133" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>minimum loss decrease to count as improvement</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '976', 976)" onmouseover="showTip(event, '976', 976)">
MinIters
</code>
<div class="tip" id="976">
<strong>Signature:</strong> int option<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L139-139" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>minimum training iterations</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '977', 977)" onmouseover="showTip(event, '977', 977)">
PerformTraining
</code>
<div class="tip" id="977">
<strong>Signature:</strong> bool<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L158-158" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>If false, no training is performed after loading the checkpoint.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '978', 978)" onmouseover="showTip(event, '978', 978)">
Seed
</code>
<div class="tip" id="978">
<strong>Signature:</strong> int<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L117-117" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>seed for parameter initialization</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '979', 979)" onmouseover="showTip(event, '979', 979)">
SlotSize
</code>
<div class="tip" id="979">
<strong>Signature:</strong> int64 option<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L121-121" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>time slot length for sequence training</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '980', 980)" onmouseover="showTip(event, '980', 980)">
TargetLoss
</code>
<div class="tip" id="980">
<strong>Signature:</strong> float option<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L137-137" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>target loss that should lead to termination of training</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '981', 981)" onmouseover="showTip(event, '981', 981)">
Termination
</code>
<div class="tip" id="981">
<strong>Signature:</strong> TerminationCriterium<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L131-131" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>termination criterium</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '982', 982)" onmouseover="showTip(event, '982', 982)">
UserQualityFunc
</code>
<div class="tip" id="982">
<strong>Signature:</strong> int -> UserQualities<br />
</div>
</td>
<td class="xmldoc">
<a href="http://github.com/DeepMLNet/DeepNet/tree/master/MLModels/Train.fs#L129-129" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Function that takes the current iteration number and
calculates one or more user-defined quality metrics
using the current model state.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="span3">
<!-- <img src="http://www.deepml.net/img/logo.png" alt="Deep.Net logo" style="width:150px;margin:10px" /> -->
<ul class="nav nav-list" id="menu" style="margin-top: 20px;">
<li class="nav-header">Deep.Net</li>
<li><a href="http://www.deepml.net/index.html">Home page</a></li>
<li class="divider"></li>
<li><a href="http://nuget.org/packages/DeepNet">Get Library via NuGet</a></li>
<li><a href="http://github.com/DeepMLNet/DeepNet">Source Code on GitHub</a></li>
<li><a href="http://www.deepml.net/release-notes.html">Release Notes</a></li>
<li class="nav-header">Basics</li>
<li><a href="http://www.deepml.net/tensor.html">Working with Tensors</a></li>
<li><a href="http://www.deepml.net/model.html">Model Definition</a></li>
<li><a href="http://www.deepml.net/components.html">Model Components</a></li>
<li><a href="http://www.deepml.net/dataset.html">Dataset Handling</a></li>
<li><a href="http://www.deepml.net/training.html">Training</a></li>
<li class="nav-header">Advanced</li>
<li><a href="http://www.deepml.net/diff.html">Automatic Differentiation</a></li>
<li class="nav-header">Documentation</li>
<li><a href="http://www.deepml.net/reference/index.html">API Reference</a></li>
</ul>
</div>
</div>
</div>
<a href="http://github.com/DeepMLNet/DeepNet"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png" alt="Fork me on GitHub"/></a>
</body>
</html>