File: fann-create-train-from-callback.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (140 lines) | stat: -rw-r--r-- 4,165 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 331331 $ -->

<refentry xml:id="function.fann-create-train-from-callback" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>fann_create_train_from_callback</refname>
  <refpurpose>Creates the training data struct from a user supplied function</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>fann_create_train_from_callback</methodname>
   <methodparam><type>int</type><parameter>num_data</parameter></methodparam>
   <methodparam><type>int</type><parameter>num_input</parameter></methodparam>
   <methodparam><type>int</type><parameter>num_output</parameter></methodparam>
   <methodparam><type>collable</type><parameter>user_function</parameter></methodparam>
  </methodsynopsis>
  <para>
   Creates the training data struct from a user supplied function. As the training data are numerable (data 1, data 2...),
   the user must write a function that receives the number of the training data set (input, output) and returns the set.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>num_data</parameter></term>
    <listitem>
     <para>
      The number of training data
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>num_input</parameter></term>
    <listitem>
     <para>
      The number of inputs per training data
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>num_output</parameter></term>
    <listitem>
     <para>
      The number of ouputs per training data
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>user_function</parameter></term>
    <listitem>
     <para>
      The user supplied function with following parameters:
      <simplelist>
       <member><literal>num</literal> - The number of the training data set</member>
       <member><literal>num_input</literal> - The number of inputs per training data</member>
       <member><literal>num</literal> - The number of ouputs per training dataThe number of inputs per training data</member>
      </simplelist>
     </para>
     <para>
      The function should return an associative array with keys <literal>input</literal> and <literal>output</literal> and
      two array values of input and output.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  &fann.return.train;
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><methodname>fann_create_train_from_callback</methodname> example</title>
    <programlisting role="php">
<![CDATA[
<?php
function create_train_callback($num_data, $num_input, $num_output) {
    return array(
        "input" => array_fill(0, $num_input, 1),
        "output" => array_fill(0, $num_output, 1),
    );
}

$num_data = 3;
$num_input = 2;
$num_output = 1;
$train_data = fann_create_train_from_callback($num_data, $num_input, $num_output, "create_train_callback");
if ($train_data) {
    // Do something with $train_data
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fann_read_train_from_file</function></member>
    <member><function>fann_train_on_data</function></member>
    <member><function>fann_destroy_train</function></member>
    <member><function>fann_save_train</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
-->