Updated Options in README.md

symblai · Dec 22, 2021 · 20efcd8 · 20efcd8
1 parent 8a20325
commit 20efcd8
Showing 1 changed file with 31 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -63,36 +63,37 @@ Synopsis
 
 Options
 
-  -o, --original file         Original File to be used as reference. Usually, this should be the            
-                              transcribed file by a Human being.                                            
-  -g, --generated file        File with the output generated by Speech Recognition System.                  
-  -e, --wer                   Default: true. Print Word Error Rate (WER).                                   
-  --distance                  Default: false. Print total word distance after comparison.                   
-  -e, --stats                 Default: false. Print statistics about original and generate files, before    
-                              and after pre-processing. Also prints statistics about word level and phrase  
-                              level differences.                                                            
-  --pairs                     Default: false. Print all the difference pairs with type of difference.       
-  -c, --textcomparison        Default: false. Print the text comparison between two files with              
-                              highlighting.                                                                 
-  -s, --removespeakers        Default: true. Remove the speaker at the start of each line in files before   
-                              calculations. The speaker should be separated by colon ":" i.e. speaker_name: 
-                              text For e.g. "John Doe: Hello, I am John." would get converted to simply     
-                              "Hello, I am John."                                                           
-  -a, --removeannotations     Default: true. Remove any custom annotations in the transcript before         
-                              calculations. This is useful when removing custom annotations done by human   
-                              transcribers.  Anything in square brackets [] are detected as annotations.    
-                              For e.g. "Hello, I am [inaudible 00:12] because of few reasons." would get    
-                              converted to "Hello, I am because of few reasons."                            
-  -w, --removewhitespaces     Default: true. Remove any extra white spaces before calculations.             
-  -q, --removequotes          Default: true. Remove any double quotes '"' from the files before             
-                              calculations.                                                                 
-  -d, --removedashes          Default: true. Remove any dashes (hyphens) "-" from the files before          
-                              calculations.                                                                 
-  -p, --removepunctuations    Default: true. Remove any punctuations ".,?!" from the files before           
-                              calculations.                                                                 
-  -l, --lowercase             Default: true. Convert both files to lower case before calculations. This is  
-                              useful if evaluation needs to be done in case-insensitive way.                
-  -h, --help                  Print this usage guide.                              
+  -o, --original file                 Original File to be used as reference. Usually, this should be the            
+                                      transcribed file by a Human being.                                            
+  -g, --generated file                File with the output generated by Speech Recognition System.                  
+  -e, --wer [true|false]              Default: true. Print Word Error Rate (WER).                                   
+  -i, --wil [true|false]              Default: true. Print Word Information Loss (WIL).                             
+  --distance [true|false]             Default: false. Print total word distance after comparison.                   
+  --stats [true|false]                Default: false. Print statistics about original and generate files, before    
+                                      and after pre-processing. Also prints statistics about word level and phrase  
+                                      level differences.                                                            
+  --pairs [true|false]                Default: false. Print all the difference pairs with type of difference.       
+  --textcomparison [true|false]       Default: false. Print the text comparison between two files with              
+                                      highlighting.                                                                 
+  --removespeakers [true|false]       Default: true. Remove the speaker at the start of each line in files before   
+                                      calculations. The speaker should be separated by colon ":" i.e. speaker_name: 
+                                      text For e.g. "John Doe: Hello, I am John." would get converted to simply     
+                                      "Hello, I am John."                                                           
+  --removeannotations [true|false]    Default: true. Remove any custom annotations in the transcript before         
+                                      calculations. This is useful when removing custom annotations done by human   
+                                      transcribers.  Anything in square brackets [] are detected as annotations.    
+                                      For e.g. "Hello, I am [inaudible 00:12] because of few reasons." would get    
+                                      converted to "Hello, I am because of few reasons."                            
+  --removewhitespaces [true|false]    Default: true. Remove any extra white spaces before calculations.             
+  --removequotes [true|false]         Default: true. Remove any double quotes '"' from the files before             
+                                      calculations.                                                                 
+  --removedashes [true|false]         Default: true. Remove any dashes (hyphens) "-" from the files before          
+                                      calculations.                                                                 
+  --removepunctuations [true|false]   Default: true. Remove any punctuations ".,?!" from the files before           
+                                      calculations.                                                                 
+  --lowercase [true|false]            Default: true. Convert both files to lower case before calculations. This is  
+                                      useful if evaluation needs to be done in case-insensitive way.                
+  --help [true|false]                 Print this usage guide.                                                                                   
 ```
 
 ## Getting help