README.md

Chirp

A bioacoustics research project.

Installation

You might need the following dependencies.

# Install Poetry for package management
curl -sSL https://install.python-poetry.org | python3 -

# Install dependencies for librosa
sudo apt-get install libsndfile1 ffmpeg

# Install all dependencies specified in the poetry configs.
poetry install

Running poetry install creates a virtual environment and installs all dependencies, in which you can run the Chirp codebase. To run the tests, try

poetry run python -m unittest discover -s chirp/tests -p "*test.py"

BIRB data preparation

Evaluation data

After installing the chirp package, run the following command from the repository's root directory:

poetry run tfds build -i chirp.data.bird_taxonomy,chirp.data.soundscapes \
    soundscapes/{ssw,hawaii,coffee_farms,sierras_kahl,high_sierras,peru}_full_length \
    bird_taxonomy/{downstream_full_length,class_representatives_slice_peaked}

The process should take 36 to 48 hours to complete and use around 256 GiB of disk space.

This is not an officially supported Google product.