From de11b453b15b7d9cb64b54aa51e8eb4a79e182a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mat=C3=ADas=20Duhalde?= <matias.duhalde@uc.cl> Date: Tue, 31 Oct 2023 08:37:04 +0100 Subject: [PATCH] docs: update README --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aa8c082..3c51fe9 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> -- GitLab