Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,157 @@
+
+# The Sound of Water: Inferring Physical Properties from Pouring Liquids
+
+This dataset is associated with the paper "The Sound of Water: Inferring Physical Properties from Pouring Liquids".
+
+TODO: add citation and paper details.
+
+The dataset is stored in the following directory structure:
+```sh
+SoundOfWater/
+|-- annotations
+|-- assets
+|-- audios
+|-- README.md
+|-- splits
+|-- videos
+`-- youtube_samples
+
+6 directories, 1 file
+```
+
+## 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)
+      - [Container measurements and other metadata](#container-measurements-and-other-metadata)
+      - [Container bounding boxes](#container-bounding-boxes)
+  - [YouTube samples](#youtube-samples)
+  - [Citation](#citation)
+
+
+## Dataset Overview
+
+
+## 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.
+If you need untrimmed videos, please contact us separately and we may be able to help.
+
+The metadata for each video is a row in "./annotations/localisation.csv". 
+
+## Splits
+
+We create four splits of the dataset.
+All of the splits can be found in the `./splits/` directory.
+The splits are as follows:
+<table>
+<style>
+    table td:nth-child(n+2), table th:nth-child(n+2) {
+      text-align: center;
+    }
+</style>
+  <tr>
+    <th>Split</th>
+    <th colspan="2">Opacity</th>
+    <th colspan="3">Shapes</th>
+    <th>Containers</th>
+    <th>Videos</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td></td>
+    <td><i>Transparent</i></td>
+    <td><i>Opaque</i></td>
+    <td><i>Cylinder</i></td>
+    <td><i>Semi-cone</i></td>
+    <td><i>Bottle</i></td>
+    <td></td>
+    <td></td>
+    <td></td>
+  </tr>
+  <tr>
+    <td>Train</td>
+    <td>✓</td>
+    <td>✗</td>
+    <td>✓</td>
+    <td>✓</td>
+    <td>✗</td>
+    <td>18</td>
+    <td>195</td>
+    <td>Transparent cylinder-like containers</td>
+  </tr>
+  <tr>
+    <td>Test I</td>
+    <td>✓</td>
+    <td>✗</td>
+    <td>✓</td>
+    <td>✓</td>
+    <td>✗</td>
+    <td>13</td>
+    <td>54</td>
+    <td>Test set with seen containers</td>
+  </tr>
+  <tr>
+    <td>Test II</td>
+    <td>✗</td>
+    <td>✓</td>
+    <td>✓</td>
+    <td>✓</td>
+    <td>✗</td>
+    <td>19</td>
+    <td>327</td>
+    <td>Test set with unseen containers</td>
+  </tr>
+  <tr>
+    <td>Test III</td>
+    <td>✓</td>
+    <td>✓</td>
+    <td>✓</td>
+    <td>✓</td>
+    <td>✓</td>
+    <td>25</td>
+    <td>434</td>
+    <td>Shape clf. with unseen containers</td>
+  </tr>
+</table>
+
+
+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>
+
+#### Container measurements and other metadata
+
+All metadata for the containers is stored in the `./annotations/` file.
+
+| **File** | **Description** |
+| --- | --- |
+| `localisation.csv` | Each row is metadata (e.g., container) for each video. |
+| `containers.yaml` | Metadata for each container. |
+| `liquids.yaml` | Metadata for each liquid. |
+| `materials.yaml` | Metadata for each material. |
+
+
+#### Container bounding boxes
+
+The bounding box annotations for containers are stored here: `./annotations/container_bboxes/`. 
+These are generated in a zero-shot manner using [LangSAM](https://github.com/luca-medeiros/lang-segment-anything).
+
+
+## YouTube samples
+
+We also provide 4 samples searched from YouTube. These are used for qualitative evaluation.
+
+## Citation