From 1e2219383fb35c30982f35c213ff4f6963c6f504 Mon Sep 17 00:00:00 2001 From: Tom Denton Date: Mon, 15 Apr 2024 12:58:19 -0700 Subject: [PATCH] Document inference-only installation procedure. PiperOrigin-RevId: 625054412 --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 420d55e1..5bf55db3 100644 --- a/README.md +++ b/README.md @@ -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