diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..ab47d3a --- /dev/null +++ b/Makefile @@ -0,0 +1,7 @@ +init: + pip install -r requirements.txt + pip install . + python -m volia.test + +uninstall: + pip uninstall volia diff --git a/README.md b/README.md index e69de29..4bb3ceb 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,29 @@ +# Introduction +Volia est une librairie python pour le machine learning dédié au *speech*. Elle est accompagnée par un ensemble de scripts qui permettent de gérer des données et entraîner des modèles, sortir des rapports d'analyses, des benchmark etc. + +# Quick start +Utiliser volia est très simple. + +## Installer volia +Volia n'étant pas un *repository* officiel PyPi, vous devez l'installer en mode *développement*. Pour ce faire, vous pouvez utiliser le *Makefile* en exécutant la commande suivante : + +``` +make +``` + +## Exécuter les scripts de n'importe où +Vous pouvez lancer des scripts depuis n'importe quel chemin de votre ordinateur. Pour cela, il suffit de lancer la commande suivante en remplaçant *run-script* par le nom du module à lancer : +``` +python -m volia.run-script +``` + +Exemple : +``` +python -m volia.test +``` + +Si *Volia* est bien installé sur votre machine, cette commande devrait pour retourner "Volia is well installed." dans votre terminal. + + +# Evolution +Un jour, si ce *repository* devient trop volumineux, je créerai un deuxième *repository* seulement composé des scripts. Ce qui m'embête avec cette approche est le lien entre la version du *repository* volia et celui des scripts. Je suis donc en train de réfléchir à une solution pour organiser mon code proprement et bien séparer la partie *script* de la partie *bibliothèque* de Volia. \ No newline at end of file