aamijar commited on
Commit
4069c10
1 Parent(s): a9a7666

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -0
README.md CHANGED
@@ -45,6 +45,27 @@ See the official code, paper, and zenodo archive below. Our work has been accept
45
  [![Code](https://img.shields.io/badge/Code-black?style=flat-square&logo=github)](https://github.com/MehreenMehreen/muharaf) | [![Paper](https://img.shields.io/badge/Paper-black?style=flat-square&logo=arxiv)](https://arxiv.org/abs/2406.09630) | [![Dataset](https://img.shields.io/badge/Dataset-black?style=flat-square&logo=zenodo&logoColor=white&logoSize=auto)](https://zenodo.org/records/11492215)
46
  :-------------------------:|:-------------------------:|:----
47
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
48
  # Citation
49
 
50
  If you are using this dataset in your work, please cite our paper below.
 
45
  [![Code](https://img.shields.io/badge/Code-black?style=flat-square&logo=github)](https://github.com/MehreenMehreen/muharaf) | [![Paper](https://img.shields.io/badge/Paper-black?style=flat-square&logo=arxiv)](https://arxiv.org/abs/2406.09630) | [![Dataset](https://img.shields.io/badge/Dataset-black?style=flat-square&logo=zenodo&logoColor=white&logoSize=auto)](https://zenodo.org/records/11492215)
46
  :-------------------------:|:-------------------------:|:----
47
 
48
+ # How to use
49
+
50
+ ```python
51
+ from datasets import load_dataset
52
+
53
+ ds = load_dataset("aamijar/muharaf-public")
54
+
55
+ # remember to index into the row first to avoid decoding all images at once (https://huggingface.co/docs/datasets/en/image_load#load-image-data)
56
+ print(ds["train"][0]["image"])
57
+
58
+ # instead of
59
+ ```
60
+
61
+ <strike>
62
+
63
+ ```python
64
+ print(ds["train"]["image"][0])
65
+ ```
66
+
67
+ </strike>
68
+
69
  # Citation
70
 
71
  If you are using this dataset in your work, please cite our paper below.