Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stagadish/NNplusplus
A small and easy to use neural net implementation for C++. Just download and #include!
https://github.com/stagadish/NNplusplus
Last synced: 18 days ago
JSON representation
A small and easy to use neural net implementation for C++. Just download and #include!
- Host: GitHub
- URL: https://github.com/stagadish/NNplusplus
- Owner: stagadish
- License: mit
- Created: 2016-08-25T15:59:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-25T17:23:15.000Z (over 7 years ago)
- Last Synced: 2024-07-31T22:45:39.882Z (3 months ago)
- Language: C++
- Homepage:
- Size: 3.5 MB
- Stars: 228
- Watchers: 19
- Forks: 35
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License.md
Awesome Lists containing this project
README
# NN++
A short, self-contained, and easy-to-use neural net implementation for C++. It includes the neural net implementation and a Matrix class for *basic* linear algebra operations. This project is mostly for **learning purposes**, but preliminary testing results over the MNIST dataset show some promise.
## Getting Started
These instructions will get you a copy of the net up and running on your local machine for development and testing purposes.
### Prerequisites
Any compiler that can handle C++11.
### Installing
1. Download `Matrix.hpp`, `Matrix.cpp`, `NeuralNet.hpp`, and `NeuralNet.cpp` and place them in your project's working directory.
2. Include the headers in your main driver program (e.g. `main.cpp`).
```
#include "Matrix.hpp"
#include "NeuralNet.hpp"
```
_**NOTE:** It is not required to `#include "Matrix.hpp"` since it is included within `NeuralNet.hpp`. However it is probably better to do so for clarity and safety in case you plan on using Matrix objects in your code (and you probably will if you use NeuralNet)._
## Example Code
### The Matrix Class
First you need to know how to use the Matrix class.
Matrix objects are basically 2D-vectors with built-in linear algebra operations.
#### Matrix Initialization
```
Matrix A; // Initializes a 0x0 matrix.
Matrix B(2,2) // Initializes a 2x2 matrix with all zeros. Values are doubles.
Matrix C(2,1) // Initializes a 2x1 matrix.
```
#### Element Access
To access/modify a value in a matrix, use `operator()`, NOT `operator[]`:
```
B(0,0) = 1; B(0,1) = 2; B(1,0) = 3; B(1,1) = 4; // [1 2]
// [3 4]
C(0,0) = 1; C(1,0) = 2; // [1]
// [2]
```
#### Matrix Term-by-Term Addition/Subtraction/Multiplication
```
// Commutative property is supported for addition
Matrix D = B+B; // D = [2 4]
[6 8]
Matrix E = B-B; // E = [0 0]
[0 0]
// Commutative property is supported for multiplication
Matrix F = B*B // F = [1 4]
[9 16]
// Mismatching matrix dimensions in term-by-term operations
// is illegal and a MatrixDimensionsMismatch exception will be thrown.
Matrix G = B+C; // Throws MatrixDimensionsMismatch()
Matrix G = B-C; // Throws MatrixDimensionsMismatch()
Matrix G = B*C; // Throws MatrixDimensionsMismatch()
```
#### Matrix and Scalars
```
// Commutative property is supported for addition
Matrix BplusTwo = B+2; // (== 2+B) BplusTwo = [3 4]
[5 6]
Matrix CminusTwo = C-2; // CminusTwo = [-1]
[ 0]
Matrix TwominusB = 2-C; // TwominusB = [ 1]
[ 0]
// Commutative property is supported for multiplication
Matrix BtimesThree = B*3; // (== 3*B) BtimesThree = [3 6]
[9 12]
```
#### Matrix Multiplication (Dot Product)
```
Matrix BB = B.dot(B); // BB = [ 7 10]
[15 22]
Matrix BC = B.dot(C); // BC = [ 5]
[11]
// Mismatching the number of columns in the left-hand-side matrix
// with the number of rows in the right-hand-side matrix is illegal
// A MatrixInnderDimensionsMismatch exception will be thrown.
Matrix CB = C.dot(B); // Throws MatrixInnderDimensionsMismatch()
```
#### Matrix Transpose
```
Matrix B_T = B.T(); // B_T = [1 3]
[2 4]
Matrix C_T = C.T(); // C_T = [1 2]
```
#### An Example of Populating a 4x3 Matrix
```
int m = 4;
int n = 3;
Matrix mtrx(m,n);
int count = 1;
for (int i = 0; i < mtrx.getNumOfRows(); ++i) {
for (int j = 0; j < mtrx.getNumOfCols(); ++j) {
mtrx(i,j) = count;
++count;
}
}
```
This will result with `mtrx` ==
```
[ 1 2 3]
[ 4 5 6]
[ 7 8 9]
[10 11 12]
```
### The NeuralNet Class
#### Neural Net Initialization (The Parameters)
When initialized, a net takes in five parameters:
1. Number of input nodes.
2. Number of nodes per hidden layer.
3. Number of output nodes.
4. Number of hidden layers.
5. The learning rate.
```
NeuralNet NN(4, 3, 1, 10, 0.1);
```
_This_ particular neural net has 4 input nodes, 1 hidden layer with 3 nodes, 10 output node, and has a learning rate of 0.1.
New neural nets' weights are initialized with values drawn from a normal distribution centered at 0, with standard deviation that is equal to `1/sqrt(number_of_inputs_to_nodes_in_next_layer)`. In other words, small negative and positive values that are proportional to the size of their previous layer.
#### A Training Cycle
Once the net is initialized, it is ready to do work.
__ONE__ training cycle == one feed forward and one back propagation with weight adjustments.
To train one cycle, the input data must be parsed into a Matrix object with dimensions: `1xnumber_of_input_nodes` (1x4 in our case), and the target output must be parsed into a Matrix object with dimensions: `1xnumber_of_output_nodes` (1x10 in our case).
```
Matrix input(1,4);
input(0,0) = 0.3;
input(0,1) = -0.1;
input(0,2) = 0.2;
input(0,3) = 0.8;
Matrix targetOutput(1,1);
target(0,0) = 0.5;
target(0,1) = -0.3;
.
.
.
target(0,9) = 0.23; // Obviously, matrices should be populated using
// some parser and not manualy like this.
```
Then, simply execute the training cycle on the data as follows:
```
NN.trainingCycle(input, targetOutput);
```
Repeate the process over all training instances.
#### Querying the Net
Once the training phase is complete, you can query it as follows:
(Technically speaking, you can query it right after initialization).
Parse the query into a Matrix like parsed the training instance:
```
Matrix query(1,2);
input(0,0) = 0.5;
input(0,1) = -0.2;
input(0,2) = -0.3;
input(0,3) = 0.4;
```
Query the net and catch the result:
```
Matrix prediction = NN.queryNet(query); // Will return a 1x10 Matrix object with net's prediction
```
AND THAT'S IT!
## TODO
1. Add `array`, `std::vector`, and `std::initializer_list` constructors to the Matrix class
2. Either improve on or replace my Matrix class for better/faster performance
3. Add multiple epoch learning with early stopping.
## Authors
* **Gil Dekel** - *Initial implementation* - [stagadish](https://github.com/stagadish)
See also the list of [contributors](https://github.com/stagadish/NNplusplus/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/stagadish/NNplusplus/blob/master/License.md) file for details