Quillot Mathias / volia

Download as
Browse Code »

Commit 19286235b9667f149749e17e732a11f7c1820f5a

Authored by Quillot Mathias
1 parent e424b6d266
Exists in master

Nouvelle solution grace au fichier init

Showing 1 changed file with 4 additions and 1 deletions Inline Diff

1 # Introduction 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. 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 3
4 # Quick start 4 # Quick start
5 Utiliser volia est très simple. 5 Utiliser volia est très simple.
6 6
7 ## Installer volia 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 : 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 9
10 ``` 10 ```
11 make 11 make
12 ``` 12 ```
13 13
14 ## Exécuter les scripts de n'importe où 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 : 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 ``` 16 ```
17 python -m volia.run-script 17 python -m volia.run-script
18 ``` 18 ```
19 19
20 Exemple : 20 Exemple :
21 ``` 21 ```
22 python -m volia.test 22 python -m volia.test
23 ``` 23 ```
24 24
25 Si *Volia* est bien installé sur votre machine, cette commande devrait pour retourner "Volia is well installed." dans votre terminal. 25 Si *Volia* est bien installé sur votre machine, cette commande devrait pour retourner "Volia is well installed." dans votre terminal.
26 26
27 27
28 # Evolution 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. 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.
30
31 En fait, j'ai peut-être une nouvelle solution. Grâce aux fichiers *__init__*, j'ai trouvé une méthode pour facilement ajouter au path les parents. De cette manière, je peux créer des scripts dans des sous dossiers qui pourront appeler aisément les modules du *core*, par exemple.
32