Commit 5dced4b5794cfb9474da44e7b7dd686aeb315471
1 parent
7453639646
Exists in
master
Licence and readme
Showing 2 changed files with 14 additions and 6 deletions Inline Diff
LICENSE.md
1 | Copyright 2018 Titouan PARCOLLT at ORKIS, aix en Provence and University of Avignon | ||
2 | |||
3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
4 | |||
5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
6 | |||
7 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
README.md
1 | Deep Quaternionary Convolutional Neural Networks | 1 | Quaternion-Valued Convolutional Neural Networks for End-to-End Automatic Speech Recognition |
2 | ===================== | 2 | ===================== |
3 | 3 | ||
4 | This repository contains code which reproduces experiments presented in | 4 | This repository contains code which reproduces experiments presented in |
5 | the paper ... | 5 | the paper [link incoming] |
6 | 6 | ||
7 | Requirements | 7 | Requirements |
8 | ------------ | 8 | ------------ |
9 | 9 | ||
10 | Install requirements for experiments with pip: | 10 | Install requirements for experiments with pip: |
11 | ``` | 11 | ``` |
12 | pip install numpy tensorflow-gpu keras | 12 | pip install numpy tensorflow-gpu keras theano |
13 | ``` | 13 | ``` |
14 | Depending on your Python installation you might want to use anaconda or other tools. | 14 | Depending on your Python installation you might want to use anaconda or other tools. |
15 | You can also go to the 'Installation' Section and execute the command for an automatic installation. | ||
15 | 16 | ||
16 | |||
17 | Installation | 17 | Installation |
18 | ------------ | 18 | ------------ |
19 | 19 | Install all the needed dependencies. | |
20 | ``` | 20 | ``` |
21 | python setup.py install | 21 | python setup.py install |
22 | ``` | 22 | ``` |
23 | 23 | ||
24 | Experiments | 24 | Experiments |
25 | ----------- | 25 | ----------- |
26 | 26 | ||
27 | 1. Get help: | 27 | 1. Get help: |
28 | 28 | ||
29 | ``` | 29 | ``` |
30 | python scripts/run.py train --help | 30 | python scripts/run.py train --help |
31 | ``` | 31 | ``` |
32 | 32 | ||
33 | 2. Run models: | 33 | 2. Run models: |
34 | 34 | ||
35 | ``` | 35 | ``` |
36 | python scripts/run.py train -w WORKDIR --model {real,complex,quaternion} --seg{chiheb,parcollet} --sf STARTFILTER --nb NUMBEROFBLOCKSPERSTAGE | 36 | python scripts/run.py train --model {real,quaternion} --sf STARTFILTER --nl NUMBEROFLAYERS |
37 | ``` | 37 | ``` |
38 | 38 | ||
39 | Other arguments may be added as well; Refer to run.py train --help for | 39 | Other arguments may be added as well; Refer to run.py train --help for |
40 | 40 | ||
41 | - Optimizer settings | 41 | - Optimizer settings |
42 | - Dropout rate | 42 | - Dropout rate |
43 | - Clipping | 43 | - Clipping |
44 | - Saving prefix | ||
44 | - ... | 45 | - ... |
45 | 46 | ||
46 | Citation | 47 | Citation |
47 | -------- | 48 | -------- |
48 | 49 | ||
49 | Please cite our work as | 50 | Please cite our work as |
50 | 51 | ||
51 | ``` | 52 | ``` |
52 | 53 | ||
53 | ``` | 54 | ``` |