From 7cf72d667c6d9d8b9db58af56f3b6fb1ad1b1c64 Mon Sep 17 00:00:00 2001 From: Alexander Rodionov Date: Sun, 30 Jun 2024 12:31:48 +0300 Subject: [PATCH] add google colab to README. Add notes about install from git vs pypi --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f7da83..49e9bdb 100644 --- a/README.md +++ b/README.md @@ -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