Commit a55b8fd4a15ea25b190519c4ca1f6bca2da5ce7e
1 parent
2d40c87d65
Exists in
master
Simple test
Showing 1 changed file with 3 additions and 1 deletions Inline Diff
README.md
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 | |||
5 | Encore un test ici. | ||
4 | # Quick start | 6 | # Quick start |
5 | Utiliser volia est très simple. | 7 | Utiliser volia est très simple. |
6 | 8 | ||
7 | ## Installer volia | 9 | ## 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 : | 10 | 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 | 11 | ||
10 | ``` | 12 | ``` |
11 | make | 13 | make |
12 | ``` | 14 | ``` |
13 | 15 | ||
14 | ## Exécuter les scripts de n'importe où | 16 | ## 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 : | 17 | 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 | ``` | 18 | ``` |
17 | python -m volia.run-script | 19 | python -m volia.run-script |
18 | ``` | 20 | ``` |
19 | 21 | ||
20 | Exemple : | 22 | Exemple : |
21 | ``` | 23 | ``` |
22 | python -m volia.test | 24 | python -m volia.test |
23 | ``` | 25 | ``` |
24 | 26 | ||
25 | Si *Volia* est bien installé sur votre machine, cette commande devrait pour retourner "Volia is well installed." dans votre terminal. | 27 | Si *Volia* est bien installé sur votre machine, cette commande devrait pour retourner "Volia is well installed." dans votre terminal. |
26 | 28 | ||
27 | 29 | ||
28 | # Evolution | 30 | # 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. | 31 | 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 | 32 | ||
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. | 33 | 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 | 34 | ||
35 |