espejelomar commited on
Commit
9734424
1 Parent(s): 5ed8930

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +27 -1
README.md CHANGED
@@ -53,7 +53,7 @@ Disclaimer: The team releasing Flickr30k did not upload the dataset to the Hub a
53
 
54
  - English.
55
 
56
- ## Dataset Structure: Equivalent sentence pairs.
57
 
58
  Each example in the dataset contains quintuplets of similar sentences and is formatted as a dictionary with the key "set" and a list with the sentences as "value":
59
 
@@ -66,6 +66,32 @@ Each example in the dataset contains quintuplets of similar sentences and is for
66
 
67
  This dataset is useful for training Sentence Transformers models. Refer to the following post on how to train models using similar pairs of sentences.
68
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
 
70
  ### Curation Rationale
71
 
 
53
 
54
  - English.
55
 
56
+ ## Dataset Structure
57
 
58
  Each example in the dataset contains quintuplets of similar sentences and is formatted as a dictionary with the key "set" and a list with the sentences as "value":
59
 
 
66
 
67
  This dataset is useful for training Sentence Transformers models. Refer to the following post on how to train models using similar pairs of sentences.
68
 
69
+ ### Usage Example
70
+
71
+ Install the 🤗 Datasets library with `pip install datasets` and load the dataset from the Hub with:
72
+
73
+ ```python
74
+ from datasets import load_dataset
75
+
76
+ dataset = load_dataset("embedding-data/flickr30k-captions")
77
+ ```
78
+ The dataset is loaded as a `DatasetDict` has the format:
79
+
80
+ ```python
81
+ DatasetDict({
82
+ train: Dataset({
83
+ features: ['set'],
84
+ num_rows: 31783
85
+ })
86
+ })
87
+ ```
88
+
89
+ Review an example `i` with:
90
+
91
+ ```python
92
+ dataset["train"][i]["set"]
93
+ ```
94
+
95
 
96
  ### Curation Rationale
97