Skip to content

Commit

Permalink
Add a 'nonwindows' optional dependency group with SCANN (since it doe…
Browse files Browse the repository at this point in the history
…sn't work on windows).

PiperOrigin-RevId: 679289922
  • Loading branch information
sdenton4 authored and copybara-github committed Sep 26, 2024
1 parent 095a475 commit afa7842
Show file tree
Hide file tree
Showing 5 changed files with 2,649 additions and 2,372 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
run: |
sudo apt-get update
sudo apt-get install libsndfile1 ffmpeg
poetry install --with jaxtrain
poetry install --with jaxtrain --with nonwindows
- name: Test with unittest
run: poetry run python -m unittest discover -s chirp/tests -p "*test.py"
- name: Test training with unittest
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci_no_jaxtrain.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
run: |
sudo apt-get update
sudo apt-get install libsndfile1 ffmpeg
poetry install --without jaxtrain
poetry install --without jaxtrain --with nonwindows
- name: Test with unittest
run: poetry run python -m unittest discover -s chirp/tests -p "*test.py"
- name: Test inference with unittest
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Some users have successfully used our repository with the Windows Linux
Subsystem, or with Docker in a cloud-based virtual machine. Anecdotally,
installation on OS X is difficult.

You might need the following dependencies.
You will need the following dependencies.

```bash
# Install Poetry for package management
Expand All @@ -88,8 +88,10 @@ 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 --with jaxtrain
# Install all dependencies specified in the poetry configs.
# Note that for Windows machines, you can remove the `--with nonwindows`
# option to drop some optional dependencies which do not build for Windows.
poetry install --with jaxtrain --with nonwindows
```

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:
Expand Down
Loading

0 comments on commit afa7842

Please sign in to comment.