Create README.md

README.md

@@ -0,0 +1,38 @@
+---
+license: apache-2.0
+task_categories:
+- image-to-text
+language:
+- fa
+tags:
+- hezar
+pretty_name: Flickr30K Fa
+size_categories:
+- 10K<n<100K
+---
+
+The Flickr30K dataset filtered and translated to Persian.
+
+This dataset was originally made by **Sajjad Ayoubi** and uploaded to Kaggle at [https://www.kaggle.com/datasets/sajjadayobi360/flickrfa](https://www.kaggle.com/datasets/sajjadayobi360/flickrfa).
+This repo contains the exact dataset split to train/test using a custom sampling criteria and can be directly loaded using HuggingFace datasets or right from Hezar.
+
+### Usage
+#### Hugging Face Datasets
+```
+pip install datasets
+```
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("hezarai/flickr30k-fa")
+```
+
+#### Hezar
+```
+pip install hezar
+```
+```python
+from hezar.data import Dataset
+
+dataset = Dataset.load("hezarai/flickr30k-fa", split="train")
+```