<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.fann.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'de',
  ),
  'this' => 
  array (
    0 => 'function.fann-train-epoch.php',
    1 => 'fann_train_epoch',
    2 => 'Train one epoch with a set of training data',
  ),
  'up' => 
  array (
    0 => 'ref.fann.php',
    1 => 'Fann Funktionen',
  ),
  'prev' => 
  array (
    0 => 'function.fann-train.php',
    1 => 'fann_train',
  ),
  'next' => 
  array (
    0 => 'function.fann-train-on-data.php',
    1 => 'fann_train_on_data',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/fann/functions/fann-train-epoch.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.fann-train-epoch" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">fann_train_epoch</h1>
  <p class="verinfo">(PECL fann &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">fann_train_epoch</span> &mdash; <span class="dc-title">Train one epoch with a set of training data</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.fann-train-epoch-description">
  <h3 class="title">Beschreibung</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>fann_train_epoch</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$ann</code></span>, <span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$data</code></span>): <span class="type"><a href="language.types.float.php" class="type float">float</a></span></div>

  <p class="para rdfs-comment">
   Train one epoch with the training data stored in data. One epoch is
   where all of the training data is considered exactly once.
  </p>
  <p class="para">
   This function returns the MSE error as it is calculated either before or during the actual training.
   This is not the actual MSE after the training epoch, but since calculating this will require to go
   through the entire training set once more. It is more than adequate to use this value during training.
  </p>
  <p class="para">
   The training algorithm used by this function is chosen by <span class="function"><a href="function.fann-set-training-algorithm.php" class="function">fann_set_training_algorithm()</a></span>
   function.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.fann-train-epoch-parameters">
  <h3 class="title">Parameter-Liste</h3>
  <dl>
   
    <dt><code class="parameter">ann</code></dt>
    <dd>
     <p class="para"><span class="type">Ressource</span> eines neuralen Netzwerks.</p>
    </dd>
   
   
    <dt><code class="parameter">data</code></dt>
    <dd>
     <p class="para"><span class="type">Ressource</span> für Trainingsdaten eines neuralen Netzwerks.</p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.fann-train-epoch-returnvalues">
  <h3 class="title">Rückgabewerte</h3>
  <p class="para">
   The MSE, or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on error.
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.fann-train-epoch-seealso">
  <h3 class="title">Siehe auch</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.fann-train-on-data.php" class="function" rel="rdfs-seeAlso">fann_train_on_data()</a> - Trains on an entire dataset for a period of time</span></li>
    <li><span class="function"><a href="function.fann-test-data.php" class="function" rel="rdfs-seeAlso">fann_test_data()</a> - Test a set of training data and calculates the MSE for the training data</span></li>
    <li><span class="function"><a href="function.fann-get-mse.php" class="function" rel="rdfs-seeAlso">fann_get_MSE()</a> - Reads the mean square error from the network</span></li>
    <li><span class="function"><a href="function.fann-set-training-algorithm.php" class="function" rel="rdfs-seeAlso">fann_set_training_algorithm()</a> - Sets the training algorithm</span></li>
   </ul>
  </p>
 </div>



</div><?php manual_footer($setup); ?>