fann-train-epoch.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.fann-train-epoch" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>fann_train_epoch</refname>
  <refpurpose>Train one epoch with a set of training data</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>float</type><methodname>fann_train_epoch</methodname>
   <methodparam><type>resource</type><parameter>ann</parameter></methodparam>
   <methodparam><type>resource</type><parameter>data</parameter></methodparam>
  </methodsynopsis>
  <para>
   Train one epoch with the training data stored in data. One epoch is
   where all of the training data is considered exactly once.
  </para>
  <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.
  </para>
  <para>
   The training algorithm used by this function is chosen by <function>fann_set_training_algorithm</function>
   function.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>ann</parameter></term>
    <listitem>
     &fann.ann.description;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>data</parameter></term>
    <listitem>
     &fann.train.description;
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The MSE, or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fann_train_on_data</function></member>
    <member><function>fann_test_data</function></member>
    <member><function>fann_get_MSE</function></member>
    <member><function>fann_set_training_algorithm</function></member>
   </simplelist>
  </para>
 </refsect1>


</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->