docs: add some instructions in readme

This commit is contained in:
Nemo D'ACREMONT 2025-05-16 11:34:15 +02:00
parent 12735a7f76
commit a26da4149f
No known key found for this signature in database
GPG Key ID: 85F245EC3BB1E022

View File

@ -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
```