From 68b84b60d1da3906441b1ff1942c668146a83223 Mon Sep 17 00:00:00 2001 From: augustin64 Date: Wed, 15 Mar 2023 21:33:45 +0100 Subject: [PATCH] Change more occurrences --- doc/dense/README.md | 17 +++++++++++++++++ doc/{mnist => dense}/main.md | 18 ++++++++---------- doc/{mnist => dense}/neuron_io.md | 0 doc/{mnist => dense}/preview.md | 0 doc/{mnist => dense}/utils.md | 0 doc/mnist/README.md | 18 ------------------ 6 files changed, 25 insertions(+), 28 deletions(-) create mode 100644 doc/dense/README.md rename doc/{mnist => dense}/main.md (83%) rename doc/{mnist => dense}/neuron_io.md (100%) rename doc/{mnist => dense}/preview.md (100%) rename doc/{mnist => dense}/utils.md (100%) delete mode 100644 doc/mnist/README.md diff --git a/doc/dense/README.md b/doc/dense/README.md new file mode 100644 index 0000000..c01a58f --- /dev/null +++ b/doc/dense/README.md @@ -0,0 +1,17 @@ +# Réseau de neurones simple [code](/src/dense) + +Cette partie du code implémente un réseau de neuron simple (non convolutif) + +## Compilation +```bash +make dense +``` + +## Fichiers +- [main](/src/dense/main.c) [[Documentation](/doc/dense/main.md)] Contient la fonction main et les fonctions principales à appeler +- [neural_network](/src/dense/neural_network.c) [[Documentation](/src/dense/include/neural_network.h)] Contient le coeur du nn: forward et backward propagation ainsi que quelques utilitaires (copie et patch) +- [neuron_io](/src/dense/neuron_io.c) [[Documentation](/doc/dense/neuron_io.md)] Écrire et lire le réseau de neurones depuis un fichier +- [neuron.h](/src/dense/include/neuron.h) Définit la structure `Network` et les structures qui y sont liées + +- [preview](/src/dense/preview.c) [[Documentation](/doc/dense/preview.md)] Afficher les images chargées +- [utils](/src/dense/utils.c) [[Documentation](/doc/dense/utils.md)] Contient un ensemble de fonctions utiles à des fins de débogage \ No newline at end of file diff --git a/doc/mnist/main.md b/doc/dense/main.md similarity index 83% rename from doc/mnist/main.md rename to doc/dense/main.md index 72d043e..ea4e63d 100644 --- a/doc/mnist/main.md +++ b/doc/dense/main.md @@ -3,24 +3,22 @@ ## Compilation ```bash -make mnist-main +make dense-main ``` ## Options à la compilation -- La définition de la taille des batches se fait dans l'un des [`#define`](/src/mnist/main.c#L15) -- Le multi-threading est activé par défaut, réduisible à un seul thread actif en remplaçant [`get_nprocs()`](/src/mnist/main.c#L144) par 1 -- L'ajustement du nombre de couches, bien qu'étant une option en ligne de commande, ne définit pas les valeurs pour chaque couche. On préférera donc modifier directement ces valeurs dans le code [ici](/src/mnist/main.c#L140) et [ici](/src/mnist/main.c#L378) +- La définition de la taille des batches se fait dans l'un des [`#define`](/src/dense/main.c#L15) +- Le multi-threading est activé par défaut, réduisible à un seul thread actif en remplaçant [`get_nprocs()`](/src/dense/main.c#L144) par 1 +- L'ajustement du nombre de couches, bien qu'étant une option en ligne de commande, ne définit pas les valeurs pour chaque couche. On préférera donc modifier directement ces valeurs dans le code [ici](/src/dense/main.c#L140) et [ici](/src/dense/main.c#L378) ## Utilisation ```bash -Usage: build/mnist-main ( train | recognize | test ) [OPTIONS] +Usage: build/dense-main ( train | recognize | test ) [OPTIONS] OPTIONS: train: --epochs | -e [int] Nombre d'époques (itérations sur tout le set de données). - --couches | -c [int] Nombres de couches. - --neurones | -n [int] Nombre de neurones sur la première couche. --recover | -r [FILENAME] Récupérer depuis un modèle existant. --images | -i [FILENAME] Fichier contenant les images. --labels | -l [FILENAME] Fichier contenant les labels. @@ -45,7 +43,7 @@ Entraînement du réseau de neurones Exemple: ```bash -build/mnist-main train \ +build/dense-main train \ -e 15 \ -i data/mnist/train-images-idx3-ubyte \ -l data/mnist/train-labels-idx1-ubyte \ @@ -61,7 +59,7 @@ Le plus simple pour dessiner à la main est d'utiliser le [serveur web](/doc/web Exemple: ```bash -build/mnist-main recognize \ +build/dense-main recognize \ -m reseau.bin \ -i .cache/image-idx3-ubyte \ -o json @@ -71,7 +69,7 @@ build/mnist-main recognize \ Exemple: ```bash -build/mnist-main test \ +build/dense-main test \ -i data/mnist/t10k-images-idx3-ubyte \ -l data/mnist/t10k-labels-idx1-ubyte \ -m reseau.bin diff --git a/doc/mnist/neuron_io.md b/doc/dense/neuron_io.md similarity index 100% rename from doc/mnist/neuron_io.md rename to doc/dense/neuron_io.md diff --git a/doc/mnist/preview.md b/doc/dense/preview.md similarity index 100% rename from doc/mnist/preview.md rename to doc/dense/preview.md diff --git a/doc/mnist/utils.md b/doc/dense/utils.md similarity index 100% rename from doc/mnist/utils.md rename to doc/dense/utils.md diff --git a/doc/mnist/README.md b/doc/mnist/README.md deleted file mode 100644 index ede1991..0000000 --- a/doc/mnist/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# Réseau de neurones simple [code](/src/mnist) - -Cette partie du code implémente un réseau de neuron simple (non convolutif) - -## Compilation -```bash -make mnist -``` - -## Fichiers -- [main](/src/mnist/main.c) [[Documentation](/doc/mnist/main.md)] Contient la fonction main et les fonctions principales à appeler -- [mnist](/src/mnist/mnist.c) [[Documentation](/src/mnist/include/mnist.h)] Partagé avec le cnn, lit les fichiers du jeu de données [MNIST](http://yann.lecun.com/exdb/mnist/) -- [neural_network](/src/mnist/neural_network.c) [[Documentation](/src/mnist/include/neural_network.h)] Contient le coeur du nn: forward et backward propagation ainsi que quelques utilitaires (copie et patch) -- [neuron_io](/src/mnist/neuron_io.c) [[Documentation](/doc/mnist/neuron_io.md)] Écrire et lire le réseau de neurones depuis un fichier -- [neuron.h](/src/mnist/include/neuron.h) Définit la structure `Network` et les structures qui y sont liées - -- [preview](/src/mnist/preview.c) [[Documentation](/doc/mnist/preview.md)] Afficher les images chargées -- [utils](/src/mnist/utils.c) [[Documentation](/doc/mnist/utils.md)] Contient un ensemble de fonctions utiles à des fins de débogage \ No newline at end of file