php-doc-en/reference/fann/functions/fann-get-cascade-num-candidates.xml
2013-08-28 19:06:34 +00:00

90 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fann-get-cascade-num-candidates" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>fann_get_cascade_num_candidates</refname>
<refpurpose>Returns the number of candidates used during training</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fann_get_cascade_num_candidates</methodname>
<methodparam><type>resource</type><parameter>ann</parameter></methodparam>
</methodsynopsis>
<para>
The number of candidates used during training (calculated by multiplying
<function>fann_get_cascade_activation_functions_count</function>,
<function>fann_get_cascade_activation_steepnesses_count</function> and
<function>fann_get_cascade_num_candidate_groups</function>).
</para>
<para>
The actual candidates is defined by the <function>fann_get_cascade_activation_functions</function> and
<function>fann_get_cascade_activation_steepnesses</function> arrays. These arrays define the activation functions and
activation steepnesses used for the candidate neurons. If there are 2 activation functions in the activation function array and
3 steepnesses in the steepness array, then there will be 2x3=6 different candidates which will be trained. These 6 different
candidates can be copied into several candidate groups, where the only difference between these groups is the initial weights.
If the number of groups is set to 2, then the number of candidate neurons will be 2x3x2=12.
The number of candidate groups is defined by <function>fann_set_cascade_num_candidate_groups</function>.
</para>
<para>
The default number of candidates is 6x4x2 = 48
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>ann</parameter></term>
<listitem>
&fann.ann.description;
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The number of candidates used during training, or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fann_get_cascade_activation_functions</function></member>
<member><function>fann_get_cascade_activation_functions_count</function></member>
<member><function>fann_get_cascade_activation_steepnesses</function></member>
<member><function>fann_get_cascade_activation_steepnesses_count</function></member>
<member><function>fann_get_cascade_num_candidate_groups</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
-->