diff --git a/README_BOMBYX.md b/README_BOMBYX.md index 4d621a1481ae3157ccbe0cc46b9c356cd1b068ef..e4b1fa293f2f531e5d4c54c7263782d6362c7ede 100644 --- a/README_BOMBYX.md +++ b/README_BOMBYX.md @@ -3,18 +3,18 @@ BOMBYX IPI extractor `IPI_bombyx.py` is a graphic utility made for the manual extraction of sperm whale inter pulse interval (IPI). It builds on the GUI of `ipi_extract.py`. The main features are thus explained in the corresponding [Read me](README.md). - +Some of the explanations here are specific to the member of the Dyni team working on this project. Option ------ -You can obtain a list of all the available option by typing +You can obtain a list of all the available options by typing `python IPI_bombyx.py -h` Usage ----- -If you're executing this script on one of the cube, you can simply launch the script by typing +If you're executing this script on one of the cubes, you can simply launch the script by typing `python path/to/passage_maxpred.pkl your_name_here` @@ -22,8 +22,8 @@ If you're on another server, you will need to set the `--wd` and `--done_file` o ### Number of done files -The number of currently files that have been labels is displayed on the bottom right, -along with the number of files that have been label by the current user. Note that labeled file that are not finished are not included in the count. +The number of currentl files that have been labeled is displayed on the bottom right, +along with the number of files that have been labeled by the current user. Note that labeled files that are not finished are not included in the count. ### Next button @@ -37,18 +37,18 @@ Thus, the shared `done_file.csv` ### Output file -This script will save the same kind of HdF file as `ipi_extract.py`. +This script will save the same kind of HDF file as `ipi_extract.py`. However, unlinked `ipi_extract.py` which output one file per annotated file, -this script will only create one database per annotators. +this script will only create one database per annotator. Changing the selling of the annotator will change the database associated. -In addition, of the columns saved in `ipi_extract.py`, this script also save the file, passage number and annotator name. +In addition, of the columns saved in `ipi_extract.py`, this script also saves the file, passage number, and annotator name. done_file.csv ------------- This file is used to record the progression of the annotation among all the users. -It contained the passage number of each passage that have been labeled. +It contained the passage number of each passage that has been labeled. If you don't know what you are doing, <span style="color:red">__⚠DO NOT TOUCH OR MODIFY THIS FILE⚠__</span>.