Skip to content

Commit f5c1f58

Browse files
authored
Update showroom (#828)
* Added BirdOMatic to showroom * updated species list guide * shortened the text
1 parent b12b16d commit f5c1f58

4 files changed

Lines changed: 38 additions & 15 deletions

File tree

docs/_static/birdomatic.jpg

45.6 KB
Loading

docs/best-practices/evaluation-tool.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Once you have uploaded and mapped your files, the system automatically extracts
8787
Customize the evaluation process by adjusting the following parameters:
8888

8989
* **Sample Duration (s)**: The length of each audio segment. (Default: 3 seconds – matching BirdNET’s prediction segment.)
90-
* **Recording Duration **: Explicitly set the recording duration. (Default: The recording duration is automatically inferred from your files.)
90+
* **Recording Duration**: Explicitly set the recording duration. (Default: The recording duration is automatically inferred from your files.)
9191
* **Minimum Overlap (s)**: The minimum time overlap between an annotation and a prediction for them to be considered a match. (Default: 0.5 seconds)
9292
* **Threshold**: The cut-off value to decide if a prediction is positive. (Default: 0.1)
9393
* **Class-wise Metrics**: Toggle this option if you want to compute performance metrics for each class individually. If disabled, metrics are averaged across all classes.
@@ -143,40 +143,40 @@ After configuring your files and parameters, use the action buttons to execute t
143143
9. Step-by-Step Usage
144144
---------------------------------
145145

146-
1. File Upload
147-
######################
146+
1. File Upload
147+
##############
148148

149149
* Navigate to the File Selection section.
150150
* Upload your annotation and prediction files using the provided file dialog or drag-and-drop interface.
151151

152-
2. Column Mapping
153-
######################
152+
2. Column Mapping
153+
#################
154154

155155
* Review and adjust the column mappings using the drop-down menus to match your file’s structure.
156156

157-
3. Optional Class Mapping
158-
######################
157+
3. Optional Class Mapping
158+
#########################
159159

160160
* If your class names differ between annotation and prediction files, download the JSON template, update it, and then upload the class mapping file.
161161

162-
4. Select Classes and Recordings
163-
######################
162+
4. Select Classes and Recordings
163+
################################
164164

165165
* Use the checkbox groups to select the specific classes and recordings you want to evaluate.
166166

167-
5. Set Parameters
168-
######################
167+
5. Set Parameters
168+
#################
169169

170170
* Adjust the sample duration, recording duration, minimum overlap, and threshold values.
171171
* Toggle the Class-wise Metrics option if you require individual class evaluations.
172172

173-
6. Select Metrics
174-
######################
173+
6. Select Metrics
174+
#################
175175

176176
* Check the boxes for the performance metrics (AUROC, Precision, Recall, F1 Score, AP, Accuracy) you wish to compute and visualize.
177177

178-
7. Execute Evaluation and Visualizations
179-
######################
178+
7. Execute Evaluation and Visualizations
179+
########################################
180180

181181
* Click Calculate Metrics to process the data.
182182
* Generate visualizations by clicking on Plot Metrics, Plot Confusion Matrix, or Plot Metrics All Thresholds

docs/best-practices/species-lists.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,17 @@ When editing your own `species_list.txt` file, make sure to copy species names f
66
You can find label files in the checkpoints folder, e.g., `checkpoints/V2.4/BirdNET_GLOBAL_6K_V2.4_Labels.txt`.
77

88
Species names need to consist of `scientific name_common name` to be valid.
9+
If you want to use the Perch model, you have to use their naming convention, which is just `scientific name`.
10+
For examples check the respective label files.
911

1012
You can generate a species list for a given location using :ref:`birdnet_analyzer.species <cli-species>`.
1113

14+
.. note::
15+
The checkpoints folder can be found in the installation directory of BirdNET-Analyzer.
16+
If you're using BirdNET-Analyzer from GitHub, you can access the checkpoints folder once the analyzer has run at least once, because the model is downloaded in the background.
17+
18+
Alternatively, you can manually download the model checkpoint `here <https://tuc.cloud/index.php/s/886x39f5N3sdsAM/download/V2.4.zip>`_.
19+
1220
Practical Information and Considerations
1321
----------------------------------------
1422

docs/showroom.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,21 @@ These are some highlights, make sure to check them out!
166166

167167
| Learn more at: `ribbit.edi.eco <https://ribbit.edi.eco/>`_
168168
169+
* - .. image:: _static/birdomatic.jpg
170+
:alt: Birdomatic
171+
:align: center
172+
:target: https://www.birdomatic.com/
173+
174+
- | **BirdOMatic**
175+
176+
BirdOMatic is a fun personal "workbench" project that allows users to slice and dice the millions of IDs that BirdNET found in our 40 terabytes of audio data (5+ years, 40 hours a day across 6 recorders).
177+
It offers flexible filtering, sorting, and search functions and provides access to spectrograms, weather data, and recording files
178+
Available to anyone (researchers, teachers, birders) on the web.
179+
The full BirdNET-ID dataset is available on request.
180+
The project code is on GitHub and there's lots of documentation for those who would like to replicate all this for your own project.
181+
182+
| Learn more at: `BirdOMatic <https://www.BirdOMatic.com>`_, `Docs <https://docs.birdomatic.com/>`_ and `GitHub <https://github.com/PGBWB-team/bird-workbench>`_
183+
169184
**Other cool projects:**
170185

171186
* BirdCAGE is an application for monitoring the bird songs in audio streams: `BirdCAGE at GitHub <https://github.com/mmcc-xx/BirdCAGE>`_

0 commit comments

Comments
 (0)