joeweiss / birdnetlib

A python api for BirdNET-Lite and BirdNET-Analyzer
https://joeweiss.github.io/birdnetlib/
Apache License 2.0
41 stars 14 forks source link

Please document min_conf #117

Closed thk686 closed 3 months ago

thk686 commented 3 months ago

It may seem obvious. However, nowhere does it say what happens when you change this value. I assume that detections below this threshold are ignored. Better to be explicit.

In my particular case, I am not setting this and I am finding that the segment file belonging to a detection is sometimes missing after calling 'analyze'. I can't figure out why this would happen, so I am hoping for a bit more complete documentation. I will tighten up the code according to the examples and see if it helps.

thk686 commented 3 months ago

I looked at the code. Some docstring comments would be immensely useful.