From f06c7d892b604a10852a8916d001d162431f21c4 Mon Sep 17 00:00:00 2001
From: Paul Best <paul.best@lis-lab.fr>
Date: Tue, 27 Aug 2024 17:09:53 +0200
Subject: [PATCH] Update README.md

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index 50c64ee..8d40b93 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
 # Cross-species F0 estimation, dataset and study of baseline algorithms
 
 ## Use a crepe model pretrained on animal signals to analyse your own signals
+Install the packages necessary to run a crepe model using `pip install -r predict_requirements.txt`
+
 Use the `predict.py` script to run a pretrained crepe model to estimate fundamental frequency values for your own sounds.
 ```
 usage: predict.py [-h] [--model_path MODEL_PATH] [--compress COMPRESS] [--step STEP] [--decoder {argmax,weighted_argmax,viterbi}] [--print PRINT] indir
@@ -21,6 +23,8 @@ optional arguments:
 
 ## Reproduce paper experiments
 
+Python package requirements necessary to run the paper experiments are detailled in the `requirements.txt` file.
+
 ### metadata.py
 Stores a dictionary of datasets and characteristics (SR, NFFT, path to access soundfiles, and downsampling factor for ultra/infra-sonic signals)
 Convenient to iterate over the whole dataset
-- 
GitLab