.

README.md

@@ -1,8 +1,9 @@
 DeepFormants
 ============
 
-Shua Dissen (shua.dissen@gmail.com)
-Joseph Keshet (joseph.keshet@biu.ac.il)             
+Shua Dissen (shua.dissen@gmail.com)            
+Joseph Keshet (joseph.keshet@biu.ac.il)  
+
 
 DeepFormants is a software package for formant tracking and estimation, using two algorithms based on deep networks. It works as follows:
 * The user provides a wav file with an initial stop consonant. 
@@ -13,19 +14,12 @@ DeepFormants is a software package for formant tracking and estimation, using tw
 
 This is a beta version of DeepFormants. Any reports of bugs, comments on how to improve the software or documentation, or questions are greatly appreciated, and should be sent to the authors at the addresses given above.
 
-How to use:
+---
 
-For vowel formant estimation, call the main script in a terminal with the following inputs: wav file, formant output filename, and the vowel begin and end times:
 
-```Ex: $ python formants.py Example.wav ExamplePredictions.csv --begin 1.2 --end 1.3```
+## Installation instructions
 
-For formant tracking, just call the script with the wav file and output filename:
-
-```Ex: $ python formants.py Example.wav ExamplePredictions.csv```
-
-Installation instructions
-
-Download the code.
+Download the code. The code is based on signal processing package in Python called [Talkbox] (https://pypi.python.org/pypi/scikits.talkbox) and a deep networks package called [Torch] (torch.ch).
 
 Dependencies:
 Run these lines in a terminal to install everything necessary for feature extraction.
@@ -43,13 +37,22 @@ cd ~/torch; bash install-deps;
 ./install.sh
 ```
 
-recommended use the pre-trained estimation and tracking models.
-
 The Estimation model can be downloaded here and because of size constraints the Tracking model can be abtained by download from this link
+[tracking_model.mat] (http://u.cs.biu.ac.il/~jkeshet/deep_formants/tracking_model.dat)
 
-http://u.cs.biu.ac.il/~jkeshet/deep_formants/Tracking_model.dat
+## How to use:
+
+For vowel formant estimation, call the main script in a terminal with the following inputs: wav file, formant output filename, and the vowel begin and end times:
+
+```Ex: $ python formants.py Example.wav examplePredictions --begin 1.2 --end 1.3```
+
+For formant tracking, just call the script with the wav file and output filename:
+
+```Ex: $ python formants.py Example.wav examplePredictions```
 
 
-TODO
+## TODO
+
+Add training code.
+
 
-add training code