MohamedRashad commited on
Commit
48741d4
·
verified ·
1 Parent(s): 3ae4410

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +5 -2
README.md CHANGED
@@ -30,7 +30,7 @@ The model is based on the [facebook/nougat-small](https://huggingface.co/faceboo
30
  **Demo:** https://huggingface.co/spaces/MohamedRashad/Arabic-Nougat
31
 
32
  Or, use the code below to get started with the model locally.
33
- python
34
  from PIL import Image
35
  import torch
36
  from transformers import NougatProcessor, VisionEncoderDecoderModel
@@ -61,6 +61,8 @@ def predict(img_path):
61
  return page_sequence
62
 
63
  print(predict("path/to/page_image.jpg"))
 
 
64
  ## Bias, Risks, and Limitations
65
 
66
  1. **Text Hallucination:** The model may occasionally generate repeated or incorrect text due to the inherent complexities of OCR tasks.
@@ -92,7 +94,7 @@ By selecting the GPL 3.0 license, you promote the principles of open source and
92
  ### Citation
93
 
94
  If you find this model useful, please consider citing the original [facebook/nougat-small]((https://huggingface.co/facebook/nougat-small)) model and the datasets used for fine-tuning, including the [Khatt dataset](https://huggingface.co/datasets/Fakhraddin/khatt) and any details regarding the custom dataset.
95
- bibtex
96
  @misc{blecher2023nougat,
97
  title={Nougat: Neural Optical Understanding for Academic Documents},
98
  author={Lukas Blecher and Guillem Cucurull and Thomas Scialom and Robert Stojnic},
@@ -113,6 +115,7 @@ bibtex
113
  year={2023},
114
  howpublished={\url{https://huggingface.co/MohamedRashad/arabic-small-nougat}}
115
  }
 
116
  ### Disclaimer
117
 
118
  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.
 
30
  **Demo:** https://huggingface.co/spaces/MohamedRashad/Arabic-Nougat
31
 
32
  Or, use the code below to get started with the model locally.
33
+ ```python
34
  from PIL import Image
35
  import torch
36
  from transformers import NougatProcessor, VisionEncoderDecoderModel
 
61
  return page_sequence
62
 
63
  print(predict("path/to/page_image.jpg"))
64
+ ```
65
+
66
  ## Bias, Risks, and Limitations
67
 
68
  1. **Text Hallucination:** The model may occasionally generate repeated or incorrect text due to the inherent complexities of OCR tasks.
 
94
  ### Citation
95
 
96
  If you find this model useful, please consider citing the original [facebook/nougat-small]((https://huggingface.co/facebook/nougat-small)) model and the datasets used for fine-tuning, including the [Khatt dataset](https://huggingface.co/datasets/Fakhraddin/khatt) and any details regarding the custom dataset.
97
+ ```bibtex
98
  @misc{blecher2023nougat,
99
  title={Nougat: Neural Optical Understanding for Academic Documents},
100
  author={Lukas Blecher and Guillem Cucurull and Thomas Scialom and Robert Stojnic},
 
115
  year={2023},
116
  howpublished={\url{https://huggingface.co/MohamedRashad/arabic-small-nougat}}
117
  }
118
+ ```
119
  ### Disclaimer
120
 
121
  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.