fann-create-standard.xml

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

<refentry xml:id="function.fann-create-standard" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>fann_create_standard</refname>
  <refpurpose>Creates a standard fully connected backpropagation neural network</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>fann_create_standard</methodname>
   <methodparam><type>int</type><parameter>num_layers</parameter></methodparam>
   <methodparam><type>int</type><parameter>num_neurons1</parameter></methodparam>
   <methodparam><type>int</type><parameter>num_neurons2</parameter></methodparam>
   <methodparam rep="repeat"><type>int</type><parameter>num_neuronsN</parameter></methodparam>
  </methodsynopsis>
  <para>
   Creates a standard fully connected backpropagation neural network.
  </para>
  <para>
   There will be a bias neuron in each layer (except the output layer),
   and this bias neuron will be connected to all neurons in the next layer.
   When running the network, the bias nodes always emits 1.
  </para>
  <para>
   To destroy a neural network use the <function>fann_destroy</function> function.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>num_layers</parameter></term>
    <listitem>
     <para>
      The total number of layers including the input and the output layer.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>num_neurons1</parameter></term>
    <listitem>
     <para>
      Number of neurons in the first layer.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>num_neurons2</parameter></term>
    <listitem>
     <para>
      Number of neurons in the second layer.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>num_neuronsN</parameter></term>
    <listitem>
     <para>
      Number of neurons in other layers.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a neural network resource on success, or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fann_create_standard_array</function></member>
    <member><function>fann_create_sparse</function></member>
    <member><function>fann_create_shortcut</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
-->