diff --git a/README.md b/README.md index d3e22b78d1853e657753098ddd4879c474a8ff69..1cee319f971d4d33d0ace24c195df424cc0c1b2f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # Pitch Estimator +positional arguments: + file Folder of .preds (dictionnaries 'filename': model's + prediction array) + +optional arguments: + -h, --help show this help message and exit + --output OUTPUT Output folder, (default: ./) + --extend EXTEND Number of preds to extend the calls on the right side + (default: 0) + --pred_threshold PRED_THRESHOLD + Threshold for considering an prediction true (between + 0 and 1) (default: 0.9) + --display DISPLAY Boolean for displaying calls and their pitch (default: + False) + --saveimg SAVEIMG Path for saving vocalisation images (default: None) + --specific_time SPECIFIC_TIME + Date for running at specific time using pandas date + indexing, format : YYYY-MM-DD HH:MM:SS (default: None)