test: add example program for creating a simple network

Author: gramcracker

Makefile

@@ -0,0 +1,32 @@
+HDR_DIR =header
+HEADER = $(addprefix -I,$(HDR_DIR))
+CCOPTION = Wall std=gnu++11 D__USE_MINGW_ANSI_STDIO=1 pthread
+FLAGS = $(addprefix -,$(CCOPTION))
+CC = g++
+OBJ_DIR =obj
+OBJ = link.o data_operations.o net.o neuron.o main.o 
+BUILD_DIR =bin
+SRC_DIR =src
+
+$(BUILD_DIR)/a.out: $(addprefix $(OBJ_DIR)/,$(OBJ)) 
+	 $(CC) $(FLAGS) $(addprefix $(OBJ_DIR)/,$(OBJ)) -o $(BUILD_DIR)/a.out
+
+$(OBJ_DIR)/link.o: $(SRC_DIR)/link.cpp 
+	 $(CC) $(FLAGS) -c $(SRC_DIR)/link.cpp -o $(OBJ_DIR)/link.o $(HEADER)
+
+$(OBJ_DIR)/data_operations.o: $(SRC_DIR)/data_operations.cpp 
+	 $(CC) $(FLAGS) -c $(SRC_DIR)/data_operations.cpp -o $(OBJ_DIR)/data_operations.o $(HEADER)
+
+$(OBJ_DIR)/net.o: $(SRC_DIR)/net.cpp 
+	 $(CC) $(FLAGS) -c $(SRC_DIR)/net.cpp -o $(OBJ_DIR)/net.o $(HEADER)
+
+$(OBJ_DIR)/neuron.o: $(SRC_DIR)/neuron.cpp 
+	 $(CC) $(FLAGS) -c $(SRC_DIR)/neuron.cpp -o $(OBJ_DIR)/neuron.o $(HEADER)
+
+$(OBJ_DIR)/main.o: $(SRC_DIR)/main.cpp 
+	 $(CC) $(FLAGS) -c $(SRC_DIR)/main.cpp -o $(OBJ_DIR)/main.o $(HEADER)
+
+
+clean: 
+	rm $(OBJ_DIR)/*.o
+	rm $(BUILD_DIR)/*.out

README.md

@@ -1,16 +1,4 @@
 # neural_network
-This is my personal project to make a realatively simple neural network library in C++.
+This is my personal project to make a fast and flexible neural network library.
 I created it specifically with natural language processing in mind, but works well for just about anything, although it is still a work in progress.
 
-## Getting Started
-### Prerequisites
-You will need c++11 support. This works best with g++11 and up. You may need to tell your compiler to use the thread library with the -lpthread option.
-
-```
-g++ -std=c++11 foo.cpp -lpthread -o foo
-```
-### Installing
-Download the code and modify the makefile to fit your project.
-
-### Usage
-Examples on how to use this library can be found in the examples folder.

bin/a.out

@@ -0,0 +1,6 @@
+Compiling examples (linux)
+
+	cd path/to/neural_network
+	mv examples/ExampleFile.cpp src/main.cpp
+	make
+	./bin/a.out

examples/README

@@ -0,0 +1,11 @@
+#include <iostream>
+#include "net.h"
+using namespace std;
+int main(){
+	vector <int> dims{ 3, 5, 4};//specifies the shape of the net. 3 layers: 3 input 5 hidden and 4 output
+	vector <double> in{ 0, 2, 3};
+	vector <double> out{ 1, 0, .5, 0};
+	net n1(dims, true);//creates fully connected net with weights initialized to random values in the shape of dims
+	n1.TrainBackpropagation( out, in);
+	return 0;
+}