API Type

BirdBox is a Python library. There is no server, no HTTP endpoint, and no REST API. You import the classes directly into your own Python scripts and call them as regular functions.

from inference.detect_birds import BirdCallDetector   # ← local Python import

If you are looking for a point-and-click interface or want to run detection without writing code, use the CLI Reference or the Streamlit demo instead.

Module Overview¶

Module	Key class / function	What it does
`inference.detect_birds`	`BirdCallDetector`	Load a model and run detection on audio files
`evaluation.f_beta_score_analysis`	`FBetaScoreAnalyzer`	Sweep confidence thresholds, compute F-beta scores
`evaluation.filter_and_merge_detections`	`DetectionFilter`	Filter raw detections by confidence and merge into song segments
`evaluation.confusion_matrix_analysis`	`ConfusionMatrixAnalyzer`	Build a per-species confusion matrix

Setup¶

Make sure BirdBox is installed and your working directory is the project root before importing:

import sys
sys.path.insert(0, "src")   # only needed when running outside the installed package

from inference.detect_birds import BirdCallDetector

See Installation for the full setup instructions.