Skip to content
Snippets Groups Projects
Commit 5af9e3a6 authored by ferrari's avatar ferrari
Browse files

Fix typos

parent 4f358be9
Branches
No related tags found
No related merge requests found
...@@ -3,18 +3,18 @@ BOMBYX IPI extractor ...@@ -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). `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). 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 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` `python IPI_bombyx.py -h`
Usage 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` `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 ...@@ -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 ### Number of done files
The number of currently files that have been labels is displayed on the bottom right, The number of currentl files that have been labeled 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. 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 ### Next button
...@@ -37,18 +37,18 @@ Thus, the shared `done_file.csv` ...@@ -37,18 +37,18 @@ Thus, the shared `done_file.csv`
### Output file ### 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, 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. 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 done_file.csv
------------- -------------
This file is used to record the progression of the annotation among all the users. 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">__&#x26a0;DO NOT TOUCH OR MODIFY THIS FILE&#x26a0;__</span>. If you don't know what you are doing, <span style="color:red">__&#x26a0;DO NOT TOUCH OR MODIFY THIS FILE&#x26a0;__</span>.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment