Skip to content

Commit

Permalink
Document inference-only installation procedure.
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 625054412
  • Loading branch information
sdenton4 authored and copybara-github committed Apr 15, 2024
1 parent 4e894ab commit 1e22193
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,29 @@ curl -sSL https://install.python-poetry.org | python3 -
sudo apt-get install libsndfile1 ffmpeg

# Install all dependencies specified in the poetry configs
poetry install
poetry install --with jaxtrain
```

Running `poetry install` installs all Perch dependencies into a new virtual environment, in which you can run the Perch code base. To run the tests, use:

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

### Lightweight Inference

Note that if you only need the python notebooks for use with pre-trained models,
you can install with lighter dependencies:

```
# Install inference-only dependencies specified in the poetry configs
poetry install
```

And check that the inference tests succeed:
```bash
poetry run python -m unittest discover -s chirp/inference/tests -p "*test.py"
```

## Using a container
Expand Down

0 comments on commit 1e22193

Please sign in to comment.