[libfann] 206/242: Documentation of cascade

Christian Kastner chrisk-guest at moszumanska.debian.org
Sat Oct 4 21:10:45 UTC 2014


This is an automated email from the git hooks/post-receive script.

chrisk-guest pushed a commit to tag Version2_0_0
in repository libfann.

commit 6e195f3ab150fae01cd47df7ce9c107837df879a
Author: Steffen Nissen <lukesky at diku.dk>
Date:   Tue Nov 15 20:54:20 2005 +0000

    Documentation of cascade
---
 src/include/fann_cascade.h | 90 ++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 80 insertions(+), 10 deletions(-)

diff --git a/src/include/fann_cascade.h b/src/include/fann_cascade.h
index 31ebfc7..5bf9024 100644
--- a/src/include/fann_cascade.h
+++ b/src/include/fann_cascade.h
@@ -286,7 +286,7 @@ FANN_EXTERNAL void FANN_API fann_set_cascade_candidate_limit(struct fann *ann,
    The maximum out epochs determines the maximum number of epochs the output connections
    may be trained after adding a new candidate neuron.
    
-   The default
+   The default max out epochs is 150
 
    See also:
    		<fann_set_cascade_max_out_epochs>
@@ -298,6 +298,8 @@ FANN_EXTERNAL unsigned int FANN_API fann_get_cascade_max_out_epochs(struct fann
 
 /* Function: fann_set_cascade_max_out_epochs
 
+   Sets the maximum out epochs.
+
    See also:
    		<fann_get_cascade_max_out_epochs>
 
@@ -309,6 +311,11 @@ FANN_EXTERNAL void FANN_API fann_set_cascade_max_out_epochs(struct fann *ann,
 
 /* Function: fann_get_cascade_max_cand_epochs
 
+   The maximum candidate epochs determines the maximum number of epochs the input 
+   connections to the candidates may be trained before adding a new candidate neuron.
+   
+   The default max candidate epochs is 150
+
    See also:
    		<fann_set_cascade_max_cand_epochs>
 
@@ -319,6 +326,8 @@ FANN_EXTERNAL unsigned int FANN_API fann_get_cascade_max_cand_epochs(struct fann
 
 /* Function: fann_set_cascade_max_cand_epochs
 
+   Sets the max candidate epochs.
+  
    See also:
    		<fann_get_cascade_max_cand_epochs>
 
@@ -330,11 +339,23 @@ FANN_EXTERNAL void FANN_API fann_set_cascade_max_cand_epochs(struct fann *ann,
 
 /* Function: fann_get_cascade_num_candidates
 
-   The number of candidates used during training (calculated from cascade_activation_functions_count,
-   cascade_activation_steepnesses_count and cascade_num_candidate_groups). 
+   The number of candidates used during training (calculated by multiplying <fann_get_cascade_activation_functions_count>,
+   <fann_get_cascade_activation_steepnesses_count> and <fann_get_cascade_num_candidate_groups>). 
+
+   The actual candidates is defined by the <fann_get_cascade_activation_functions> and 
+   <fann_get_cascade_activation_steepnesses> 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 <fann_set_cascade_num_candidate_groups>.
+
+   The default number of candidates is 6x4x2 = 48
 
    See also:
-   		<fann_get_cascade_activation_functions_count>, <fann_get_cascade_activation_steepnesses_count>,
+   		<fann_get_cascade_activation_functions>, <fann_get_cascade_activation_functions_count>, 
+   		<fann_get_cascade_activation_steepnesses>, <fann_get_cascade_activation_steepnesses_count>,
    		<fann_get_cascade_num_candidate_groups>
 
 	This function appears in FANN >= 2.0.0.
@@ -343,8 +364,12 @@ FANN_EXTERNAL unsigned int FANN_API fann_get_cascade_num_candidates(struct fann
 
 /* Function: fann_get_cascade_activation_functions_count
 
+   The number of activation functions in the <fann_get_cascade_activation_functions> array.
+
+   The default number of activation functions is 6.
+
    See also:
-   		<fann_get_cascade_activation_functions>
+   		<fann_get_cascade_activation_functions>, <fann_set_cascade_activation_functions>
 
 	This function appears in FANN >= 2.0.0.
  */
@@ -353,8 +378,17 @@ FANN_EXTERNAL unsigned int FANN_API fann_get_cascade_activation_functions_count(
 
 /* Function: fann_get_cascade_activation_functions
 
+   The cascade activation functions array is an array of the different activation functions used by
+   the candidates. 
+   
+   See <fann_get_cascade_num_candidates> for a description of which candidate neurons will be 
+   generated by this array.
+   
+   The default activation functions is {FANN_SIGMOID, FANN_SIGMOID_SYMMETRIC, FANN_GAUSSIAN, FANN_GAUSSIAN_SYMMETRIC, FANN_ELLIOT, FANN_ELLIOT_SYMMETRIC}
+
    See also:
-   		<fann_get_cascade_activation_functions_count>
+   		<fann_get_cascade_activation_functions_count>, <fann_set_cascade_activation_functions>,
+   		<fann_activationfunc_enum>
 
 	This function appears in FANN >= 2.0.0.
  */
@@ -364,8 +398,14 @@ FANN_EXTERNAL enum fann_activationfunc_enum * FANN_API fann_get_cascade_activati
 
 /* Function: fann_set_cascade_activation_functions
 
+   Sets the array of cascade candidate activation functions. The array must be just as long
+   as defined by the count.
+
+   See <fann_get_cascade_num_candidates> for a description of which candidate neurons will be 
+   generated by this array.
+
    See also:
-   		<fann_get_cascade_activation_steepnesses_count>
+   		<fann_get_cascade_activation_steepnesses_count>, <fann_get_cascade_activation_steepnesses>
 
 	This function appears in FANN >= 2.0.0.
  */
@@ -378,8 +418,12 @@ FANN_EXTERNAL void fann_set_cascade_activation_functions(struct fann *ann,
 
 /* Function: fann_get_cascade_activation_steepnesses_count
 
+   The number of activation steepnesses in the <fann_get_cascade_activation_functions> array.
+
+   The default number of activation steepnesses is 4.
+
    See also:
-   		<fann_set_cascade_activation_functions>
+   		<fann_get_cascade_activation_steepnesses>, <fann_set_cascade_activation_functions>
 
 	This function appears in FANN >= 2.0.0.
  */
@@ -388,8 +432,16 @@ FANN_EXTERNAL unsigned int FANN_API fann_get_cascade_activation_steepnesses_coun
 
 /* Function: fann_get_cascade_activation_steepnesses
 
+   The cascade activation steepnesses array is an array of the different activation functions used by
+   the candidates.
+
+   See <fann_get_cascade_num_candidates> for a description of which candidate neurons will be 
+   generated by this array.
+
+   The default activation steepnesses is {0.25, 0.50, 0.75, 1.00}
+
    See also:
-   		<fann_set_cascade_activation_steepnesses>
+   		<fann_set_cascade_activation_steepnesses>, <fann_get_cascade_activation_steepnesses_count>
 
 	This function appears in FANN >= 2.0.0.
  */
@@ -398,8 +450,14 @@ FANN_EXTERNAL fann_type * FANN_API fann_get_cascade_activation_steepnesses(struc
 
 /* Function: fann_set_cascade_activation_steepnesses
 
+   Sets the array of cascade candidate activation steepnesses. The array must be just as long
+   as defined by the count.
+
+   See <fann_get_cascade_num_candidates> for a description of which candidate neurons will be 
+   generated by this array.
+
    See also:
-   		<fann_get_cascade_activation_steepnesses>
+   		<fann_get_cascade_activation_steepnesses>, <fann_get_cascade_activation_steepnesses_count>
 
 	This function appears in FANN >= 2.0.0.
  */
@@ -411,6 +469,16 @@ FANN_EXTERNAL void fann_set_cascade_activation_steepnesses(struct fann *ann,
 
 /* Function: fann_get_cascade_num_candidate_groups
 
+   The number of candidate groups is the number of groups of identical candidates which will be used
+   during training.
+   
+   This number can be used to have more candidates without having to define new parameters for the candidates.
+   
+   See <fann_get_cascade_num_candidates> for a description of which candidate neurons will be 
+   generated by this parameter.
+   
+   The default number of candidate groups is 2
+
    See also:
    		<fann_set_cascade_num_candidate_groups>
 
@@ -421,6 +489,8 @@ FANN_EXTERNAL unsigned int FANN_API fann_get_cascade_num_candidate_groups(struct
 
 /* Function: fann_set_cascade_num_candidate_groups
 
+   Sets the number of candidate groups.
+
    See also:
    		<fann_get_cascade_num_candidate_groups>
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/libfann.git



More information about the debian-science-commits mailing list