Create README.md

README.md

@@ -0,0 +1,23 @@
+---
+language:
+- fa
+metrics:
+- wer
+pipeline_tag: image-to-text
+---
+
+A Persian image captioning model constructed from a ViT + GPT2 architecture trained on flickr30k-fa.
+The encoder (ViT) was initialized from https://huggingface.co/google/vit-base-patch16-224 and the decoder (GPT2) was initialized 
+from https://huggingface.co/HooshvareLab/roberta-fa-zwnj-base .
+
+## Usage
+```
+pip install hezar
+```
+```python
+from hezar import Model
+
+model = Model.load("hezarai/vit-gpt2-fa-image-captioning-flickr30k")
+captions = model.predict("example_image.jpg")
+print(captions)
+```