Skip to content

Commit

Permalink
Purge of references to "chirpity model"
Browse files Browse the repository at this point in the history
fix error for detections with no IUCN record.
  • Loading branch information
Mattk70 committed Oct 29, 2024
1 parent 5ce1204 commit 2d8cfba
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 23 deletions.
2 changes: 1 addition & 1 deletion Help/ebird.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<td><b>Why did you choose eBird? Do you have plans to allow sharing with other sites?</b></td>
<td>
<p>eBird is the simplest platform to use. This is because it has a published record format, and perhaps most importantly, the eBird taxonomy aligns to the one
used by the both the BirdNET and Chirpity models.</p>
used by the both the BirdNET and Nocmig models.</p>
<p>I hope to offer the ability to share audio clips with Xeno-Canto in a future release. This depends on them releasing a suitable upload API.</p>
</td>
</tr>
Expand Down
19 changes: 6 additions & 13 deletions Help/settings.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<td>Choose the model to use for detection.
<ul>
<li>
<b>Chirpity</b> will use the native Chirpity model for analysis.
<b>Nocmig</b> will use a model tuned for the nocturnal flight calls of European birds for analysis.
</li>
<li>
<b>BirdNET</b> will use the <a href="https://github.com/kahst/BirdNET-Analyzer" target="_blank">BirdNET</a> model developed by Stefan Kahl et al. from the K. Lisa Yang Center for Conservation Bioacoustics
Expand Down Expand Up @@ -51,7 +51,7 @@
<li>Precisely define the detections you would like Chirpity to report on</li>
<li>Search only for a specific species</li>
</ol>
You may use a different custom list for both BirdNET and Chirpity models. The format for a
You may use a different custom list for both BirdNET and Nocmig models. The format for a
custom list file is "scientific name_common name", with each species on a new line. <b>Importantly, the custom list needs to use labels in your selected language.</b> You can export a starting
list in the correct format from the Help menu, using the "<i>What species are detected?</i>" link.
</td>
Expand Down Expand Up @@ -118,7 +118,7 @@
</tr>
<tr>
<th>Backend</th>
<td>This option is only visible when using the Chirpity model. Choose how predictions are calculated on you computer.
<td>This option is only visible when using the Nocmig model. Choose how predictions are calculated on you computer.
<ul>
<li>
<b>CPU</b> will use the CPU for predictions, this is generally faster if you have an integrated
Expand All @@ -132,7 +132,7 @@
<b>WebGPU</b> This employs a new technology and will also use graphics processors. It is similar to WebGL,
but is known to speed up the processing times on Macs, unlike WebGL. WebGPU uses more memory than WebGL, and
if the threads or batch size values are set too high, Chirpity may run out of memory. If this happens
the spectrogram will disappear from the screen. Use a lower value for threads and / or batch size.
the spectrogram may disappear from the screen or the app may become unresponsive. Use a lower value for threads and / or batch size.
</li>
</ul>
</td>
Expand Down Expand Up @@ -292,13 +292,13 @@
</tr>
<tr>
<th>Context Mode</th>
<td> This mode is only available for the native Chirpity model. When enabled, the model will use the surrounding context when making predictions. This helps mitigate
<td> This mode is only available for the Nocmig model. When enabled, the model will use the surrounding context when making predictions. This helps mitigate
against false positive detections.
</td>
</tr>
<tr>
<th>SNR filter</th>
<td>This setting is also only available for the native Chirpity model. The SNR (Signal to Noise Ratio) filter can only be enabled when using the CPU backend.
<td>This setting is also only available for the Nocmig model. The SNR (Signal to Noise Ratio) filter can only be enabled when using the CPU backend.
When enabled, Chirpity will disregard audio segments with no distinct sound event.
A stronger signal is required for a prediction to be attempted when higher signal-to-noise values are set.
The purpose is to deliver significant speed gains, however, the setting may cause Chirpity to miss quieter, more distant calls.
Expand All @@ -312,13 +312,6 @@
This is <b>extremely </b> useful if you want to report a bug - as you can share a screenshot of any errors that appear (these will show up in red in the console).
</td>
</tr>
<tr>
<th>Opt out of usage analytics</th>
<td>
Chirpity sends usage information anonymously to an analytics server. This information is used to help understand how people use Chirpity, and try to identify any bugs
or errors. Both help improve the software and prioritise changes for future releases. If you would prefer that Chirpity did not send any usage data, you can disable it here.
</td>
</tr>
</table>

</body>
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Author: Matthew Kirkland
![image](https://github.com/Mattk70/Chirpity-Electron/assets/61826357/96b0af44-3893-4288-8291-cf0f6db89a38)

## Key Features
- Uses two Machine Learning models to identify audio files based on the user's needs: BirdNET and the Chirpity model
- Uses two Machine Learning models to identify audio files based on the user's needs: BirdNET and the Nocmig model
- Supports audio input files such as WAV, MP3, MP4/M4A, AAC, Opus, Ogg, and FLAC
- Audio analysis can run in the background while exploring the application
- Tailor species detection based on the season, time of day, or a custom list of species
Expand Down Expand Up @@ -51,7 +51,7 @@ Initialize the source directory with:
npm init
```

Now, install project dependencoies with:
Now, install project dependencies with:

```
npm install --save-dev
Expand Down
6 changes: 3 additions & 3 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ <h5 class="offcanvas-title" id="offcanvasExampleLabel">Settings</h5>
<input class="form-check-input" type="checkbox" role="switch" id="iucn">
<label class="form-check-label" for="iucn">Show species IUCN Red List status in summary.</label>
<a class="circle" tabindex="-1" data-bs-toggle="popover" data-bs-trigger="focus" data-bs-title="Red List Status" id="IUCN-circle-help"
data-bs-content="When enabled, the latest Global ICUN assessment status is displayed for each species in the summary. The icon links to the assesment page on the ICUN website. The Assessment Scope will display the IUCN assessment of the species in that region (where available).">?</a>
data-bs-content="When enabled, the latest Global IUCN assessment status is displayed for each species in the summary. The icon links to the assessment page on the IUCN website. The Assessment Scope will display the IUCN assessment of the species in that region (where available).">?</a>
</div>
</div>
<div class="pe-3 input-group rounded p-2 mb-1">
Expand Down Expand Up @@ -637,7 +637,7 @@ <h5 class="text-center">Getting Started</h5>
<li>First off, set your location in the settings menu.</li>
<li>Next, consider which model best suits your needs:</li>
<ul>
<li><b>Chirpity</b> is tuned for nocturnal migration,<br> but only has birds on the British list</li>
<li><b>Nocmig</b> is tuned for nocturnal migration,<br> but only has birds on the British list</li>
<li><b>BirdNET</b> is trained on global bird species</li>
</ul>
</ol>
Expand All @@ -653,7 +653,7 @@ <h5>Quick access settings panel</h5>
<ol class="text-start ps-5">
<li>Nocmig mode</li>
<li>Audio filters</li>
<li>Context-aware mode (Chirpity model only)</li>
<li>Context-aware mode (Nocmig model only)</li>
<li>Frequency range adjustment for the spectrogram</li>
<li>Which detection list to use</li>
<li>And the confidence threshold</li>
Expand Down
8 changes: 4 additions & 4 deletions js/ui.js
Original file line number Diff line number Diff line change
Expand Up @@ -3161,19 +3161,19 @@ function centreSpec(){

if (showIUCN) {
const record = await getIUCNStatus(item.sname);
const iucn = record.scopes.find(obj => obj.scope === config.detect.iucnScope);
// there might not be a record...
const iucn = record?.scopes.find(obj => obj.scope === config.detect.iucnScope);
const status = iucn?.status || 'NA';
const url = iucn?.url ? 'https://www.iucnredlist.org/species/' + iucn.url : null;
const redListIcon = status;

summaryHTML+=
`<td class="text-end"><a title="${IUCNLabel[status]}: Learn more about this species ICUN assessment"
class="d-inline-block p-1 w-100 rounded text-decoration-none text-center ${IUCNMap[redListIcon]} ${!url ? 'disabled-link' : ''}"
href="${url || '#'}" target="_blank"> ${redListIcon}</a></td>`;
href="${url || '#'}" target="_blank"> ${status}</a></td>`;
}
summaryHTML += `<td class="text-end">${item.count}</td>
<td class="text-end">${item.calls}</td>
</tr>`;

}
summaryHTML += '</tbody></table>';
// Get rid of flicker...
Expand Down

0 comments on commit 2d8cfba

Please sign in to comment.