diff --git a/README.md b/README.md index aa8c082dab18aa7096c89a383654a69f7e1cbefc..3c51fe9b89acf2dde6a8f23a80d2164ebd5100a7 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ This project contains several files and directory. A brief description of each i - `results/`: This folder contains some of the results generated by the program. - `knn.py`: Contains functions related to the KNN algorithm. - `read_cifar.py`: Contains functions related to reading and parsing the CIFAR-10 dataset. -- `nn.py`: Contains functions related to the Neural Network algorithm. -- `main.ipynb`: Jupyter Notebook containing the main program. It is used to the algorithms and generate the results. +- `mlp.py`: Contains functions related to the Neural Network algorithm. +- `main.ipynb`: Jupyter Notebook containing the main program. It is used to test the algorithms and generate the results. It also contains some descriptions regarding the algorithms, notably a mathematical description of the Neural Network algorithm. ## Usage @@ -37,3 +37,4 @@ The main program is contained in the `main.ipynb` file. It can be run using Jupy ## References - Data Source : The CIFAR-10 Dataset. <https://www.cs.toronto.edu/~kriz/cifar.html> +- Assignment repository <https://gitlab.ec-lyon.fr/edelland/mod_4_6-td1>