SuperNN  1.0.0
readme.md
1 SuperNN
2 =======
3 
4 About
5 -----
6 
7 SuperNN is an artificial neural network library, with support to arbitrary
8 feed-forward topologies, that implements state-of-the-art supervised
9 training algorithms such as Improved Resilient Backpropagation (iRprop)
10 [Igel and Hüsken, 2000] and Neuron by Neuron (NBN) [Wilamowski, Yu, 2010].
11 
12 SuperNN is released under the LGPLv3+ license. It was tested on modern
13 GNU/Linux distributions and on MS-Windows 8 (by using MingW, VS2010, and VS2013).
14 
15 Provides an exporter tool that allows one to generate standalone Java or C++
16 code to use trained neural networks without requiring supernn at runtime.
17 
18 Dependencies
19 ------------
20 
21 SuperNN depends on [Eigen][1] (compile time only).
22 
23 License
24 -------
25 
26 LGPLv3+.
27 
28 Compilation
29 -----------
30 
31  $ mkdir build
32  $ cd build
33  $ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local ..
34  $ make -j
35  # make install
36 
37 To generate the API documentation to doc/html:
38 
39  $ doxygen doc/Doxyfile
40 
41 To include SuperNN into your cmake project you can use the provided module located at
42 cmake/FindSuperNN.cmake.
43 
44 You can also generate standalone Java or C++ code to run a trained neural network without requiring
45 supernn at runtime. The generators are located on the _tools_ folder.
46 
47 -------
48 
49 Lucas Hermann Negri - lucashnegri@gmail.com - [OProj][2]
50 
51 [1]: http://eigen.tuxfamily.org
52 [2]: http://oproj.tuxfamily.org