Browse Source

Ecriture ReadMe de chaque programme

Arthur Brandao 6 years ago
parent
commit
1a5548a9bf

+ 16 - 2
Partie_1/Hybride/ReadMe.txt

@@ -1,3 +1,17 @@
+Le programme implémente un solveur SAT utilsant MPI et du multi threads.
 
-make -j
-./GSAT -i ../benchmarks/uf150/uf150-099.cnf
+Les commandes du makefile sont :
+	make : pour compiler le programme. L'exécutable généré se nommera GSATSolver.
+	make clean : pour supprimer le fichier exécutable et les .o
+	make run : pour lancer le programme
+
+Le programme s'utilise avec la commande suivante :
+	mpirun -n int ./GSATSolver -i file.cnf [-t int]
+
+Les arguments sont les suivants :
+	-n int : Le nombre de processus à utiliser
+	-i file.cnf : Le chemin vers le fichier cnf à résoudre
+	-t int : Le nombre de threads à utiliser (optionnel, par défaut 4)
+
+Exemple de commande (celle exécutée par `make run`)  : 
+	mpirun -n 3 ./GSATSolver -i ../../benchmarks/uf150/uf150-099.cnf -t 2

+ 15 - 2
Partie_1/MPI/ReadMe.txt

@@ -1,3 +1,16 @@
+Le programme implémente un solveur SAT en utilisant MPI.
 
-make -j
-./GSAT -i ../benchmarks/uf150/uf150-099.cnf
+Les commandes du makefile sont :
+	make : pour compiler le programme. L'exécutable généré se nommera GSATSolver.
+	make clean : pour supprimer le fichier exécutable et les .o
+	make run : pour lancer le programme
+
+Le programme s'utilise avec la commande suivante :
+	mpirun -n int ./GSATSolver -i file.cnf
+
+Les arguments sont les suivants :
+	-n int : Le nombre de processus à utiliser
+	-i file.cnf : Le chemin vers le fichier cnf à résoudre
+
+Exemple de commande (celle exécutée par `make run`)  : 
+	mpirun -n 4 ./GSATSolver -i ../../benchmarks/uf150/uf150-099.cnf

+ 17 - 2
Partie_1/Thread/ReadMe.txt

@@ -1,3 +1,18 @@
+Le programme implémente un solveur SAT en multi threads.
 
-make -j
-./GSAT -i ../benchmarks/uf150/uf150-099.cnf
+Les commandes du makefile sont :
+	make : pour compiler le programme. L'exécutable généré se nommera GSATSolver.
+	make clean : pour supprimer le fichier exécutable et les .o
+	make run : pour lancer le programme
+
+Le programme s'utilise avec la commande suivante :
+	./GSATSolver -i file.cnf [-t int] [-s] [-m int]
+
+Les arguments sont les suivants :
+  	-i file.cnf : Le chemin vers le fichier cnf à résoudre
+  	-t int : Le nombre de threads à utiliser (optionnel, par défaut 4)
+  	-s : Active le mode silencieux seul la satisfaisabilité (ou non) est affiché (optionnel)
+  	-m int : Le nombre maximum d'itération avant l'arret du programme (optionnel)
+
+Exemple de commande (celle exécutée par `make run`)  : 
+	./GSATSolver -i ../../benchmarks/uf150/uf150-099.cnf -t 4

+ 22 - 2
Partie_2/EMA/ReadMe.txt

@@ -1,3 +1,23 @@
+Le programme implémente le principe des bandits manchots avec une moyenne exponentielle glissante, et en utilisant ou non un epsilon greedy. 
+Par défaut le programme se lance avec un alpha statique (dont la valeur est 0.5).
 
-make -j
-./GSAT -i ../benchmarks/uf150/uf150-099.cnf
+Les commandes du makefile sont :
+	make : pour compiler le programme. L'exécutable généré se nommera GSATSolver.
+	make clean : pour supprimer le fichier exécutable et les .o
+	make run : pour lancer le programme
+	make epsilon : pour lancer le programme avec un epsilon greedy à 0.2
+	make dynamic : pour lancer le programme avec un alpha dynamique sans epsilon greedy
+	make start : pour lancer le programme avec un alpha dynamique avec epsilon greedy à 0.2
+
+Le programme se lance avec la commande suivante :
+	./GSATSolver -i file.cnf [-t int] [-s] [-e double] [-d]
+
+Les arguments sont les suivants :
+	-i file.cnf : Le chemin vers le fichier cnf à résoudre
+	-t int : Le nombre de threads à utiliser (optionnel, par défaut 4)
+	-s : Active le mode silencieux seul la satisfaisabilité (ou non) est affiché (optionnel)
+	-e double : Utilisation de l'epsilon greedy avec la valeur donné. La valeur doit être compirse entre 0 et 1 sinon la valeur utilisé est 0.1 (optionnel)
+	-d : Utilisation d'un alpha dynamique qui évolue entre 0.4 et 0.6 (optionnel)
+
+Exemple de commande (celle éxécuté par `make start`)  : 
+	./GSATSolver -i ../../benchmarks/uf150/uf150-099.cnf -t 4 -d -e 0.2

+ 18 - 2
Partie_2/Moyenne/ReadMe.txt

@@ -1,3 +1,19 @@
+Le programme implémente le principe des bandits manchots avec une moyenne classique, et en utilisant ou non un epsilon greedy.
 
-make -j
-./GSAT -i ../benchmarks/uf150/uf150-099.cnf
+Les commandes du makefile sont :
+	make : pour compiler le programme. L'exécutable généré se nommera GSATSolver.
+	make clean : pour supprimer le fichier exécutable et les .o
+	make run : pour lancer le programme
+	make epsilon : pour lancer le programme avec un epsilon greedy à 0.2
+
+Le programme se lance avec la commande suivante :
+	./GSATSolver -i file.cnf [-t int] [-s] [-e double]
+
+Les arguments sont les suivants :
+	-i file.cnf : Le chemin vers le fichier cnf à résoudre
+	-t int : Le nombre de threads à utiliser (optionnel, par défaut 4)
+	-s : Active le mode silencieux seul la satisfaisabilité (ou non) est affiché (optionnel)
+	-e double : Utilisation de l'epsilon greedy avec la valeur donné. La valeur doit être compirse entre 0 et 1 sinon la valeur utilisé est 0.1 (optionnel)
+
+Exemple de commande (celle exécutée par `make epsilon`)  : 
+	./GSATSolver -i ../../benchmarks/uf150/uf150-099.cnf -t 4 -e 0.2