.. birdnet documentation master file, created by
   sphinx-quickstart on Wed Dec 10 07:43:17 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

birdnet documentation
=====================

Documentation for the birdnet package.

.. toctree::
   :maxdepth: 1
   :caption: Contents:
   
   quick_start
   setup
   general
   birdnet
   benchmarking
   models
   changelog

Introduction
------------

A Python library for identifying bird species by their sounds.

The library is geared towards providing a robust workflow for ecological data analysis in bioacoustic projects. While it covers essential functionalities, it doesn’t include all the features found in BirdNET-Analyzer, which is available `here <https://github.com/birdnet-team/BirdNET-Analyzer>`__. Some features might only be available in the BirdNET Analyzer and not in this package.

This project is under active development, so you might encounter changes that could affect your current workflow. We recommend checking for updates regularly.

The package is also available as an R package at: `birdnetR <https://github.com/birdnet-team/birdnetR>`__.

Citing BirdNET
-----------------------

Feel free to use BirdNET for your acoustic analyses and research. If you do, please cite as:

.. code-block:: bibtex

   @article{kahl2021birdnet,
     title={BirdNET: A deep learning solution for avian diversity monitoring},
     author={Kahl, Stefan and Wood, Connor M and Eibl, Maximilian and Klinck, Holger},
     journal={Ecological Informatics},
     volume={61},
     pages={101236},
     year={2021},
     publisher={Elsevier}
   }

License
-------

**Source Code**: The source code for this project is licensed under the `MIT License <https://opensource.org/licenses/MIT>`__

**Models**: The models used in this project are licensed under the `Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0) <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__

Please ensure you review and adhere to the specific license terms provided with each model.

*Please note that all educational and research purposes are considered non-commercial use and it is therefore freely permitted to use BirdNET models in any way.*

Funding
-------

Our work in the K. Lisa Yang Center for Conservation Bioacoustics is made possible by the generosity of K. Lisa Yang to advance innovative conservation technologies to inspire and inform the conservation of wildlife and habitats.

The development of BirdNET is supported by the German Federal Ministry of Research, Technology and Space (FKZ 01|S22072), the German Federal Ministry for the Environment, Climate Action, Nature Conservation and Nuclear Safety (FKZ 67KI31040E), the German Federal Ministry of Economic Affairs and Energy (FKZ 16KN095550), the Deutsche Bundesstiftung Umwelt (project 39263/01) and the European Social Fund.

Partners
----

BirdNET is a joint effort of partners from academia and industry.
Without these partnerships, this project would not have been possible.
Thank you!

.. image:: https://tuc.cloud/index.php/s/KSdWfX5CnSRpRgQ/download/box_logos.png
   :alt: Our partners
   :align: center
   :width: 600px