From a26da4149f02511a16ca38e12571c636bea381cb Mon Sep 17 00:00:00 2001
From: Nemo D'ACREMONT <ndacremont@enseirb-matmeca.fr>
Date: Fri, 16 May 2025 11:34:15 +0200
Subject: [PATCH] docs: add some instructions in readme

---
 go_ia/README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 51 insertions(+), 2 deletions(-)

diff --git a/go_ia/README.md b/go_ia/README.md
index cdd0859..a17431a 100644
--- a/go_ia/README.md
+++ b/go_ia/README.md
@@ -1,8 +1,57 @@
-# TP IA GO
+# TP IA GO -- Nemo D'ACREMONT, Martin EYBEN
 
-## VENV ACTIVATE
+## Activation de la venv
+
+Exécutez :
 
 ```sh
 python -m venv venv
 . ./venv/bin/activate
 ```
+
+## Télécharger les dépendances
+
+```
+pip -p ./requirements.txt
+```
+
+## Chargement des données
+
+Le script télécharge par défaut les données puis les transforme de la façon
+suivante :
+
+* Duplique les données en faisant des rotations de 90°
+* Échange les couleurs des plateaux, en échangeant aussi les score
+* Duplique les données en prenant le symmétrique des plateaux
+
+Il les stocke ensuite les dataset sous le nom `trainset.pt` et `testset.pt`
+dans le dossier `output_dir` (`./current` par défaut). Il peut être spécifié
+avec l'option `-O` comme suivant :
+
+```
+mkdir -p /tmp/mydata
+python ./main -O /tmp/mydata
+```
+
+## Entraînement
+
+Pour entraîner de zéro, il suffit de lancer le script sans spécifier de modèle
+avec le flag `-m`.
+
+Il est possible de reprendre un entraînement en utilisant l'argument `-m`,
+comme suivant :
+
+```
+python ./main -m ./model.pt
+```
+
+## Création des résultats
+
+Afin d'utiliser le modèle pour générer le fichier `results.txt`, il faut
+utiliser l'argument `-R` avec le chemin du dossier `json.gz` à utiliser.
+
+Voici un exemple :
+
+```
+python main.py -R positions-to-evaluate-8x8-2025-sample.json.gz -m model.pt
+```