Update README.md

erikasan · Nov 20, 2020 · 8807c34 · 8807c34
1 parent c8c46b4
commit 8807c34
Show file tree

Hide file tree

Showing 8 changed files with 415 additions and 401 deletions.
diff --git a/Figures/Algorithms.pdf b/Figures/Algorithms.pdf
diff --git a/README.md b/README.md
@@ -1 +1,24 @@
-# fys-stk-project2
+# Classification and Regression, from linear and logistic regression to neural networks
+
+This repository contains programs, test runs, material and report for project 2 in FYS-STK4155 made in collaboration between Oda Hovet (odasho), Ilse Kuperus (ilseku) and Erik Alexander Sandvik (erikasan).
+
+## Structure
+
+### Report folder
+* Contains the PDF of the report
+
+### Programs folder
+* `mylearn` package with logistic regression and linear regression with optimization methods for gradient descent
+* Code for neural network: `neural_network.py`
+* Code for classification with neural network: `classification_with_neural_network.py`
+* Notebook for gradient descent regression: `GD_Regression.ipynb`
+* Code for loading MNIST data set: `mnist_loader.py`
+
+### Test runs folder
+* The `mylearn` package to run the other programs.
+* Tests for logistic regression: `LogisticRegression.ipynb`
+* Tests for verifying gradient descent optimization for linear regression: `verify_GDRegressor.ipynb`
+* Test runs for regression with neural network: `regression_with_neural_network.py`
+
+### Figures folder
+* Contains figures used in the report
diff --git a/programs/.ipynb_checkpoints/GD_Regression-checkpoint.ipynb b/programs/.ipynb_checkpoints/GD_Regression-checkpoint.ipynb
diff --git a/programs/.ipynb_checkpoints/verify_GDRegressor-checkpoint.ipynb b/programs/.ipynb_checkpoints/verify_GDRegressor-checkpoint.ipynb
diff --git a/programs/GD_Regression.ipynb b/programs/GD_Regression.ipynb
diff --git a/programs/README.md b/programs/README.md
@@ -1,3 +1,6 @@
-My Learn folder:
-* Logistic Regression
-* SGD
+### Programs folder
+* `mylearn` package with logistic regression and linear regression with optimization methods for gradient descent
+* Code for neural network: `neural_network.py`
+* Code for classification with neural network: `classification_with_neural_network.py`
+* Notebook for gradient descent regression: `GD_Regression.ipynb`
+* Code for loading MNIST data set: `mnist_loader.py`
diff --git a/programs/fys-stk-project2.ipynb b/programs/fys-stk-project2.ipynb
diff --git a/test_runs/verify_GDRegressor.ipynb b/test_runs/verify_GDRegressor.ipynb