Upload README.md with huggingface_hub

README.md

@@ -1,9 +1,35 @@
 
-# The Sound of Water: Inferring Physical Properties from Pouring Liquids
+# <img src="./assets/pouring-water-logo5.png" alt="Logo" width="40">  The Sound of Water: Inferring Physical Properties from Pouring Liquids
+
+<p align="center">
+  <a href="https://arxiv.org/abs/XXXXXX" target="_blank">
+    <img src="https://img.shields.io/badge/arXiv-Paper-red" alt="arXiv">
+  </a>
+  &nbsp;&nbsp;&nbsp;
+  <a target="_blank" href="https://colab.research.google.com/github/bpiyush/SoundOfWater/blob/main/playground.ipynb">
+  <img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
+  </a>
+  &nbsp;&nbsp;&nbsp;
+  <a href="https://your_gradio_demo_link" target="_blank">
+    <img src="https://img.shields.io/badge/Gradio-Demo-orange" alt="Gradio">
+  </a>
+</p>
+
 
 This dataset is associated with the paper "The Sound of Water: Inferring Physical Properties from Pouring Liquids".
 
-TODO: add citation and paper details.
+
+<!-- Add a teaser image. -->
+<p align="center">
+  <img src="./media_assets/pitch_on_spectrogram-compressed.gif" alt="Teaser" width="100%">
+</p>
+
+*Our key observations*: As water is poured, the fundamental frequency that we hear changes predictably over time as a function of physical properties (e.g., container dimensions).
+
+**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.
+
+
+## ℹ️ About the dataset
 
 The dataset is stored in the following directory structure:
 ```sh
@@ -19,24 +45,29 @@ SoundOfWater/
 6 directories, 1 file
 ```
 
-## Table of Contents
+##  📑 Table of Contents
 
-- [The Sound of Water: Inferring Physical Properties from Pouring Liquids](#the-sound-of-water-inferring-physical-properties-from-pouring-liquids)
-  - [Table of Contents](#table-of-contents)
-  - [Dataset Overview](#dataset-overview)
-  - [Video and audio samples](#video-and-audio-samples)
-  - [Splits](#splits)
-  - [Annotations](#annotations)
+- [  The Sound of Water: Inferring Physical Properties from Pouring Liquids](#--the-sound-of-water-inferring-physical-properties-from-pouring-liquids)
+  - [ℹ️ About the dataset](#ℹ️-about-the-dataset)
+  - [📑 Table of Contents](#-table-of-contents)
+  - [📚 Dataset Overview](#-dataset-overview)
+  - [🎥 Video and audio 🎧 samples](#-video-and-audio--samples)
+  - [🗂️ Splits](#️-splits)
+  - [📝 Annotations](#-annotations)
       - [Container measurements and other metadata](#container-measurements-and-other-metadata)
       - [Container bounding boxes](#container-bounding-boxes)
-  - [YouTube samples](#youtube-samples)
-  - [Citation](#citation)
+  - [🎬 YouTube samples](#-youtube-samples)
+  - [📜 Citation](#-citation)
+  - [🙏 Acknowledgements](#-acknowledgements)
+
 
+## 📚 Dataset Overview
 
-## Dataset Overview
+We collect a dataset of 805 clean videos that show the action of pouring water in a container. Our dataset spans over 50 unique containers made of 5 different materials, 4 different shapes and with hot and cold water. Some example containers are shown below.
 
+<img width="650" alt="image" src="./assets/containers-v2.png">
 
-## Video and audio samples
+## 🎥 Video and audio 🎧 samples
 
 The video and audio samples are stored in the `./videos/` and `./audios/` directories, respectively.
 Note that we have trimmed the videos between the precise start and end of the pouring action.
@@ -44,7 +75,7 @@ If you need untrimmed videos, please contact us separately and we may be able to
 
 The metadata for each video is a row in "./annotations/localisation.csv". 
 
-## Splits
+## 🗂️ Splits
 
 We create four splits of the dataset.
 All of the splits can be found in the `./splits/` directory.
@@ -123,14 +154,40 @@ The splits are as follows:
 
 TODO: add test_III.txt file.
 
-## Annotations
-
-The set of containers used is shown in this image:
-
-<figure>
-  <img src="./assets/container_canvas.png" alt="Containers used in the dataset" style="width:70%">
-  <figcaption>Containers used in the dataset</figcaption>
-</figure>
+## 📝 Annotations
+
+An example row with metadata for a video looks like:
+```json
+{
+    "video_id": "VID_20240116_230040",
+    "start_time": 2.057,
+    "end_time": 16.71059,
+    "setting": "ws-kitchen",
+    "bg-noise": "no",
+    "water_temperature": "normal",
+    "liquid": "water_normal",
+    "container_id": "container_1",
+    "flow_rate_appx": "constant",
+    "comment": null,
+    "clean": "yes",
+    "time_annotation_mode": "manual",
+    "shape": "cylindrical",
+    "material": "plastic",
+    "visibility": "transparent",
+    "example_video_id": "VID_20240116_230040",
+    "measurements": {
+        "diameter_bottom": 5.7,
+        "diameter_top": 6.3,
+        "net_height": 19.7,
+        "thickness": 0.32
+    },
+    "hyperparameters": {
+        "beta": 0.0
+    },
+    "physical_parameters": null,
+    "item_id": "VID_20240116_230040_2.1_16.7"
+}
+```
 
 #### Container measurements and other metadata
 
@@ -150,8 +207,36 @@ The bounding box annotations for containers are stored here: `./annotations/cont
 These are generated in a zero-shot manner using [LangSAM](https://github.com/luca-medeiros/lang-segment-anything).
 
 
-## YouTube samples
+## 🎬 YouTube samples
 
 We also provide 4 samples searched from YouTube. These are used for qualitative evaluation.
 
-## Citation
+
+<!-- Add a citation -->
+## 📜 Citation
+
+If you find this repository useful, please consider giving a star ⭐ and citation
+
+```bibtex
+@article{sound_of_water_bagad,
+  title={The Sound of Water: Inferring Physical Properties from Pouring Liquids},
+  author={Bagad, Piyush and Tapaswi, Makarand and Snoek, Cees G. M. and Zisserman, Andrew},
+  journal={arXiv},
+  year={2024}
+}
+```
+
+<!-- Add acknowledgements, license, etc. here. -->
+## 🙏 Acknowledgements
+
+* We thank Ashish Thandavan for support with infrastructure and Sindhu
+Hegde, Ragav Sachdeva, Jaesung Huh, Vladimir Iashin, Prajwal KR, and Aditya Singh for useful
+discussions.
+* This research is funded by EPSRC Programme Grant VisualAI EP/T028572/1, and a Royal Society Research Professorship RP / R1 / 191132.
+
+We also want to highlight closely related work that could be of interest:
+
+* [Analyzing Liquid Pouring Sequences via Audio-Visual Neural Networks](https://gamma.cs.unc.edu/PSNN/). IROS (2019).
+* [Human sensitivity to acoustic information from vessel filling](https://psycnet.apa.org/record/2000-13210-019). Journal of Experimental Psychology (2020).
+* [See the Glass Half Full: Reasoning About Liquid Containers, Their Volume and Content](https://arxiv.org/abs/1701.02718). ICCV (2017).
+* [CREPE: A Convolutional Representation for Pitch Estimation](https://arxiv.org/abs/1802.06182). ICASSP (2018).