Update README.md

README.md

@@ -12,7 +12,13 @@ datasets:
 
 # Arabic Small Nougat 
 
-**Sma**ll, **Simp**le **En**d-**t**o-**En**d **Structur**ed **OC**R **fo**r **Arab**ic **boo**ks.
+**Simp**le **En**d-**t**o-**En**d **Structur**ed **OC**R **fo**r **Arab**ic **boo**ks.
+
+## Description
+
+The arabic-small-nougat OCR is an end-to-end structured Optical Character Recognition (OCR) system designed specifically for the Arabic language.
+
+The model is based on the [facebook/nougat-small](https://huggingface.co/facebook/nougat-small) architecture and has been fine-tuned using the [Khatt dataset](https://huggingface.co/datasets/Fakhraddin/khatt) along with a custom dataset created for this purpose.
 
 ## How to Get Started with the Model
 
@@ -54,16 +60,17 @@ print(predict("path/to/page_image.jpg"))
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+1. **Text Hallucination:** The model may occasionally generate repeated or incorrect text due to the inherent complexities of OCR tasks.
+1. **Erroneous Image Paths:** There are instances where the model outputs image paths that are not relevant to the input, indicating occasional confusion.
+1. **Context Length Constraint:** The model has a maximum context length of 2048 tokens, which may result in incomplete transcriptions for longer book pages.
 
-### Recommendations
+## Intended Use
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+The arabic-small-nougat OCR is designed for tasks that involve converting images of Arabic book pages into structured text, especially when Markdown format is desired. It is suitable for applications in the field of digitizing Arabic literature and facilitating text extraction from printed materials.
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+## Ethical Considerations
 
+It is crucial to be aware of the model's limitations, particularly in instances where accurate OCR results are critical. Users are advised to verify and review the output, especially in scenarios where precision is paramount.
 
 ## Model Details
 
@@ -71,4 +78,29 @@ Users (both direct and downstream) should be made aware of the risks, biases and
 - **Model type:** VisionEncoderDecoderModel
 - **Language(s) (NLP):** Arabic & English
 - **License:** GPL 3.0
-- **Finetuned from model:** [nougat-small](https://huggingface.co/facebook/nougat-small)
+- **Finetuned from model:** [nougat-small](https://huggingface.co/facebook/nougat-small)
+
+## Acknowledgment
+
+If you use or build upon the arabic-small-nougat OCR, please acknowledge the model developer and the open-source community for their contributions. Additionally, be sure to include a copy of the GPL 3.0 license with any redistributed or modified versions of the model.
+
+By selecting the GPL 3.0 license, you promote the principles of open source and ensure that the benefits of the model are shared with the broader community.
+
+## Citation
+
+If you find this model useful, please consider citing the original facebook/nougat-small model and the datasets used for fine-tuning, including the Khatt dataset and any details regarding the custom dataset.
+
+```bibtex
+@misc{blecher2023nougat,
+      title={Nougat: Neural Optical Understanding for Academic Documents}, 
+      author={Lukas Blecher and Guillem Cucurull and Thomas Scialom and Robert Stojnic},
+      year={2023},
+      eprint={2308.13418},
+      archivePrefix={arXiv},
+      primaryClass={cs.LG}
+}
+```
+
+## Disclaimer
+
+The arabic-small-nougat OCR is a tool provided "as is," and the developers make no guarantees regarding its suitability for specific tasks. Users are encouraged to thoroughly evaluate the model's output for their particular use cases and requirements.