Skip to content

Commit c7a3d9a

Browse files
committed
Updated readme with standalone install.
1 parent 17909a1 commit c7a3d9a

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,48 @@
11

22
## What's this?
33

4-
Java neural network implementation with plugin for [WEKA] (http://www.cs.waikato.ac.nz/ml/weka/). Uses dropout and rectified linear units. Implementation is multithreaded and uses [MTJ] (https://github.com/fommil/matrix-toolkits-java) matrix library with native libs for performance.
4+
Java neural network implementation with plugin for [Weka] (http://www.cs.waikato.ac.nz/ml/weka/). Uses dropout and rectified linear units. Implementation is multithreaded and uses [MTJ] (https://github.com/fommil/matrix-toolkits-java) matrix library with native libs for performance.
55

66
## Installation
77

8+
### Weka
9+
810
Go to https://github.com/amten/NeuralNetwork/releases/latest to find the latest release. Download the files NeuralNetwork.zip and BLAS-dlls.zip.
9-
In WEKA, go to Tools/Package Manager and press the "File/URL" button. Browse to the NeuralNetwork.zip file and press "ok".
11+
In Weka, go to Tools/Package Manager and press the "File/URL" button. Browse to the NeuralNetwork.zip file and press "ok".
1012

1113
**Important!** For optimal performance on Windows, you need to copy native matrix library dll-files to Wekas install dir.
1214
Unzip the BLAS-dlls.zip file to Wekas install dir (".../Program Files/Weka-3-7").
1315

1416
For Linux, native matrix library files have not been tested, though it should be possible to install using instructions given [here] (https://github.com/fommil/netlib-java#linux)
1517

18+
### Standalone
19+
20+
This package was made mainly to be used from the Weka UI, but it can be used in your own java code as well.
21+
22+
Go to https://github.com/amten/NeuralNetwork/releases/latest to find the latest release. Download the files NeuralNetwork.zip and unzip.
23+
24+
Include the files NeuralNetwork.jar, lib/mtj-1.0-snapshot.jar, lib/opencsv-2.3.jar in your classpath.
25+
26+
**Important!** For optimal performance on Windows, you need to copy native matrix library dll-files to the directory where you execute your application, or any other directory in the PATH.
27+
Unzip the BLAS-dlls.zip to that directory.
28+
29+
For Linux, native matrix library files have not been tested, though it should be possible to install using instructions given [here] (https://github.com/fommil/netlib-java#linux)
30+
1631
## Usage
1732

18-
In WEKA, you will find the classifier under classifiers/functions/NeuralNetwork.
33+
### Weka
34+
35+
In Weka, you will find the classifier under classifiers/functions/NeuralNetwork.
1936

2037
**Note 1**: If you start Weka with console (alternative available in the windows start menu), you will get printouts of cost during each iteration of training and you can press enter in the console window to halt the training.
2138

2239
**Note 2**: When using dropout as regularization, it might still be a good idea to keep a small weight penalty. This keeps weights from exploding and causing overflows.
2340

41+
### Standalone
42+
43+
Example code showing classification and regression can be found here:
44+
https://github.com/amten/NeuralNetwork/tree/master/src/amten/ml/examples
45+
2446

2547
## License
2648

0 commit comments

Comments
 (0)