Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
BenCretois committed Sep 2, 2022
1 parent 855420c commit 08a0e7a
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This repository contains all the tools necessary to **train** from scratch a dee

If you want to test our pipeline you do not need any dataset, we provided some demo files on OSF at this link: https://osf.io/f4mt5/ so that you can try the pipeline yourself!

:bulb: **Note that the ecoVAD's model weights are also on the Zenodo folder and you will need to download it if you wish to use our ecoVAD's model.**
:bulb: **Note that the ecoVAD's model weights are also on the OSF folder and you will need to download it if you wish to use our ecoVAD's model.**

Nevertheless, if you want to train a realistic model from scratch you will need your **own soundscape dataset**, a **human speech dataset** (in our analysis we used [LibriSpeech](https://www.openslr.org/12/)) and a **background noise dataset** (in our analysis we used both [ESC50](https://github.com/karolpiczak/ESC-50) or [BirdCLEF](https://www.imageclef.org/lifeclef/2017/bird)).

Expand Down Expand Up @@ -79,9 +79,13 @@ docker build -t ecovad -f Dockerfile .

### Download the folder `assets`

---

To be able to run the pipeline with demo data and to get the weights of the model we used in our analysis, it is necessary to download the folder `assets` located on OSF: https://osf.io/f4mt5/.

:right_arrow: Just go to the link, click on `assets.zip` and click on `download`.
:arrow_right: Just go to the link, click on `assets.zip` and click on `download`.

Now, simply unzip and place `assets` in the ecoVAD folder.

**You are now set up to run our ecoVAD pipeline!**

Expand Down

0 comments on commit 08a0e7a

Please sign in to comment.