From 02b3a79cdae7b7c266a6b26940123eefc882f01c Mon Sep 17 00:00:00 2001
From: "lucien.noel" <lucien.noel@etu.hesge.ch>
Date: Wed, 20 Mar 2024 16:01:35 +0100
Subject: [PATCH] =?UTF-8?q?README=20cr=C3=A9=C3=A9?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..be3cd95
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+Les librairies nécessaires au bon fonctionnement du projets sont dans requirements.txt
+
+Pour lancer le projet il faut faire :
+```bash
+python3 main.py
+```
+**Attention, ce processus peut prendre beacoup de temps et il est fortement recommandé de le lancer sur une machine avec un GPU Nvidia et [Cuda](https://developer.nvidia.com/cuda-downloads) d'installé.**
+Une fois l’exécution du code terminée, le résultat se trouve dans un fichier nommé output.mid.
+
+Par défaut les fichiers midi utilisés pour l'entraînement sont ceux dans le dossier "classical_music_midi" mais ce paramètre peut être modifié à la ligne 70 du fichier main.py : 
+```python
+midi_files_path = './classical_music_midi/'
+```
+Si la génération prend trop de temps vous pouvez aussi modifer le nombre d'itération maximum du processus en changeant la valeur max_iters dans le fichier gpt.py à la ligne 8 mais ce changement aura aussi un impact sur la qualité du résultat:
+```python
+max_iters = 1000
+```
+Vous pouvez aussi modifer d'autres paramètres dans ce fichier.
-- 
GitLab