MohamedRashad commited on
Commit
f353238
1 Parent(s): c9952f7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -4
README.md CHANGED
@@ -19,9 +19,17 @@ datasets:
19
 
20
  ## Description
21
 
 
 
 
 
 
 
 
22
  The arabic-large-nougat OCR is an end-to-end structured Optical Character Recognition (OCR) system designed specifically for the Arabic language.
23
 
24
- 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.
 
25
 
26
  ## How to Get Started with the Model
27
 
@@ -29,6 +37,9 @@ The model is based on the [facebook/nougat-small](https://huggingface.co/faceboo
29
 
30
  Or, use the code below to get started with the model locally.
31
 
 
 
 
32
  ```python
33
  from PIL import Image
34
  import torch
@@ -105,8 +116,7 @@ By selecting the GPL 3.0 license, you promote the principles of open source and
105
 
106
  ### Citation
107
 
108
- If you find this model useful, please consider citing the original facebook/nougat-base model and the datasets used for fine-tuning, including the Khatt dataset and any details regarding the custom dataset.
109
-
110
  ```bibtex
111
  @misc{rashad2024arabicnougatfinetuningvisiontransformers,
112
  title={Arabic-Nougat: Fine-Tuning Vision Transformers for Arabic OCR and Markdown Extraction},
@@ -121,4 +131,4 @@ If you find this model useful, please consider citing the original facebook/noug
121
 
122
  ### Disclaimer
123
 
124
- The arabic-base-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.
 
19
 
20
  ## Description
21
 
22
+ <div align="center">
23
+ <!-- **Affiliations:** -->
24
+
25
+ [**Github**](https://github.com/MohamedAliRashad/arabic-nougat) 🤗 [**Hugging Face**](https://huggingface.co/collections/MohamedRashad/arabic-nougat-673a3f540bd92904c9b92a8e) 📝 [**Paper**](https://arxiv.org/abs/2411.17835) 🗂️ [**Data**](https://huggingface.co/datasets/MohamedRashad/arabic-img2md) 📽️ [**Demo**](https://huggingface.co/spaces/MohamedRashad/Arabic-Nougat)
26
+
27
+ </div>
28
+
29
  The arabic-large-nougat OCR is an end-to-end structured Optical Character Recognition (OCR) system designed specifically for the Arabic language.
30
 
31
+ This model was trained from scratch based on the new tokenizer [riotu-lab/Aranizer-PBE-86k](https://huggingface.co/riotu-lab/Aranizer-PBE-86k) with the base nougat architecture.
32
+ The training happened using the [MohamedRashad/arabic-img2md](https://huggingface.co/datasets/MohamedRashad/arabic-img2md) dataset.
33
 
34
  ## How to Get Started with the Model
35
 
 
37
 
38
  Or, use the code below to get started with the model locally.
39
 
40
+ Don't forget to update transformers:
41
+ `pip install -U transformers`
42
+
43
  ```python
44
  from PIL import Image
45
  import torch
 
116
 
117
  ### Citation
118
 
119
+ If you find this model useful, please cite the corresponding research paper:
 
120
  ```bibtex
121
  @misc{rashad2024arabicnougatfinetuningvisiontransformers,
122
  title={Arabic-Nougat: Fine-Tuning Vision Transformers for Arabic OCR and Markdown Extraction},
 
131
 
132
  ### Disclaimer
133
 
134
+ The arabic-large-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.