From 99081e441aa29e3c4873be9ac14f8260965c0e74 Mon Sep 17 00:00:00 2001 From: ecibelli Date: Mon, 27 Jun 2016 11:18:21 -0500 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f4e645b..fc5f7a2 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,24 @@ DeepFormants Shua Dissen (shua.dissen@gmail.com) Joseph Keshet (joseph.keshet@biu.ac.il) -Formant Tracking & Estimation +Formant Tracking and Estimation -DeepFormants is a software package for formant tracking $and; estimation, using two algorithms based on deep networks. It works as follows: -* The user provides wav file -* Optionally the user can provide a start and an end times in seconds -* A classifer is - -This is a beta version of Autovot. 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. +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 a stop-initial consonant. +* Optionally, the user can designate a window for estimation by providing a start and end time (specified in seconds). +* A classifer is used to estimate the formants in the file, with two modes: +* Estimation: If a time window is specified, a single estimate is made for F1-F3 within that window. +* Tracking: If no time window is given, the model will track F1-F3 and give a measurement at every 10 milliseconds across the lenght of the file. +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 wav file, formant output filename and the vowel begin and end times +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 and it will return the formants for the whole wav file every 10 ms +For formant tracking, just call the script with the wav file and output filename: ```Ex: $ python formants.py Example.wav examplePredictions```