Commit ff117f2ef0b5d6f3c882247aa9fd3152e64ce520

Authored by Quillot Mathias
1 parent e7d811503f
Exists in master

New way to install and remove volia using the makefile

Showing 2 changed files with 36 additions and 0 deletions Inline Diff

File was created 1 init:
2 pip install -r requirements.txt
3 pip install .
4 python -m volia.test
5
6 uninstall:
7 pip uninstall volia
8
1 # Introduction
2 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.
3
4 # Quick start
5 Utiliser volia est très simple.
6
7 ## Installer volia
8 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 :
9
10 ```
11 make
12 ```
13
14 ## Exécuter les scripts de n'importe où
15 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 :
16 ```
17 python -m volia.run-script
18 ```
19
20 Exemple :
21 ```
22 python -m volia.test
23 ```
24
25 Si *Volia* est bien installé sur votre machine, cette commande devrait pour retourner "Volia is well installed." dans votre terminal.
26
27
28 # Evolution
29 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.