]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - ti-machine-learning/ti-machine-learning.git/blob - doc/latex/refman.tex
initial release
[ti-machine-learning/ti-machine-learning.git] / doc / latex / refman.tex
1 \documentclass[twoside]{book}
3 % Packages required by doxygen
4 \usepackage{calc}
5 \usepackage{doxygen}
6 \usepackage{graphicx}
7 \usepackage[utf8]{inputenc}
8 \usepackage{makeidx}
9 \usepackage{multicol}
10 \usepackage{multirow}
11 \usepackage{textcomp}
12 \usepackage[table]{xcolor}
14 % Font selection
15 \usepackage[T1]{fontenc}
16 \usepackage{mathptmx}
17 \usepackage[scaled=.90]{helvet}
18 \usepackage{courier}
19 \usepackage{amssymb}
20 \usepackage{sectsty}
21 \renewcommand{\familydefault}{\sfdefault}
22 \allsectionsfont{%
23   \fontseries{bc}\selectfont%
24   \color{darkgray}%
25 }
26 \renewcommand{\DoxyLabelFont}{%
27   \fontseries{bc}\selectfont%
28   \color{darkgray}%
29 }
31 % Page & text layout
32 \usepackage{geometry}
33 \geometry{%
34   a4paper,%
35   top=2.5cm,%
36   bottom=2.5cm,%
37   left=2.5cm,%
38   right=2.5cm%
39 }
40 \tolerance=750
41 \hfuzz=15pt
42 \hbadness=750
43 \setlength{\emergencystretch}{15pt}
44 \setlength{\parindent}{0cm}
45 \setlength{\parskip}{0.2cm}
46 \makeatletter
47 \renewcommand{\paragraph}{%
48   \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
49     \normalfont\normalsize\bfseries\SS@parafont%
50   }%
51 }
52 \renewcommand{\subparagraph}{%
53   \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
54     \normalfont\normalsize\bfseries\SS@subparafont%
55   }%
56 }
57 \makeatother
59 % Headers & footers
60 \usepackage{fancyhdr}
61 \pagestyle{fancyplain}
62 \fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
63 \fancyhead[CE]{\fancyplain{}{}}
64 \fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
65 \fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
66 \fancyhead[CO]{\fancyplain{}{}}
67 \fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
68 \fancyfoot[LE]{\fancyplain{}{}}
69 \fancyfoot[CE]{\fancyplain{}{}}
70 \fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated on Fri Mar 20 2015 11\-:26\-:10 for T\-I\-M\-L by Doxygen }}
71 \fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated on Fri Mar 20 2015 11\-:26\-:10 for T\-I\-M\-L by Doxygen }}
72 \fancyfoot[CO]{\fancyplain{}{}}
73 \fancyfoot[RO]{\fancyplain{}{}}
74 \renewcommand{\footrulewidth}{0.4pt}
75 \renewcommand{\chaptermark}[1]{%
76   \markboth{#1}{}%
77 }
78 \renewcommand{\sectionmark}[1]{%
79   \markright{\thesection\ #1}%
80 }
82 % Indices & bibliography
83 \usepackage{natbib}
84 \usepackage[titles]{tocloft}
85 \setcounter{tocdepth}{3}
86 \setcounter{secnumdepth}{5}
87 \makeindex
89 % Hyperlinks (required, but should be loaded last)
90 \usepackage{ifpdf}
91 \ifpdf
92   \usepackage[pdftex,pagebackref=true]{hyperref}
93 \else
94   \usepackage[ps2pdf,pagebackref=true]{hyperref}
95 \fi
96 \hypersetup{%
97   colorlinks=true,%
98   linkcolor=blue,%
99   citecolor=blue,%
100   unicode%
103 % Custom commands
104 \newcommand{\clearemptydoublepage}{%
105   \newpage{\pagestyle{empty}\cleardoublepage}%
109 %===== C O N T E N T S =====
111 \begin{document}
113 % Titlepage & ToC
114 \hypersetup{pageanchor=false}
115 \pagenumbering{roman}
116 \begin{titlepage}
117 \vspace*{7cm}
118 \begin{center}%
119 {\Large T\-I\-M\-L }\\
120 \vspace*{1cm}
121 {\large Generated by Doxygen 1.8.6}\\
122 \vspace*{0.5cm}
123 {\small Fri Mar 20 2015 11:26:10}\\
124 \end{center}
125 \end{titlepage}
126 \clearemptydoublepage
127 \tableofcontents
128 \clearemptydoublepage
129 \pagenumbering{arabic}
130 \hypersetup{pageanchor=true}
132 %--- Begin generated contents ---
133 \chapter{Introduction}
134 \label{index}\hypertarget{index}{}\input{index}
135 \chapter{Module Index}
136 \input{modules}
137 \chapter{Data Structure Index}
138 \input{annotated}
139 \chapter{File Index}
140 \input{files}
141 \chapter{Module Documentation}
142 \input{group__appCNNClass}
143 \include{group__appCNNConvertImageNet}
144 \include{group__appCNNConvertSBD}
145 \include{group__appCNNInteropCaffe}
146 \include{group__appCNNScene}
147 \include{group__benchmarkCNNClass}
148 \include{group__cnn}
149 \include{group__util}
150 \include{group__testCNN}
151 \include{group__testUtil}
152 \include{group__app}
153 \include{group__appCNN}
154 \include{group__benchmark}
155 \include{group__benchmarkCNN}
156 \include{group__test}
157 \chapter{Data Structure Documentation}
158 \input{struct__timlCNNLayer__}
159 \input{struct__timlConvNeuralNetwork__}
160 \input{structappCNNSceneDataSet}
161 \input{structtimlCNNConvParams}
162 \input{structtimlCNNDataSet}
163 \input{structtimlCNNDropoutParams}
164 \input{structtimlCNNInputParams}
165 \input{structtimlCNNLinearParams}
166 \input{structtimlCNNNonlinearParams}
167 \input{structtimlCNNNormParams}
168 \input{structtimlCNNPoolingParams}
169 \input{structtimlCNNTrainingParams}
170 \input{structtimlUtilImage}
171 \input{structtimlUtilImageSet}
172 \input{structtimlUtilInitializer}
173 \chapter{File Documentation}
174 \input{appCNNClass_8h}
175 \input{appCNNClassCIFAR10Testing_8c}
176 \input{appCNNClassCIFAR10Training_8c}
177 \input{appCNNClassImageNetAlexNetTesting_8c}
178 \input{appCNNClassImageNetCaffeNetTesting_8c}
179 \input{appCNNClassImageNetCaffeNetTraining_8c}
180 \input{appCNNClassImageNetVGGNetTesting_8c}
181 \input{appCNNClassMNISTTesting_8c}
182 \input{appCNNClassMNISTTraining_8c}
183 \input{appCNNConvertImageNet_8cpp}
184 \input{appCNNConvertImageNet_8hpp}
185 \input{appCNNConvertSBD_8cpp}
186 \input{appCNNConvertSBD_8hpp}
187 \input{appCNNConvertSBDShuffle_8cpp}
188 \input{appCNNInteropCaffe_8cpp}
189 \input{appCNNInteropCaffe_8hpp}
190 \input{appCNNInteropCaffeConvert_8cpp}
191 \input{appCNNInteropCaffeConvLayerConvert_8cpp}
192 \input{appCNNInteropCaffeConvLayerPermuteKernel_8cpp}
193 \input{appCNNInteropCaffeDropoutLayerConvert_8cpp}
194 \input{appCNNInteropCaffeFillBlockDiagonalMatrix_8cpp}
195 \input{appCNNInteropCaffeFlipKernelMatrix_8cpp}
196 \input{appCNNInteropCaffeFlipMatrixFloat_8cpp}
197 \input{appCNNInteropCaffeLayerTypeConvert_8cpp}
198 \input{appCNNInteropCaffeLinearLayerConvert_8cpp}
199 \input{appCNNInteropCaffeNonlinearLayerConvert_8cpp}
200 \input{appCNNInteropCaffeNonlinearTypeConvert_8cpp}
201 \input{appCNNInteropCaffeNormLayerConvert_8cpp}
202 \input{appCNNInteropCaffePermuteMean_8cpp}
203 \input{appCNNInteropCaffePoolingLayerConvert_8cpp}
204 \input{appCNNInteropCaffePoolingTypeConvert_8cpp}
205 \input{appCNNInteropCaffeReadMean_8cpp}
206 \input{appCNNInteropCaffeReadProtoFromBinaryFile_8cpp}
207 \input{appCNNInteropCaffeReadProtoFromTextFile_8cpp}
208 \input{appCNNScene_8h}
209 \input{appCNNSceneAccuracy_8c}
210 \input{appCNNSceneClassify_8c}
211 \input{appCNNSceneClassifyOpenMP_8c}
212 \input{appCNNSceneGetLabel_8c}
213 \input{appCNNSceneGetPatch_8c}
214 \input{appCNNSceneLabelMatrix_8c}
215 \input{appCNNSceneSBDTesting_8c}
216 \input{appCNNSceneSBDTraining_8c}
217 \input{appCNNSceneShuffleIdx_8c}
218 \input{appCNNSceneSupervisedTraining_8c}
219 \input{benchmarkCNNClass_8h}
220 \input{benchmarkCNNClassCaffeNetTesting_8c}
221 \input{benchmarkCNNClassVGGNetTesting_8c}
222 \input{testCNN_8c}
223 \input{testCNN_8h}
224 \input{testCNNSimpleClone_8c}
225 \input{testCNNSimpleIO_8c}
226 \input{testCNNSimpleProfile_8c}
227 \input{testCNNSimpleResize_8c}
228 \input{testCNNSimpleShare_8c}
229 \input{testCNNSimpleTraining_8c}
230 \input{testUtil_8c}
231 \input{testUtil_8h}
232 \input{testUtilBLAS_8c}
233 \input{testUtilConv2_8c}
234 \input{testUtilSort_8c}
235 \input{timl_8h}
236 \input{timlCNN_8h}
237 \input{timlCNNAddConvLayer_8c}
238 \input{timlCNNAddDropoutLayer_8c}
239 \input{timlCNNAddInputLayer_8c}
240 \input{timlCNNAddLinearLayer_8c}
241 \input{timlCNNAddNonlinearLayer_8c}
242 \input{timlCNNAddNormLayer_8c}
243 \input{timlCNNAddPoolingLayer_8c}
244 \input{timlCNNAssignDevice_8c}
245 \input{timlCNNBackPropagation_8c}
246 \input{timlCNNClassifyTop1SingleMode_8c}
247 \input{timlCNNClassifyTopNBatchMode_8c}
248 \input{timlCNNClassifyTopNBatchModeOpenMP_8c}
249 \input{timlCNNClassifyTopNTeamModeOpenMP_8c}
250 \input{timlCNNClone_8c}
251 \input{timlCNNConvBackPropagation_8c}
252 \input{timlCNNConvForwardPropagation_8c}
253 \input{timlCNNConvInitialize_8c}
254 \input{timlCNNConvParamsDefault_8c}
255 \input{timlCNNConvReadFromBinaryFile_8c}
256 \input{timlCNNConvReadFromTextFile_8c}
257 \input{timlCNNConvShareParams_8c}
258 \input{timlCNNConvUpdateParams_8c}
259 \input{timlCNNConvWriteToFile_8c}
260 \input{timlCNNCostWithLabel_8c}
261 \input{timlCNNCreateConvNeuralNetwork_8c}
262 \input{timlCNNDelete_8c}
263 \input{timlCNNDeleteConvLayer_8c}
264 \input{timlCNNDeleteDropoutLayer_8c}
265 \input{timlCNNDeleteInputLayer_8c}
266 \input{timlCNNDeleteLinearLayer_8c}
267 \input{timlCNNDeleteNonlinearLayer_8c}
268 \input{timlCNNDeleteNormLayer_8c}
269 \input{timlCNNDeletePoolingLayer_8c}
270 \input{timlCNNDropoutBackPropagation_8c}
271 \input{timlCNNDropoutForwardPropagation_8c}
272 \input{timlCNNDropoutInitialize_8c}
273 \input{timlCNNDropoutReadFromTextFile_8c}
274 \input{timlCNNDropoutWriteToFile_8c}
275 \input{timlCNNForwardPropagation_8c}
276 \input{timlCNNGetLayerNum_8c}
277 \input{timlCNNGetParamsNum_8c}
278 \input{timlCNNInitialize_8c}
279 \input{timlCNNInputInitialize_8c}
280 \input{timlCNNInputParamsDefault_8c}
281 \input{timlCNNInputReadFromBinaryFile_8c}
282 \input{timlCNNInputReadFromTextFile_8c}
283 \input{timlCNNInputShareParams_8c}
284 \input{timlCNNInputWriteToFile_8c}
285 \input{timlCNNLayerTypeStr_8c}
286 \input{timlCNNLinearBackPropagation_8c}
287 \input{timlCNNLinearForwardPropagation_8c}
288 \input{timlCNNLinearInitialize_8c}
289 \input{timlCNNLinearParamsDefault_8c}
290 \input{timlCNNLinearReadFromBinaryFile_8c}
291 \input{timlCNNLinearReadFromTextFile_8c}
292 \input{timlCNNLinearShareParams_8c}
293 \input{timlCNNLinearUpdateParams_8c}
294 \input{timlCNNLinearWriteToFile_8c}
295 \input{timlCNNMaxPoolingBackPropagation_8c}
296 \input{timlCNNMaxPoolingForwardPropagation_8c}
297 \input{timlCNNMeanPoolingBackPropagation_8c}
298 \input{timlCNNMeanPoolingForwardPropagation_8c}
299 \input{timlCNNMemory_8c}
300 \input{timlCNNMemPoolSize_8c}
301 \input{timlCNNNonlinearBackPropagation_8c}
302 \input{timlCNNNonlinearForwardPropagation_8c}
303 \input{timlCNNNonlinearInitialize_8c}
304 \input{timlCNNNonlinearParamsDefault_8c}
305 \input{timlCNNNonlinearReadFromTextFile_8c}
306 \input{timlCNNNonlinearWriteToFile_8c}
307 \input{timlCNNNormBackPropagation_8c}
308 \input{timlCNNNormForwardPropagation_8c}
309 \input{timlCNNNormInitialize_8c}
310 \input{timlCNNNormParamsDefault_8c}
311 \input{timlCNNNormWriteToFile_8c}
312 \input{timlCNNPoolingBackPropagation_8c}
313 \input{timlCNNPoolingForwardPropagation_8c}
314 \input{timlCNNPoolingInitialize_8c}
315 \input{timlCNNPoolingParamsDefault_8c}
316 \input{timlCNNPoolingReadFromTextFile_8c}
317 \input{timlCNNPoolingWriteToFile_8c}
318 \input{timlCNNPrint_8c}
319 \input{timlCNNProfile_8c}
320 \input{timlCNNReadFromFile_8c}
321 \input{timlCNNReset_8c}
322 \input{timlCNNResetConvLayer_8c}
323 \input{timlCNNResetDropoutLayer_8c}
324 \input{timlCNNResetInputLayer_8c}
325 \input{timlCNNResetLinearLayer_8c}
326 \input{timlCNNResetNonlinearLayer_8c}
327 \input{timlCNNResetNormLayer_8c}
328 \input{timlCNNResetPoolingLayer_8c}
329 \input{timlCNNResize_8c}
330 \input{timlCNNSetMode_8c}
331 \input{timlCNNShareParams_8c}
332 \input{timlCNNSupervisedTrainingWithLabelBatchMode_8c}
333 \input{timlCNNSupervisedTrainingWithLabelBatchModeOpenMP_8c}
334 \input{timlCNNTrainingParamsDefault_8c}
335 \input{timlCNNTrainingParamsReadFromTextFile_8c}
336 \input{timlCNNTrainingParamsWriteToFile_8c}
337 \input{timlCNNUpdateParams_8c}
338 \input{timlCNNWriteToFile_8c}
339 \input{timlUtil_8h}
340 \input{timlUtilBLAS_8c}
341 \input{timlUtilClassifyAccuracy_8c}
342 \input{timlUtilConv2Full_8c}
343 \input{timlUtilConv2ImageReshape_8c}
344 \input{timlUtilConv2ImageReshapeBack_8c}
345 \input{timlUtilConv2ImageReshapeIndex_8c}
346 \input{timlUtilConv2Valid_8c}
347 \input{timlUtilCorr2Full_8c}
348 \input{timlUtilDiffTime_8c}
349 \input{timlUtilElementWiseFunction_8c}
350 \input{timlUtilElementWiseMultiply_8c}
351 \input{timlUtilFread_8c}
352 \input{timlUtilFree_8c}
353 \input{timlUtilFwrite_8c}
354 \input{timlUtilLocalContrastNormalize_8c}
355 \input{timlUtilLocalContrastUnnormalize_8c}
356 \input{timlUtilMalloc_8c}
357 \input{timlUtilMasking_8c}
358 \input{timlUtilMaxPooling_8c}
359 \input{timlUtilMeanPooling_8c}
360 \input{timlUtilMeanSquareError_8c}
361 \input{timlUtilMultinomialCrossEntropy_8c}
362 \input{timlUtilRandContinuousUniformRNG_8c}
363 \input{timlUtilRandDiscreteUniformRNG_8c}
364 \input{timlUtilRandNormalRNG_8c}
365 \input{timlUtilRandPerm_8c}
366 \input{timlUtilReadCIFAR10_8c}
367 \input{timlUtilReadFixedSizeJPEG_8c}
368 \input{timlUtilReadJPEG_8c}
369 \input{timlUtilReadMNIST_8c}
370 \input{timlUtilRelu_8c}
371 \input{timlUtilReluDerivative_8c}
372 \input{timlUtilReverseEndian32_8c}
373 \input{timlUtilScanJPEG_8c}
374 \input{timlUtilSigmoid_8c}
375 \input{timlUtilSigmoidDerivative_8c}
376 \input{timlUtilSoftmax_8c}
377 \input{timlUtilSubtract_8c}
378 \input{timlUtilTanh_8c}
379 \input{timlUtilTanhDerivative_8c}
380 \input{timlUtilTransform_8c}
381 \input{timlUtilUndoMaxPooling_8c}
382 \input{timlUtilUndoMeanPooling_8c}
383 \input{timlUtilUnmasking_8c}
384 \input{timlUtilVectorMaxFloat_8c}
385 \input{timlUtilVectorMaxIndexFloat_8c}
386 \input{timlUtilVectorResetFloat_8c}
387 \input{timlUtilVectorResetInt_8c}
388 \input{timlUtilVectorSortFloat_8c}
389 \input{timlUtilVectorSortIndexFloat_8c}
390 \input{timlUtilVectorSumFloat_8c}
391 %--- End generated contents ---
393 % Bibliography
394 \newpage
395 \phantomsection
396 \addcontentsline{toc}{chapter}{Bibliography}
397 \bibliographystyle{plain}
398 \bibliography{timl}
400 % Index
401 \newpage
402 \phantomsection
403 \addcontentsline{toc}{chapter}{Index}
404 \printindex
406 \end{document}