mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
ea7caabb16
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@331220 c90b9560-bf6c-de11-be94-00142212c4b1
94 lines
3 KiB
XML
94 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.fann-set-callback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>fann_set_callback</refname>
|
|
<refpurpose>Sets the callback function for use during training</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>fann_set_callback</methodname>
|
|
<methodparam><type>resource</type><parameter>ann</parameter></methodparam>
|
|
<methodparam><type>collable</type><parameter>callback</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets the callback function for use during training. It means that it is called from
|
|
<function>fann_train_on_data</function> or <function>fann_train_on_file</function>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>ann</parameter></term>
|
|
<listitem>
|
|
&fann.ann.description;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>callback</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The supplied callback function takes following parameters:
|
|
<simplelist>
|
|
<member><literal>ann</literal> - The neural network <type>resource</type></member>
|
|
<member><literal>train</literal> - The train data <type>resource</type>
|
|
or &null; if called from <function>fann_train_on_file</function></member>
|
|
<member><literal>max_epochs</literal> - The maximum number of epochs the training should continue</member>
|
|
<member><literal>epochs_between_reports</literal> - The number of epochs between calling this function</member>
|
|
<member><literal>desired_error</literal> - 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></member>
|
|
<member><literal>epochs</literal> - The current epoch</member>
|
|
</simplelist>
|
|
</para>
|
|
<para>
|
|
The callback should return &true;. If it returns &false;, the training will terminate.
|
|
</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_on_file</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
|
|
-->
|