Update README.md

README.md

@@ -37,4 +37,78 @@ language:
 pretty_name: Flickr8K Portuguese Translated
 size_categories:
 - 1K<n<10K
----
+---
+
+
+# 🎉 Flickr8K Portuguese Translated
+
+## 💾 Dataset Summary
+
+Flickr8K Portuguese Translated consists of 8,000 images, each accompanied by five descriptive captions that have been
+generated by human annotators for every individual image. The original English captions were rendered into Portuguese
+through the utilization of the Google Translator API.
+
+## 🧑‍💻 Hot to Get Started with the Dataset
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset('laicsiifes/flickr8k-pt-br')
+```
+
+## ✍️ Languages
+
+The images descriptions in the dataset are in Portuguese.
+
+## 🧱 Dataset Structure
+
+### 📝 Data Instances
+
+An example looks like below: 
+
+```
+{
+  'image': <PIL.JpegImagePlugin.JpegImageFile image mode=RGB size=500x333>,
+  'caption':
+  [
+    'Um cachorro preto carrega um brinquedo verde na boca enquanto caminha pela grama.',
+    'Um cachorro preto molhado carrega um brinquedo verde pela grama.',
+    'Um cachorro preto carregando algo pela grama.',
+    'Um cachorro na grama com um item azul na boca.',
+    'Um cachorro preto tem um brinquedo azul na boca.'
+  ],
+  'filename': '1026685415.jpg'
+}
+```
+
+### 🗃️ Data Fields
+
+The data instances have the following fields:
+
+- `image`: a `PIL.Image.Image` object containing the image.
+- `caption`: a `list` of `str` containing the 5 captions related to the image.
+- `filename`: a `str` containing the name of the image file.
+
+### ✂️ Data Splits
+
+The dataset is partitioned using the Karpathy splitting appoach for Image Captioning
+([Karpathy and Fei-Fei, 2015](https://arxiv.org/pdf/1412.2306)).
+
+|Split|Samples|Average Caption Length (Words)|
+|:-----------:|:-----:|:--------:|
+|Train|6,000|12.1 ± 5.1|
+|Validation|1,000|12.3 ± 5.3|
+|Test|1,000|12.2 ± 5.4|
+|Total|8,000|12.1 ± 5.2|
+
+
+## 📋 BibTeX entry and citation info
+
+```bibtex
+@misc{bromonschenkel2024flickr8kpt,
+  title        = "Flickr8K Portuguese Translated",
+  author       = "Bromonschenkel, Gabriel and Oliveira, Hil{\'a}rio and Paix{\~a}o, Thiago M.",
+  howpublished = "https://huggingface.co/datasets/laicsiifes/flickr8k-pt-br",
+  year         = "2024"
+}
+```