Update README.md

README.md

@@ -24,7 +24,39 @@ In this folder, we provide the following trained model checkpoints:
 
 **TL;DR**: We present a method to infer physical properties of liquids from *just* the sound of pouring. We show in theory how *pitch* can be used to derive various physical properties such as container height, flow rate, etc. Then, we train a pitch detection network (`wav2vec2`) using simulated and real data. The resulting model can predict the physical properties of pouring liquids with high accuracy. The latent representations learned also encode information about liquid mass and container shape.
 
-Use this snippet to download the models:
+
+## 💻 Usage 
+
+First, install the repository from `github`.
+
+```sh
+git clone git@github.com:bpiyush/SoundOfWater.git
+cd SoundOfWater
+```
+
+Then, install dependencies.
+
+```sh
+conda create -n sow python=3.8
+conda activate sow
+
+# Install desired torch version
+# NOTE: change the version if you are using a different CUDA version
+pip install torch==2.1.0 torchvision==0.16.0 torchaudio==2.1.0 --index-url https://download.pytorch.org/whl/cu121
+
+# Additional packages
+pip install lightning==2.1.2
+pip install timm==0.9.10
+pip install pandas
+pip install decord==0.6.0
+pip install librosa==0.10.1
+pip install einops==0.7.0
+pip install ipywidgets jupyterlab seaborn
+
+# if you find a package is missing, please install it with pip
+```
+
+Then, use this snippet to download the models:
 
 ```python
 from huggingface_hub import snapshot_download
@@ -35,6 +67,10 @@ snapshot_download(
 )
 ```
 
+To run our models on examples of pouring sounds, please see the [playground notebook](https://github.com/bpiyush/SoundOfWater/blob/main/playground.ipynb).
+
+If you would like to use our dataset for a different task, please download it from [here](https://huggingface.co/datasets/bpiyush/sound-of-water).
+
 ## Models
 
 We provide audio models trained to detect pitch in the sound of pouring water.