update readme

README.md

@@ -1,3 +1,77 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:0fe92c060b0e91cc5ae9a31bd3c2b9ec42c17d43f10bff14278d86ab0ca1338f
-size 33
+---
+license: cc-by-nc-4.0
+tags:
+- Sparsh-x
+- Digit 360
+- SSL training
+---
+
+# Dataset Details
+
+This dataset contains the sequences used for training [Sparsh-X](https://akashsharma02.github.io/sparsh-x-ssl/), a multisensory touch encoder for the [Digit 360](https://digit.ml/) sensor. Sparsh-X allows to fuse multiple touch modalities into a single embedding, such as tactile image, audio from contact microphones, IMU and pressure data.
+
+Our Sparsh-X training dataset is generated from two primary sources: an Allegro hand with Digit 360 sensors on the fingertips that performs random motions with objects such as dipping into a tray filled with various items; and a manual picker with the same sensor adapted to the gripping mechanism, used to execute atomic manipulation actions such as picking up, sliding, tapping, placing, and dropping objects against diverse surfaces that vary in roughness, hardness, softness, friction, and texture properties. An example of the data collection is shown below:
+
+<div align="center">
+    <img src="assets/object_action.gif" height="500" alt="D360 data collection">
+</div>
+
+
+## Dataset Structure and Usage
+
+Each sequence contains a `data.pickle` and `metadata.yaml`. The pickle file has the following structure, with the raw messages per Digit 360 and tactile modality:
+
+```bash
+├── data.pickle
+│   ├── d360_0
+│   |   ├── image_raw/compressed # list of msgs with tactile image @30Hz
+│   |   ├── imu_quat_topic  # list of msgs with IMU quaternion data @400Hz
+│   |   ├── imu_raw_topic # list of msgs with raw 3-axis accelerometer data @400Hz
+│   |   ├── mic_0 # list of time-series messages from contact microphone @48kHz
+│   |   ├── mic_1 # list of time-series messages from contact microphone @48kHz
+│   |   ├── pressure_topic # list of time-series messages from pressure @200Hz
+```
+
+You can load the pickle file as:
+```python
+import pandas as pd
+sequence_path = <PATH TO SEQUENCE>
+ros_msgs = pd.read_pickle(os.path.join(sequence, "data.pickle"))
+print(ros_msgs.keys())
+```
+And the output should be the key name for each Digit 360 qith recorded data:
+```bash
+> dict_keys(['d360_0', 'd360_1', 'd360_2', 'd360_3'])
+```
+
+The `metadata.yaml` for each sequence contains useful labels for Supervised Learninf downstream tasks. It describes the object in direct contact with the sensor (e.g. tennis ball), the surface the object is making contact with (e.g. grass), and the action that was perform during the data collection (e.g. tapping). Be aware that not all sequences have the three labels, for instance may not have the surface label.
+
+
+Please refer to [Sparsh-X repo](https://github.com/facebookresearch/sparsh-multisensory-touch) for further information about using the dataset for SSL training. Some useful pointers:
+
+- [List](https://github.com/facebookresearch/sparsh-multisensory-touch/config/data/d360.yaml) of sequences for SSL training
+- [D360 class](https://github.com/facebookresearch/sparsh-multisensory-touch/tactile_ssl/data/d360/d360.py) for dataloader
+
+## Citation
+
+If you find this dataset useful for your research, please consider citing:
+
+```bibtex
+@inproceedings{
+higuera2025tactile,
+title={Tactile Beyond Pixels: Multisensory Touch Representations for Robot Manipulation},
+author={Carolina Higuera and Akash Sharma and Taosha Fan and Chaithanya Krishna Bodduluri and Byron Boots and Michael Kaess and Mike Lambeta and Tingfan Wu and Zixi Liu and Francois Robert Hogan and Mustafa Mukadam},
+booktitle={9th Annual Conference on Robot Learning},
+year={2025},
+url={https://openreview.net/forum?id=sMs4pJYhWi}
+}
+```
+
+```bibtex
+@article{lambeta2024digitizing,
+  title={Digitizing touch with an artificial multimodal fingertip},
+  author={Lambeta, Mike and Wu, Tingfan and Sengul, Ali and Most, Victoria Rose and Black, Nolan and Sawyer, Kevin and Mercado, Romeo and Qi, Haozhi and Sohn, Alexander and Taylor, Byron and others},
+  journal={arXiv preprint arXiv:2411.02479},
+  year={2024}
+}
+```