README.md is completed

[predictops.git] / README.md

diff --git a/README.md b/README.md
index 660b7ef9940ff03411bb3d4b826008583bdf9fd7..e224f20d0feeedb063fff3789954a69939d828dc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,28 +1,70 @@
-Creer un environnement :
-pip install virtualenv
-python -m venv ~/.venvs/predictops
+Configuration
+=============
+
+Initialisation de l'environnement de travail
+--------------------------------------------
+
+- Creer un environnement :
+
+`pip install virtualenv`
+
+`python -m venv ~/.venvs/predictops`

 
 activer l'environnement :
 
 activer l'environnement :

-source ~/.venvs/predictops/bin/activate

 
 

-installer un package :
-pip install celery
-pip freeze > requirements.txt
+`source ~/.venvs/predictops/bin/activate`
+
+
+Gestion des packages
+--------------------
+
+- Mettre à jour la liste des packages
+
+`pip install -r requirements.txt`
+
+- installer un package :
+
+`pip install celery`
+
+`pip freeze > requirements.txt`

 
 

-Lancer
-celery -A test_celery worker --loglevel=info
-puis
-python -m test_celery.run_tasks

 
 

+Configuration de l'apprentissage
+--------------------------------

 
 

-Pour nettoyer la bdd :
-engine = ExtomeEngine(clean = False) -> dans le main
--> Remplir le répertoire data à partir d'archive
-dans pgModeler : Faire export
+Tout se passe dans le répertoire features

 
 

+1. Modifier learn.cfg :
+  - définition de l'ensemble d'apprentissage
+  - famille de features à considérer (météofrance...)
+  - opérations de pré-traitement
+  - ...

 
 

-$ psql extome
-\dt  -> describe table
-select * from "PARAMETER";
+2. Détailler le traitement de chaque famille de feature dans le cfg associé
+(feature_ephemeris.cfg, feature_meteo.cfg, etc.), en accord avec les fichiers
+csv associés dans le répertoire features.

 
 
 
 

+Exécution
+=========
+
+Script principal
+----------------
+
+`make`
+
+ou
+
+`python main.py`
+
+
+Tâches planifiées
+-----------------
+
+- Lancer le scheduling (à compléter)
+
+`celery -A test_celery worker --loglevel=info`
+
+puis
+
+`python -m test_celery.run_tasks`