Skip to content

Commit

Permalink
add google colab to README. Add notes about install from git vs pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
tandav committed Jun 30, 2024
1 parent 01a63ed commit 7cf72d6
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,19 @@ collection of pitch (f0, fundamental frequency) detection algorithms with unifie
accuracy is mean [raw pitch accuracy](http://craffel.github.io/mir_eval/#mir_eval.melody.raw_pitch_accuracy)

## install
all agorithms tested on python3.10, this is recommended python version to use
[Colab notebook with plots for all algorithms/models](https://colab.research.google.com/drive/1PVsk4ygDZIhIO3GEIukQJOKkgibqoG1n)

All agorithms tested on python3.12, this is recommended python version to use
```bash
# install latest version from git
pip install 'pitch-detectors @ git+https://github.com/tandav/pitch-detectors@master'

# older version is also available for python3.10
pip install pitch-detectors
```

note: latest version will be uploaded to PYPI as soon as [this CREPE MR](https://github.com/marl/crepe/pull/103) will be merged

## usage

```python
Expand Down

0 comments on commit 7cf72d6

Please sign in to comment.