Update README.md

README.md

@@ -1,199 +1,115 @@
 ---
 library_name: transformers
-tags: []
+tags:
+- dhivehi
+- ocr
+- labels
+license: mit
+language:
+- dv
+base_model:
+- microsoft/trocr-large-handwritten
+pipeline_tag: image-to-text
 ---
 
-# Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-
-
-
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+# TROCR Finetuned for Dhivehi Text Recognition
+
+Model: [microsoft/trocr-large-handwritten](https://huggingface.co/microsoft/trocr-large-handwritten)
+
+- dataset size: 10k samples
+- vocab size: 8k
+- language: Dhivehi
+
+This model has been finetuned for recognizing Dhivehi handwritten text that closely resembles printed or standardized fonts. The model was trained on a specialized dataset of 10,000 samples with an 8,000 word vocabulary focused on this specific use case.
+
+Key points:
+
+- Optimized for clean, standardized Dhivehi handwriting
+- May have reduced accuracy on irregular handwriting styles
+- Not recommended for general Dhivehi OCR tasks
+- Consider additional finetuning or alternative models for different applications
+
+While the model achieves high accuracy on the use case it was trained on, it may not perform well on general Dhivehi text or other use cases. For different applications, further finetuning on relevant data or using an alternative model may be necessary.
+
+## Usage
+from PIL import Image
+import torch
+from transformers import TrOCRProcessor, VisionEncoderDecoderModel
+
+```python
+def load_model():
+    model_dir = "alakxender/dv-trocr-large-handwritten-syn-10k"
+    processor = TrOCRProcessor.from_pretrained(model_dir)
+    model = VisionEncoderDecoderModel.from_pretrained(model_dir)
+    device = "cuda" if torch.cuda.is_available() else "cpu"
+    model = model.to(device)
+    return model, processor, device
+
+# load
+model, processor, device = load_model()
+
+# predict
+image = Image.open("example.jpg")
+inputs = processor(image, return_tensors="pt").to(device)
+outputs = model.generate(**inputs, max_new_tokens=256)
+predicted_text = processor.decode(outputs[0], skip_special_tokens=True)
+print(predicted_text)
+
+```
+
+## Evaluation Results
+
+```json
+[
+  {
+    "file_name": "data/images/DV01-04/DV01-04_140.jpg",
+    "predicted_text": "ޤާނޫނުގެ 42 ވަނަ މާއްދާގައި ލާޒިމްކުރާ މި ރިޕޯޓު ތައްޔާރުކޮށް ފޮނުވުމުގެ ޒިންމާއަކީ ޤާނޫނުން އިދާރާގެ އިންފޮމޭޝަން އޮފިސަރު ކުރައްވަންޖެހޭ ކަމެކެވެ .",
+    "true_text": "ޤާނޫނުގެ 42 ވަނަ މާއްދާގައި ލާޒިމްކުރާ މި ރިޕޯޓު ތައްޔާރުކޮށް ފޮނުވުމުގެ ޒިންމާއަކީ ޤާނޫނުން އިދާރާގެ އިންފޮމޭޝަން އޮފިސަރު ކުރައްވަންޖެހޭ ކަމެކެވެ."
+  },
+  {
+    "file_name": "data/images/DV01-01/DV01-01_163.jpg", 
+    "predicted_text": "ކަމުގައިވާ އޯގާވެރި ކަމާއި އަރާރުންވާ ކަމެއް : ހުކުރު ޚުތުބާ ނޮވެމްބަރ 25 , 2021 ކޮވިޑް19 : މިއަދު ފައްސިވި ޢަދަދު 100 އިން ދަށް ނޮވެމްބަރ 21 , 2021 ށ .",
+    "true_text": "ކަމުގައިވާ އޯގާވެރި ކަމާއި އަރާރުންވާ ކަމެއް: ހުކުރު ޚުތުބާ ނޮވެމްބަރ 25, 2021 ކޮވިޑް19: މިއަދު ފައްސިވި ޢަދަދު 100 އިން ދަށް ނޮވެމްބަރ 21, 2021 ށ."
+  },
+  {
+    "file_name": "data/images/DV01-04/DV01-04_147.jpg",
+    "predicted_text": ", ޗެލްސީ އަދި ސިޓީ މޮޅުވިއިރު ތާވަލުގެ އެއްވަނައަށް ލިވަޕޫލް - ކުޅިވަރު ޗެލްސީ އަދި ސިޓީ މޮޅުވިއިރު ތާވަލުގެ އެއްވަނައަށް ލިވަޕޫލް ސާއިފް ޝިޔާދު 1 , 2020 45 0 އިނގިރޭސި ޕްރިމިއަރ ލީގުގައި ކުޅުނު މެޗުތައް .",
+    "true_text": ", ޗެލްސީ އަދި ސިޓީ މޮޅުވިއިރު ތާވަލުގެ އެއްވަނައަށް ލިވަޕޫލް - ކުޅިވަރު ޗެލްސީ އަދި ސިޓީ މޮޅުވިއިރު ތާވަލުގެ އެއްވަނައަށް ލިވަޕޫލް ސާއިފް ޝިޔާދު 1, 2020 45 0 އިނގިރޭސި ޕްރިމިއަރ ލީގުގައި ކުޅުނު މެޗުތައް."
+  },
+  {
+    "file_name": "data/images/DV01-10/DV01-10_126.jpg",
+    "predicted_text": "ހިއްސާކޮށްލައްވާ ފަހުގެ ލިޔުންތައް އިހުގެ ލިޔުންތައް ފާހަގަކޮށްލެވޭ ބައެއް ލިޔުން މަޖިލީސް މެންބަރުންގެ މުސާރަ އިތުރަށް ބޮޑުކުރުމުގެ ދޮރު ބަންދުކުރަންޖެހޭ މަޖިލީހުގެ ޖަލްސާއެއް ނުބާއްވާތާ ދެމަސްވީއެވެ .",
+    "true_text": "ހިއްސާކޮށްލައްވާ ފަހުގެ ލިޔުންތައް އިހުގެ ލިޔުންތައް ފާހަގަކޮށްލެވޭ ބައެއް ލިޔުން މަޖިލީސް މެންބަރުންގެ މު��ާރަ އިތުރަށް ބޮޑުކުރުމުގެ ދޮރު ބަންދުކުރަންޖެހޭ މަޖިލީހުގެ ޖަލްސާއެއް ނުބާއްވާތާ ދެމަސްވީއެވެ."
+  },
+  {
+    "file_name": "data/images/DV01-04/DV01-04_100.jpg",
+    "predicted_text": "އެކަން ކަމަކީ ޤާނޫނު އަސާސީ އިން އެކަން ކަނޑައަޅާފައިވާ ގޮތަށް ވާ ހިނދު ރައްޔިތުން ތަމްސީލު ކުރުމުގެ ސިފަ އަށް އުނި އިތުރު ގެނައުމެއް ނެތެވެ .",
+    "true_text": "އެކަން ކަމަކީ ޤާނޫނު އަސާސީ އިން އެކަން ކަނޑައަޅާފައިވާ ގޮތަށް ވާ ހިނދު ރައްޔިތުން ތަމްސީލު ކުރުމުގެ ސިފަ އަށް އުނި އިތުރު ގެނައުމެއް ނެތެވެ."
+  },
+  {
+    "file_name": "data/images/DV01-04/DV01-04_112.jpg",
+    "predicted_text": "އާންމު އިޖުތިމާއީ އަދި އިޤުތިޞާދީ ހަރަކާތްތަކަށާއި އިންތިހާބީ ދާއިރާތަކަށާއި ސިޔާސީ މަޤާމުތަކަށް މީހުން ތައްޔާރުކުރުމާއި ކަނޑައަޅައިދިނުމާއި ހޭލުންތެރިކަން އިތުރުކުރުމަށް މަސައްކަތްކުރުމުގެ އިތުރުން ސިޔާސީ .",
+    "true_text": "އާންމު އިޖުތިމާއީ އަދި އިޤުތިޞާދީ ހަރަކާތްތަކަށާއި އިންތިހާބީ ދާއިރާތަކަށާއި ސިޔާސީ މަޤާމުތަކަށް މީހުން ތައްޔާރުކުރުމާއި ކަނޑައަޅައިދިނުމާއި ހޭލުންތެރިކަން އިތުރުކުރުމަށް މަސައްކަތްކުރުމުގެ އިތުރުން ސިޔާސީ."
+  },
+  {
+    "file_name": "data/images/DV01-01/DV01-01_4.jpg",
+    "predicted_text": "އެމެރިކާގެ ޑްރޯނެއް އިރާނުގެ ވައިގެ ސަރަހައްދުން ވައްޓާލާފައި ވޭތޯ އެމެރިކާގެ އަސްކަރިއްޔާގެ ސެންޓްރަލް ކޮމާންޑްގެ ތަރުޖަމާން ކެޕްޓަން ބިލް އާބަންއާއި އަލްޖަޒީރާއިން ސުވާލު ކުރެއްވުމުން އެފަރާތުން އެއްވެސް .",
+    "true_text": "އެމެރިކާގެ ޑްރޯނެއް އިރާނުގެ ވައިގެ ސަރަހައްދުން ވައްޓާލާފައި ވޭތޯ އެމެރިކާގެ އަސްކަރިއްޔާގެ ސެންޓްރަލް ކޮމާންޑްގެ ތަރުޖަމާން ކެޕްޓަން ބިލް އާބަންއާއި އަލްޖަޒީރާއިން ސުވާލު ކުރެއްވުމުން އެފަރާތުން އެއްވެސް."
+  },
+  {
+    "file_name": "data/images/DV01-03/DV01-03_36.jpg",
+    "predicted_text": "ސިފައިންގެ ޢާއިލާއާ މިއަދު އަލަށް ގުޅިވަޑައިގެންނެވި ހުރިހާ ސިފައިންނަށްވެސް ވަރަށް ކާމިޔާބު ވަރަށް ބާއްޖަވެރި ދުވަސްތަކަކަށް އެދެން .",
+    "true_text": "ސިފައިންގެ ޢާއިލާއާ މިއަދު އަލަށް ގުޅިވަޑައިގެންނެވި ހުރިހާ ސިފައިންނަށްވެސް ވަރަށް ކާމިޔާބު ވަރަށް ބާއްޖަވެރި ދުވަސްތަކަކަށް އެދެން."
+  },
+  {
+    "file_name": "data/images/DV01-08/DV01-08_13.jpg",
+    "predicted_text": "66 ވަނަ އަސާސީ ތަމްރީން ފުރިހަމަކުރި ސިފައިން ހުވާކުރުމުގެ ރަސްމިއްޔާތުގައި ވާހަކަފުޅުދައްކަވަމުން ރައީސް އިބްރާހީމް މުޙައްމަދު ޞާލިޙް ވިދާޅުވިއެވެ .",
+    "true_text": "66 ވަނަ އަސާސީ ތަމްރީން ފުރިހަމަކުރި ސިފައިން ހުވާކުރުމުގެ ރަސްމިއްޔާތުގައި ވާހަކަފުޅުދައްކަވަމުން ރައީސް އިބްރާހީމް މުޙައްމަދު ޞާލިޙް ވިދާޅުވިއެވެ."
+  },
+  {
+    "file_name": "data/images/DV01-10/DV01-10_194.jpg",
+    "predicted_text": "ނެއްލައިދޫ ބަނދަރު މަސައްކަތުގެ % 91 ނިމިއްޖެ ނޮވެމްބަރ 15 , 2021 ލާމަސީލު ޒުވާނާ ކޭމްޕް އިފްތިތާހު ކޮށްފި ނޮވެމްބަރ 14 , 2021 އެކްސިޑެންޓް ވުމުން އެމް .",
+    "true_text": "ނެއްލައިދޫ ބަނދަރު މަސައްކަތުގެ %91 ނިމިއްޖެ ނޮވެމްބަރ 15, 2021 ލާމަސީލު ޒުވާނާ ކޭމްޕް އިފްތިތާހު ކޮށްފި ނޮވެމްބަރ 14, 2021 އެކްސިޑެންޓް ވުމުން އެމް."
+  }
+]
+```