From 4afe37635355c376d167620d28fde441b4c78a27 Mon Sep 17 00:00:00 2001
From: Julien Chemillier <chemillier.julien@gmail.com>
Date: Thu, 30 Jun 2022 10:26:17 +0200
Subject: [PATCH] Update comments of neuron_io

---
 src/mnist/include/neuron_io.h | 57 +++++++++++++++++++++++++++++++++++
 src/mnist/neuron_io.c         | 21 -------------
 2 files changed, 57 insertions(+), 21 deletions(-)

diff --git a/src/mnist/include/neuron_io.h b/src/mnist/include/neuron_io.h
index aded44b..780af3f 100644
--- a/src/mnist/include/neuron_io.h
+++ b/src/mnist/include/neuron_io.h
@@ -8,18 +8,75 @@
 #ifndef DEF_NEURON_IO_H
 #define DEF_NEURON_IO_H
 
+
+
+// Lecture d'un réseau neuronal 
+
+/* 
+* Lit un neurone
+*/
 Neuron* read_neuron(uint32_t nb_weights, FILE *ptr);
+
+/*
+* Lit une couche de neurones
+*/
 Neuron** read_neurons(uint32_t nb_neurons, uint32_t nb_weights, FILE *ptr);
+
+/*
+* Charge l'entièreté du réseau neuronal depuis un fichier binaire
+*/
 Network* read_network(char* filename);
 
+
+
+
+// Écriture d'un réseau neuronal
+
+/*
+* Écrit un neurone dans le fichier pointé par *ptr
+*/
 void write_neuron(Neuron* neuron, int weights, FILE *ptr);
+
+/*
+* Stocke l'entièreté du réseau neuronal dans un fichier binaire
+*/
 void write_network(char* filename, Network* network);
 
+
+
+
+// Lecture des calculs de la backpropagation d'un réseau neuronal
+
+/*
+* Lit un neurone
+*/
 Neuron* read_delta_neuron(uint32_t nb_weights, FILE *ptr);
+
+/*
+* Lit une couche de neurones
+*/
 Neuron** read_delta_neurons(uint32_t nb_neurons, uint32_t nb_weights, FILE *ptr);
+
+/*
+* Charge l'entièreté du réseau neuronal depuis un fichier binaire
+*/
 Network* read_delta_network(char* filename);
 
+
+
+
+// Écriture des calculs de la backpropagation d'un réseau neuronal
+
+/*
+* Écrit les calculs de backpropagation effectués sur
+* un neurone dans le fichier pointé par *ptr
+*/
 void write_delta_neuron(Neuron* neuron, int weights, FILE *ptr);
+
+/*
+* Enregistre les calculs de backpropagation effectués
+* sur un réseau dans un fichier
+*/
 void write_delta_network(char* filename, Network* network);
 
 #endif
diff --git a/src/mnist/neuron_io.c b/src/mnist/neuron_io.c
index 74a3166..30d93be 100644
--- a/src/mnist/neuron_io.c
+++ b/src/mnist/neuron_io.c
@@ -10,9 +10,6 @@
 #define DELTA_MAGIC_NUMBER 2024
 
 
-/* Lecture d'un réseau neuronal */
-
-
 Neuron* read_neuron(uint32_t nb_weights, FILE *ptr) {
     Neuron* neuron = (Neuron*)malloc(sizeof(Neuron));
     float activation;
@@ -43,7 +40,6 @@ Neuron* read_neuron(uint32_t nb_weights, FILE *ptr) {
 }
 
 
-// Lit une couche de neurones
 Neuron** read_neurons(uint32_t nb_neurons, uint32_t nb_weights, FILE *ptr) {
     Neuron** neurons = (Neuron**)malloc(sizeof(Neuron*)*nb_neurons);
     for (int i=0; i < (int)nb_neurons; i++) {
@@ -53,7 +49,6 @@ Neuron** read_neurons(uint32_t nb_neurons, uint32_t nb_weights, FILE *ptr) {
 }
 
 
-// Charge l'entièreté du réseau neuronal depuis un fichier binaire
 Network* read_network(char* filename) {
     FILE *ptr;
     Network* network = (Network*)malloc(sizeof(Network));
@@ -96,10 +91,6 @@ Network* read_network(char* filename) {
 }
 
 
-/* Écriture d'un réseau neuronal */
-
-
-// Écrit un neurone dans le fichier pointé par *ptr
 void write_neuron(Neuron* neuron, int weights, FILE *ptr) {
     float buffer[weights+2];
 
@@ -112,7 +103,6 @@ void write_neuron(Neuron* neuron, int weights, FILE *ptr) {
 }
 
 
-// Stocke l'entièreté du réseau neuronal dans un fichier binaire
 void write_network(char* filename, Network* network) {
     FILE *ptr;
     int nb_layers = network->nb_layers;
@@ -140,9 +130,6 @@ void write_network(char* filename, Network* network) {
 }
 
 
-/* Lecture des calculs de la backpropagation d'un réseau neuronal */
-
-
 Neuron* read_delta_neuron(uint32_t nb_weights, FILE *ptr) {
     Neuron* neuron = (Neuron*)malloc(sizeof(Neuron));
     float activation;
@@ -172,7 +159,6 @@ Neuron* read_delta_neuron(uint32_t nb_weights, FILE *ptr) {
 }
 
 
-// Lit une couche de neurones
 Neuron** read_delta_neurons(uint32_t nb_neurons, uint32_t nb_weights, FILE *ptr) {
     Neuron** neurons = (Neuron**)malloc(sizeof(Neuron*)*nb_neurons);
     for (int i=0; i < (int)nb_neurons; i++) {
@@ -182,7 +168,6 @@ Neuron** read_delta_neurons(uint32_t nb_neurons, uint32_t nb_weights, FILE *ptr)
 }
 
 
-// Charge l'entièreté du réseau neuronal depuis un fichier binaire
 Network* read_delta_network(char* filename) {
     FILE *ptr;
     Network* network = (Network*)malloc(sizeof(Network));
@@ -225,11 +210,6 @@ Network* read_delta_network(char* filename) {
 }
 
 
-/* Écriture des calculs de la backpropagation d'un réseau neuronal */
-
-
-// Écrit les calculs de backpropagation effectués sur
-// un neurone dans le fichier pointé par *ptr
 void write_delta_neuron(Neuron* neuron, int weights, FILE *ptr) {
     float buffer[weights+2];
 
@@ -242,7 +222,6 @@ void write_delta_neuron(Neuron* neuron, int weights, FILE *ptr) {
 }
 
 
-// Enregistre les calculs de backpropagation effectués sur un réseau dans un fichier
 void write_delta_network(char* filename, Network* network) {
     FILE *ptr;
     int nb_layers = network->nb_layers;