Update README.md

README.md

@@ -27,3 +27,56 @@ configs:
   - split: train
     path: data/train-*
 ---
+# Dataset Card for VocSim - Mouse Strain Classification
+
+## Dataset Description
+
+This dataset is used in the **VocSim benchmark** paper for evaluating the ability of neural audio embeddings to distinguish between mouse strains based on their ultrasonic vocalizations (USVs). It contains recordings from C57BL/6J (C57) and DBA/2J (DBA) mouse strains.
+
+The primary task associated with this dataset is supervised classification: training a model to predict the correct strain (`label` field) given an audio input or its derived features.
+
+## Dataset Structure
+
+### Data Instances
+
+A typical example in the dataset looks like this:
+
+```python
+{
+  'audio': {'path': '/path/to/datasets/mouse_strain/C57/C57_file_001.wav', 'array': array([...], dtype=float32), 'sampling_rate': 250000},
+  'subset': 'mouse_strain',
+  'index': 101,
+  'speaker': 'C57_file_001', # Example speaker/file ID
+  'label': 'C57', # The crucial strain label
+  'original_name': 'C57/C57_file_001.wav' # Example original relative path
+}
+```
+### Citation Information
+
+```
+@unpublished{vocsim2025,
+  title={VocSim: Zero-Shot Audio Similarity Benchmark for Neural Embeddings},
+  author={Anonymous},
+  year={2025},
+  note={Submitted manuscript} 
+}
+
+@article{VanSegbroeck2017,
+    author = {Van Segbroeck, Maarten and Knoll, Aaron T. and Levitt, Patricia and Narayanan, Shrikanth},
+    title = "{MUPET}-Mouse Ultrasonic Profile ExTraction: A Signal Processing Tool for Rapid and Unsupervised Analysis of Ultrasonic Vocalizations",
+    journal = {Neuron},
+    volume = {94},
+    number = {3},
+    pages = {465--485.e5},
+    year = {2017},
+    doi = {10.1016/j.neuron.2017.04.018}
+}
+
+@misc{mupetwiki2019,
+    author = {{Van Segbroeck}, Maarten and Knoll, Aaron T. and Levitt, Patricia and Narayanan, Shrikanth},
+    title = {MUPET Wiki},
+    year = {2019},
+    howpublished = {\url{https://github.com/mvansegbroeck/mupet/wiki/MUPET-wiki}},
+    note = {Accessed: 2025}
+}
+```