From 89d4a7b8cd5053553e6c2ee0acb50cb3c6069a38 Mon Sep 17 00:00:00 2001 From: Jenny Hamer Date: Tue, 12 Dec 2023 08:58:15 -0800 Subject: [PATCH] Updating BIRB benchmark portion of README. PiperOrigin-RevId: 590221321 --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 30f3d8ad..a9759c55 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,9 @@ After building the container, to run the unit tests, use: docker run --rm -t perch python -m unittest discover -s chirp/tests -p "*test.py" ``` -## BIRB data preparation +## BIRB benchmark +### Data preparation To build the BIRB evaluation data, after [installing](#installation) the `chirp` package, run the following command from the repository's root directory: ```bash @@ -53,4 +54,7 @@ poetry run tfds build -i chirp.data.bird_taxonomy,chirp.data.soundscapes \ The process should take 36 to 48 hours to complete and use around 256 GiB of disk space. +### Benchmark README +For details on setting up the benchmark and evaluation protocol, please refer to this [brief readme](https://docs.google.com/document/d/1RasVkxIKKlUToFlJ8gZxaHqIE-mMy9G1MZwfK98Gb-I) with instructions. The evaluation codebase is in [perch/chirp/eval](https://github.com/google-research/perch/tree/main/chirp/eval). + *This is not an officially supported Google product.*