fann-set-callback.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 83b687a1599117968687c2606a50e8c83fe9a3f3 Maintainer: seros Status: ready -->
<!-- Reviewed: no -->

<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>Establece la función de retrollamada a emplear durante el entrenamiento</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>callable</type><parameter>callback</parameter></methodparam>
  </methodsynopsis>
  <para>
   Establece la función de retrollamada a emplear durante el entrenamiento. Esto significa que es llamada desde
   <function>fann_train_on_data</function> o <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>
      La función de retrollamada proporcionada toma los siguientes parámetros:
      <simplelist>
       <member><literal>ann</literal> - El <type>resource</type> de red neuronal</member>
       <member><literal>train</literal> - El <type>resource</type> de datos de entrenamiento
        o &null; si se llamada desde <function>fann_train_on_file</function></member>
       <member><literal>max_epochs</literal> - El número máximo de épocas que debería continuar el entrenamiento</member>
       <member><literal>epochs_between_reports</literal> - El número de épocas entre llamadas a esta función</member>
       <member><literal>desired_error</literal> - El <function>fann_get_MSE</function> deseado o
        <function>fann_get_bit_fail</function>, dependiendo de la función de parada elegida mediante
        <function>fann_set_train_stop_function</function></member>
       <member><literal>epochs</literal> - La época actual</member>
      </simplelist>
     </para>
     <para>
      La retrollamada debería devolver &true;. Si devuelve &false;, el entrenamiento finalizará.
     </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
-->