fann-train-on-file.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ea7caabb165509dbf6796bbf07d697f871c462c2 Maintainer: duanxiaoqiang Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.fann-train-on-file" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>fann_train_on_file</refname>
  <refpurpose>在从某个文件读取的整个数据集上训练一段时间。</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>fann_train_on_file</methodname>
   <methodparam><type>resource</type><parameter>ann</parameter></methodparam>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam><type>int</type><parameter>max_epochs</parameter></methodparam>
   <methodparam><type>int</type><parameter>epochs_between_reports</parameter></methodparam>
   <methodparam><type>float</type><parameter>desired_error</parameter></methodparam>
  </methodsynopsis>
  <para>
   在从某个文件读取的整个数据集上训练一段时间。
  </para>
  <para>
   该训练使用 <function>fann_set_training_algorithm</function> 函数选择的算法和这些训练算法设置的参数。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>ann</parameter></term>
    <listitem>
     &fann.ann.description;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>filename</parameter></term>
    <listitem>
     <para>
      包含训练数据的文件。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>max_epochs</parameter></term>
    <listitem>
     <para>
      训练应该继续的最大周期数。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>epochs_between_reports</parameter></term>
    <listitem>
     <para>
      用户函数之间的周期数。当为0时表示没有用户函数被调用。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>desired_error</parameter></term>
    <listitem>
     <para>
      期望的是 <function>fann_get_MSE</function> 或 <function>fann_get_bit_fail</function>的返回值, 取决于 <function>fann_set_train_stop_function</function> 选择的停止函数。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  &fann.return.bool;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fann_train_on_data</function></member>
    <member><function>fann_train_epoch</function></member>
    <member><function>fann_get_bit_fail</function></member>
    <member><function>fann_get_MSE</function></member>
    <member><function>fann_set_train_stop_function</function></member>
    <member><function>fann_set_training_algorithm</function></member>
    <member><function>fann_set_callback</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
-->