mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
ea7caabb16
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331220 c90b9560-bf6c-de11-be94-00142212c4b1
117 lines
3.5 KiB
XML
117 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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>Trains on an entire dataset, which is read from file, for a period of time</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>
|
|
Trains on an entire dataset, which is read from file, for a period of time.
|
|
</para>
|
|
<para>
|
|
This training uses the training algorithm chosen by <function>fann_set_training_algorithm</function> and
|
|
the parameters set for these training algorithms.
|
|
</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>
|
|
The file containing train data
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>max_epochs</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The maximum number of epochs the training should continue
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>epochs_between_reports</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The number of epochs between calling a user function. A value of zero means that user function is not called.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>desired_error</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The desired <function>fann_get_MSE</function> or <function>fann_get_bit_fail</function>, depending on the stop function
|
|
chosen by <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
|
|
-->
|