<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Trains on an entire dataset, which is read from file, for a period of time</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fann-train-on-data.html">fann_train_on_data</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fann-train.html">fann_train</a></div>
<div class="up"><a href="ref.fann.html">Fann Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.fann-train-on-file" class="refentry">
<div class="refnamediv">
<h1 class="refname">fann_train_on_file</h1>
<p class="verinfo">(PECL fann >= 1.0.0)</p><p class="refpurpose"><span class="refname">fann_train_on_file</span> — <span class="dc-title">Trains on an entire dataset, which is read from file, for a period of time</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.fann-train-on-file-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>fann_train_on_file</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ann</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$max_epochs</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$epochs_between_reports</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$desired_error</code></span>
)</div>
<p class="para rdfs-comment">
Trains on an entire dataset, which is read from file, for a period of time.
</p>
<p class="para">
This training uses the training algorithm chosen by <span class="function"><a href="function.fann-set-training-algorithm.html" class="function">fann_set_training_algorithm()</a></span> and
the parameters set for these training algorithms.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.fann-train-on-file-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">ann</code></em></span>
<dd>
<p class="para">Neural network <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span>.</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
The file containing train data
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">max_epochs</code></em></span>
<dd>
<p class="para">
The maximum number of epochs the training should continue
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">epochs_between_reports</code></em></span>
<dd>
<p class="para">
The number of epochs between calling a user function. A value of zero means that user function is not called.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">desired_error</code></em></span>
<dd>
<p class="para">
The desired <span class="function"><a href="function.fann-get-mse.html" class="function">fann_get_MSE()</a></span> or <span class="function"><a href="function.fann-get-bit-fail.html" class="function">fann_get_bit_fail()</a></span>, depending on the stop function
chosen by <span class="function"><a href="function.fann-set-train-stop-function.html" class="function">fann_set_train_stop_function()</a></span>
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.fann-train-on-file-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">Returns <strong><code>TRUE</code></strong> on success, or <strong><code>FALSE</code></strong> otherwise.</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.fann-train-on-file-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.fann-train-on-data.html" class="function" rel="rdfs-seeAlso">fann_train_on_data()</a> - Trains on an entire dataset for a period of time</span></li>
<li class="member"> <span class="function"><a href="function.fann-train-epoch.html" class="function" rel="rdfs-seeAlso">fann_train_epoch()</a> - Train one epoch with a set of training data</span></li>
<li class="member"> <span class="function"><a href="function.fann-get-bit-fail.html" class="function" rel="rdfs-seeAlso">fann_get_bit_fail()</a> - The number of fail bits</span></li>
<li class="member"> <span class="function"><a href="function.fann-get-mse.html" class="function" rel="rdfs-seeAlso">fann_get_MSE()</a> - Reads the mean square error from the network</span></li>
<li class="member"> <span class="function"><a href="function.fann-set-train-stop-function.html" class="function" rel="rdfs-seeAlso">fann_set_train_stop_function()</a> - Sets the stop function used during training</span></li>
<li class="member"> <span class="function"><a href="function.fann-set-training-algorithm.html" class="function" rel="rdfs-seeAlso">fann_set_training_algorithm()</a> - Sets the training algorithm</span></li>
<li class="member"> <span class="function"><a href="function.fann-set-callback.html" class="function" rel="rdfs-seeAlso">fann_set_callback()</a> - Sets the callback function for use during training</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fann-train-on-data.html">fann_train_on_data</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fann-train.html">fann_train</a></div>
<div class="up"><a href="ref.fann.html">Fann Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
