Skip to content

Commit

Permalink
Minor README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
agentmorris committed Dec 2, 2023
1 parent 8f85917 commit 2ba0e6f
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ 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.
# Install all dependencies specified in the poetry configs
poetry install
```

Expand All @@ -27,25 +27,23 @@ poetry run python -m unittest discover -s chirp/tests -p "*test.py"

## Using a container

Alternatively, you can install and run this project using a container via
Docker. To build a container using the tag `perch`, run:
Alternatively, you can install and run this project using a container via Docker. To build a container using the tag `perch`, run:

```bash
git clone https://github.com/google-research/perch
cd perch
docker build . --tag perch
```

And then you can run the different commands using the container you just built.
For example, to run the tests, try:
After building the container, to run the unit tests, use:

```bash
docker run --rm -t perch python -m unittest discover -s chirp/tests -p "*test.py"
```

## BIRB data preparation

### Evaluation data

After [installing](#installation) the `chirp` package, run the following command from the repository's root directory:
To build the BIRB evaluation data, after [installing](#installation) the `chirp` package, run the following command from the repository's root directory:

```bash
poetry run tfds build -i chirp.data.bird_taxonomy,chirp.data.soundscapes \
Expand Down

0 comments on commit 2ba0e6f

Please sign in to comment.