birdnet-analyzer 2.0.0__py3-none-any.whl

birdnet_analyzer/translate.py

@@ -0,0 +1,104 @@
+"""Module for translating species labels.
+
+Can be used to translate species names into other languages.
+
+Uses the requests to the eBird-API.
+"""
+import json
+import os
+import urllib.request
+
+import birdnet_analyzer.config as cfg
+import birdnet_analyzer.utils as utils
+
+LOCALES = ['af', 'ar', 'cs', 'da', 'de', 'en_uk', 'es', 'fi', 'fr', 'hu', 'it', 'ja', 'ko', 'nl', 'no', 'pl', 'pt_BR', 'pt_PT', 'ro', 'ru', 'sk', 'sl', 'sv', 'th', 'tr', 'uk', 'zh']
+""" Locales for 26 common languages (according to GitHub Copilot) """
+
+API_TOKEN = "yourAPIToken"
+""" Sign up for your personal access token here: https://ebird.org/api/keygen """
+
+
+def get_locale_data(locale: str):
+    """Download eBird locale species data.
+
+    Requests the locale data through the eBird API.
+
+    Args:
+        locale: Two character string of a language.
+
+    Returns:
+        A data object containing the response from eBird.
+    """
+    url = "https://api.ebird.org/v2/ref/taxonomy/ebird?cat=species&fmt=json&locale=" + locale
+    header = {"X-eBirdAPIToken": API_TOKEN}
+
+    req = urllib.request.Request(url, headers=header)
+    response = urllib.request.urlopen(req)
+
+    return json.loads(response.read())
+
+
+def translate(locale: str):
+    """Translates species names for a locale.
+
+    Translates species names for the given language with the eBird API.
+
+    Args:
+        locale: Two character string of a language.
+    
+    Returns:
+        The translated list of labels.
+    """
+    print(f"Translating species names for {locale}...", end="", flush=True)
+
+    # Get locale data
+    data = get_locale_data(locale)
+
+    # Create list of translated labels
+    labels: list[str] = []
+
+    for label in cfg.LABELS:
+        has_translation = False
+        for entry in data:
+            if label.split("_", 1)[0] == entry["sciName"]:
+                labels.append("{}_{}".format(label.split("_", 1)[0], entry["comName"]))
+                has_translation = True
+                break
+        if not has_translation:
+            labels.append(label)
+
+    print("Done.", flush=True)
+
+    return labels
+
+
+def save_labels_file(labels: list[str], locale: str):
+    """Saves localized labels to a file.
+
+    Saves the given labels into a file with the format:
+    "{config.LABELSFILE}_{locale}.txt"
+
+    Args:
+        labels: List of labels.
+        locale: Two character string of a language.
+    """
+    # Create folder
+    os.makedirs(cfg.TRANSLATED_LABELS_PATH, exist_ok=True)
+
+    # Save labels file
+    fpath = os.path.join(
+        cfg.TRANSLATED_LABELS_PATH, "{}_{}.txt".format(os.path.basename(cfg.LABELS_FILE).rsplit(".", 1)[0], locale)
+    )
+    with open(fpath, "w", encoding="utf-8") as f:
+        for label in labels:
+            f.write(label + "\n")
+
+
+if __name__ == "__main__":
+    # Load labels
+    cfg.LABELS = utils.read_lines(cfg.LABELS_FILE)
+
+    # Translate labels
+    for locale in LOCALES:
+        labels = translate(locale)
+        save_labels_file(labels, locale)

birdnet_analyzer/utils.py

@@ -0,0 +1,419 @@
+"""Module containing common function."""
+
+import sys
+import itertools
+import os
+import traceback
+from pathlib import Path
+
+import birdnet_analyzer.config as cfg
+
+SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))
+FROZEN = getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS")
+
+
+def runtime_error_handler(f: callable):
+    """Decorator to catch runtime errors and write them to the error log.
+
+    Args:
+        f: The function to be decorated.
+
+    Returns:
+        The decorated function.
+    """
+
+    def wrapper(*args, **kwargs):
+        try:
+            return f(*args, **kwargs)
+        except Exception as ex:
+            write_error_log(ex)
+            raise
+
+    return wrapper
+
+
+def batched(iterable, n, *, strict=False):
+    # TODO: Remove this function when Python 3.12 is the minimum version
+    # batched('ABCDEFG', 3) → ABC DEF G
+    if n < 1:
+        raise ValueError("n must be at least one")
+    iterator = iter(iterable)
+    while batch := tuple(itertools.islice(iterator, n)):
+        if strict and len(batch) != n:
+            raise ValueError("batched(): incomplete batch")
+        yield batch
+
+
+def spectrogram_from_file(path, fig_num=None, fig_size=None, offset=0, duration=None, fmin=None, fmax=None, speed=1.0):
+    """
+    Generate a spectrogram from an audio file.
+
+    Parameters:
+    path (str): The path to the audio file.
+
+    Returns:
+    matplotlib.figure.Figure: The generated spectrogram figure.
+    """
+    import birdnet_analyzer.audio as audio
+
+    # s, sr = librosa.load(path, offset=offset, duration=duration)
+    s, sr = audio.open_audio_file(path, offset=offset, duration=duration, fmin=fmin, fmax=fmax, speed=speed)
+
+    return spectrogram_from_audio(s, sr, fig_num, fig_size)
+
+
+def spectrogram_from_audio(s, sr, fig_num=None, fig_size=None):
+    """
+    Generate a spectrogram from an audio signal.
+
+    Parameters:
+    s: The signal
+    sr: The sample rate
+
+    Returns:
+    matplotlib.figure.Figure: The generated spectrogram figure.
+    """
+    import librosa
+    import librosa.display
+    import matplotlib
+    import matplotlib.pyplot as plt
+    import numpy as np
+
+    matplotlib.use("agg")
+
+    if isinstance(fig_size, tuple):
+        f = plt.figure(fig_num, figsize=fig_size)
+    elif fig_size == "auto":
+        duration = librosa.get_duration(y=s, sr=sr)
+        width = min(12, max(3, duration / 10))
+        f = plt.figure(fig_num, figsize=(width, 3))
+    else:
+        f = plt.figure(fig_num)
+
+    f.clf()
+
+    ax = f.add_subplot(111)
+
+    ax.set_axis_off()
+    f.tight_layout(pad=0)
+
+    D = librosa.stft(s, n_fft=1024, hop_length=512)  # STFT of y
+    S_db = librosa.amplitude_to_db(np.abs(D), ref=np.max)
+
+    return librosa.display.specshow(S_db, ax=ax, n_fft=1024, hop_length=512).figure
+
+
+def collect_audio_files(path: str, max_files: int = None):
+    """Collects all audio files in the given directory.
+
+    Args:
+        path: The directory to be searched.
+
+    Returns:
+        A sorted list of all audio files in the directory.
+    """
+    # Get all files in directory with os.walk
+    files = []
+
+    for root, _, flist in os.walk(path):
+        for f in flist:
+            if not f.startswith(".") and f.rsplit(".", 1)[-1].lower() in cfg.ALLOWED_FILETYPES:
+                files.append(os.path.join(root, f))
+
+                if max_files and len(files) >= max_files:
+                    return sorted(files)
+
+    return sorted(files)
+
+
+def collect_all_files(path: str, filetypes: list[str], pattern: str = ""):
+    """Collects all files of the given filetypes in the given directory.
+
+    Args:
+        path: The directory to be searched.
+        filetypes: A list of filetypes to be collected.
+
+    Returns:
+        A sorted list of all files in the directory.
+    """
+
+    files = []
+
+    for root, _, flist in os.walk(path):
+        for f in flist:
+            if not f.startswith(".") and f.rsplit(".", 1)[-1].lower() in filetypes and (pattern in f or not pattern):
+                files.append(os.path.join(root, f))
+
+    return sorted(files)
+
+
+def read_lines(path: str):
+    """Reads the lines into a list.
+
+    Opens the file and reads its contents into a list.
+    It is expected to have one line for each species or label.
+
+    Args:
+        path: Absolute path to the species file.
+
+    Returns:
+        A list of all species inside the file.
+    """
+    return Path(path).read_text(encoding="utf-8").splitlines() if path else []
+
+
+def list_subdirectories(path: str):
+    """Lists all directories inside a path.
+
+    Retrieves all the subdirectories in a given path without recursion.
+
+    Args:
+        path: Directory to be searched.
+
+    Returns:
+        A filter sequence containing the absolute paths to all directories.
+    """
+    return filter(lambda el: os.path.isdir(os.path.join(path, el)), os.listdir(path))
+
+
+def save_to_cache(path, x_train, y_train, x_test, y_test, labels):
+    """Saves training data to cache.
+
+    Args:
+        path: Path to the cache file.
+        x_train: Training samples.
+        y_train: Training labels.
+        x_test: Test samples.
+        y_test: Test labels.
+        labels: Labels.
+    """
+    import numpy as np
+
+    # Make directory if needed
+    directory = os.path.dirname(path)
+    if directory and not os.path.exists(directory):
+        os.makedirs(directory)
+
+    # Save cache file with training data, test data, labels and configuration
+    np.savez(
+        path,
+        x_train=x_train,
+        y_train=y_train,
+        x_test=x_test,
+        y_test=y_test,
+        labels=np.array(labels, dtype=object),
+        binary_classification=cfg.BINARY_CLASSIFICATION,
+        multi_label=cfg.MULTI_LABEL,
+        fmin=cfg.BANDPASS_FMIN,
+        fmax=cfg.BANDPASS_FMAX,
+        audio_speed=cfg.AUDIO_SPEED,
+        crop_mode=cfg.SAMPLE_CROP_MODE,
+        overlap=cfg.SIG_OVERLAP,
+    )
+
+
+def load_from_cache(path):
+    """Loads training data from cache.
+
+    Args:
+        path: Path to the cache file.
+
+    Returns:
+        A tuple of (x_train, y_train, labels, binary_classification, multi_label).
+    """
+    import numpy as np
+
+    # Load cache file
+    data = np.load(path, allow_pickle=True)
+
+    # Check if cache contains needed preprocessing parameters
+    if "fmin" in data and "fmax" in data and "audio_speed" in data and "crop_mode" in data and "overlap" in data:
+        # Check if preprocessing parameters match current settings
+        if (
+            data["fmin"] != cfg.BANDPASS_FMIN
+            or data["fmax"] != cfg.BANDPASS_FMAX
+            or data["audio_speed"] != cfg.AUDIO_SPEED
+            or data["crop_mode"] != cfg.SAMPLE_CROP_MODE
+            or data["overlap"] != cfg.SIG_OVERLAP
+        ):
+            print("\t...WARNING: Cache preprocessing parameters don't match current settings!", flush=True)
+            print(f"\t   Cache: fmin={data['fmin']}, fmax={data['fmax']}, speed={data['audio_speed']}", flush=True)
+            print(f"\t   Cache: crop_mode={data['crop_mode']}, overlap={data['overlap']}", flush=True)
+            print(
+                f"\t   Current: fmin={cfg.BANDPASS_FMIN}, fmax={cfg.BANDPASS_FMAX}, speed={cfg.AUDIO_SPEED}", flush=True
+            )
+            print(f"\t   Current: crop_mode={cfg.SAMPLE_CROP_MODE}, overlap={cfg.SIG_OVERLAP}", flush=True)
+
+    # Extract and return data
+    x_train = data["x_train"]
+    y_train = data["y_train"]
+
+    # Handle test data which might not be in older cache files
+    x_test = data.get("x_test", np.array([]))
+    y_test = data.get("y_test", np.array([]))
+
+    labels = data["labels"]
+    binary_classification = bool(data.get("binary_classification", False))
+    multi_label = bool(data.get("multi_label", False))
+
+    return x_train, y_train, x_test, y_test, labels, binary_classification, multi_label
+
+
+def clear_error_log():
+    """Clears the error log file.
+
+    For debugging purposes.
+    """
+    if os.path.isfile(cfg.ERROR_LOG_FILE):
+        os.remove(cfg.ERROR_LOG_FILE)
+
+
+def write_error_log(ex: Exception):
+    """Writes an exception to the error log.
+
+    Formats the stacktrace and writes it in the error log file configured in the config.
+
+    Args:
+        ex: An exception that occurred.
+    """
+    import datetime
+
+    with open(cfg.ERROR_LOG_FILE, "a") as elog:
+        elog.write(
+            datetime.datetime.now().strftime("[%Y-%m-%d %H:%M:%S]")
+            + "\n"
+            + "".join(traceback.TracebackException.from_exception(ex).format())
+            + "\n"
+        )
+
+
+def img2base64(path):
+    import base64
+
+    with open(path, "rb") as img_file:
+        return base64.b64encode(img_file.read()).decode("utf-8")
+
+
+def save_params(file_path, headers, values):
+    """Saves the params used to train the custom classifier.
+
+    The hyperparams will be saved to disk in a file named 'model_params.csv'.
+
+    Args:
+        file_path: The path to the file.
+        headers: The headers of the csv file.
+        values: The values of the csv file.
+    """
+    import csv
+
+    with open(file_path, "w", newline="") as paramsfile:
+        paramswriter = csv.writer(paramsfile)
+        paramswriter.writerow(headers)
+        paramswriter.writerow(values)
+
+
+def save_result_file(result_path: str, out_string: str):
+    """Saves the result to a file.
+
+    Args:
+        result_path: The path to the result file.
+        out_string: The string to be written to the file.
+    """
+
+    # Make directory if it doesn't exist
+    os.makedirs(os.path.dirname(result_path), exist_ok=True)
+
+    # Write the result to the file
+    with open(result_path, "w", encoding="utf-8") as rfile:
+        rfile.write(out_string)
+
+
+def check_model_files():
+    checkpoint_dir = os.path.join(SCRIPT_DIR, "checkpoints", "V2.4")
+    required_files = [
+        "BirdNET_GLOBAL_6K_V2.4_Model/variables/variables.data-00000-of-00001",
+        "BirdNET_GLOBAL_6K_V2.4_Model/variables/variables.index",
+        "BirdNET_GLOBAL_6K_V2.4_Model/saved_model.pb",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/mdata/group1-shard1of8.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/mdata/group1-shard2of8.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/mdata/group1-shard3of8.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/mdata/group1-shard4of8.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/mdata/group1-shard5of8.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/mdata/group1-shard6of8.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/mdata/group1-shard7of8.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/mdata/group1-shard8of8.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/mdata/model.json",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard1of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard2of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard3of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard4of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard5of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard6of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard7of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard8of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard9of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard10of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard11of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard12of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/group1-shard13of13.bin",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/model.json",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/model/labels.json",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/main.js",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/static/sample.wav",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/templates/index.html",
+        "BirdNET_GLOBAL_6K_V2.4_Model_TFJS/app.py",
+        "BirdNET_GLOBAL_6K_V2.4_Labels.txt",
+        "BirdNET_GLOBAL_6K_V2.4_MData_Model_V2_FP16.tflite",
+        "BirdNET_GLOBAL_6K_V2.4_Model_FP16.tflite",
+        "BirdNET_GLOBAL_6K_V2.4_Model_FP32.tflite",
+        "BirdNET_GLOBAL_6K_V2.4_Model_INT8.tflite",
+    ]
+
+    for file in required_files:
+        if not os.path.exists(os.path.join(checkpoint_dir, file)):
+            print(f"Missing {file}")
+
+            return False
+
+    print("Model found!")
+
+    return True
+
+
+def ensure_model_exists():
+    import zipfile
+
+    import requests
+    from tqdm import tqdm
+
+    if FROZEN or check_model_files():
+        return
+
+    checkpoint_dir = os.path.join(SCRIPT_DIR, "checkpoints")
+
+    os.makedirs(checkpoint_dir, exist_ok=True)
+
+    url = "https://tuc.cloud/index.php/s/3BsizWy5M7CtQ5w/download/V2.4.zip"
+    download_path = os.path.join(checkpoint_dir, "V2.4.zip")
+
+    response = requests.get(url, stream=True, timeout=30)
+    total_size = int(response.headers.get("content-length", 0))
+    block_size = 1024
+
+    with tqdm(total=total_size, unit="iB", unit_scale=True, desc="Downloading model") as tqdm_bar:
+        with open(download_path, "wb") as file:
+            for data in response.iter_content(block_size):
+                tqdm_bar.update(len(data))
+                file.write(data)
+
+    if response.status_code != 200 or (total_size not in (0, tqdm_bar.n)):
+        raise ValueError(f"Failed to download the file. Status code: {response.status_code}")
+
+    with zipfile.ZipFile(download_path, "r") as zip_ref:
+        zip_ref.extractall(os.path.dirname(download_path))
+
+    os.remove(download_path)
+
+
+if __name__ == "__main__":
+    ensure_model_exists()

birdnet_analyzer-2.0.0.dist-info/METADATA

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: birdnet_analyzer
+Version: 2.0.0
+Summary: BirdNET analyzer for scientific audio data processing and bird classification.
+Author: Stefan Kahl
+Maintainer: Josef Haupt, Max Mauermann
+License: MIT
+Project-URL: Homepage, https://birdnet.cornell.edu/birdnet
+Project-URL: Documentation, https://birdnet-team.github.io/BirdNET-Analyzer/
+Project-URL: Repository, https://github.com/birdnet-team/BirdNET-Analyzer
+Project-URL: Issues, https://github.com/birdnet-team/BirdNET-Analyzer/issues
+Project-URL: Download, https://github.com/birdnet-team/BirdNET-Analyzer/releases/latest
+Keywords: birdnet,birdnet-analyzer
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: librosa
+Requires-Dist: resampy
+Requires-Dist: tensorflow==2.15.1
+Requires-Dist: scikit-learn==1.6.1
+Requires-Dist: tqdm
+Provides-Extra: train
+Requires-Dist: keras-tuner; extra == "train"
+Provides-Extra: server
+Requires-Dist: bottle; extra == "server"
+Requires-Dist: requests; extra == "server"
+Provides-Extra: gui
+Requires-Dist: birdnet-analyzer[embeddings,train]; extra == "gui"
+Requires-Dist: gradio==5.25.2; extra == "gui"
+Requires-Dist: pywebview; extra == "gui"
+Requires-Dist: matplotlib; extra == "gui"
+Requires-Dist: plotly[express]; extra == "gui"
+Requires-Dist: seaborn; extra == "gui"
+Requires-Dist: pywin32; platform_system == "Windows" and extra == "gui"
+Provides-Extra: embeddings
+Requires-Dist: perch-hoplite; extra == "embeddings"
+Provides-Extra: all
+Requires-Dist: birdnet-analyzer[gui,server]; extra == "all"
+Dynamic: license-file
+
+<div align="center">
+  <h1>BirdNET-Analyzer</h1>
+    <a href="https://birdnet-team.github.io/BirdNET-Analyzer/">
+        <img src="https://github.com/birdnet-team/BirdNET-Analyzer/blob/main/docs/_static/logo_birdnet_big.png?raw=true" width="300" alt="BirdNET-Logo" />
+    </a>
+</div>
+<br>
+<div align="center">
+
+![License](https://img.shields.io/github/license/birdnet-team/BirdNET-Analyzer)
+![OS](https://badgen.net/badge/OS/Linux%2C%20Windows%2C%20macOS/blue)
+[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/)
+![Species](https://badgen.net/badge/Species/6512/blue)
+![Downloads](https://www-user.tu-chemnitz.de/~johau/birdnet_total_downloads_badge.php)
+
+[![Docker](https://github.com/birdnet-team/BirdNET-Analyzer/actions/workflows/docker-build.yml/badge.svg)](https://github.com/birdnet-team/BirdNET-Analyzer/actions/workflows/docker-build.yml)
+[![Reddit](https://img.shields.io/badge/Reddit-FF4500?style=flat&logo=reddit&logoColor=white)](https://www.reddit.com/r/BirdNET_Analyzer/)
+![GitHub stars)](https://img.shields.io/github/stars/birdnet-team/BirdNET-Analyzer)
+[![GitHub release](https://img.shields.io/github/v/release/birdnet-team/BirdNET-Analyzer)](https://github.com/birdnet-team/BirdNET-Analyzer/releases/latest)
+
+</div>
+
+This repo contains BirdNET models and scripts for processing large amounts of audio data or single audio files.
+This is the most advanced version of BirdNET for acoustic analyses and we will keep this repository up-to-date with new models and improved interfaces to enable scientists with no CS background to run the analysis.
+
+Feel free to use BirdNET for your acoustic analyses and research.
+If you do, please cite as:
+
+```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}
+}
+```
+
+## Documentation
+
+You can access documentation for this project [here](https://birdnet-team.github.io/BirdNET-Analyzer/).
+
+## Download
+
+You can download installers for Windows and macOS from the [releases page](https://github.com/birdnet-team/BirdNET-Analyzer/releases/latest).
+
+## About
+
+Developed by the [K. Lisa Yang Center for Conservation Bioacoustics](https://www.birds.cornell.edu/ccb/) at the [Cornell Lab of Ornithology](https://www.birds.cornell.edu/home) in collaboration with [Chemnitz University of Technology](https://www.tu-chemnitz.de/index.html.en).
+
+Go to https://birdnet.cornell.edu to learn more about the project.
+
+Want to use BirdNET to analyze a large dataset? Don't hesitate to contact us: ccb-birdnet@cornell.edu
+
+**Have a question, remark, or feature request? Please start a new issue thread to let us know. Feel free to submit a pull request.**
+
+## 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
+
+This project is supported by Jake Holshuh (Cornell class of ´69) and The Arthur Vining Davis Foundations.
+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 Education and Research through the project “BirdNET+” (FKZ 01|S22072).
+The German Federal Ministry for the Environment, Nature Conservation and Nuclear Safety contributes through the “DeepBirdDetect” project (FKZ 67KI31040E).
+In addition, the Deutsche Bundesstiftung Umwelt supports BirdNET through the project “RangerSound” (project 39263/01).
+
+## Partners
+
+BirdNET is a joint effort of partners from academia and industry.
+Without these partnerships, this project would not have been possible.
+Thank you!
+
+![Logos of all partners](https://tuc.cloud/index.php/s/KSdWfX5CnSRpRgQ/download/box_logos.png)