Update README.md

README.md

@@ -1,12 +1,23 @@
 ---
 library_name: transformers
-tags: []
+datasets:
+- yzk/veda-ocr-ms
+language:
+- sa
+metrics:
+- cer
+- chrf
+base_model:
+- microsoft/trocr-large-printed
 ---
 
 # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
+OCR for Vedic texts printed in Devanagari.
 
+**Note**
+This version is limited to a type of texts with accents marked by vertical lines over Devanagari characters.
 
 
 ## Model Details
@@ -17,61 +28,61 @@ tags: []
 
 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]
+- **Developed by:** https://huggingface.co/yzk
+- **Funded by:** https://kaken.nii.ac.jp/en/grant/KAKENHI-PROJECT-23K18646/
+<!-- - **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]
+- **Finetuned from model [optional]:** [More Information Needed] -->
 
-### Model Sources [optional]
+<!-- ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
+<!-- - **Repository:** [More Information Needed]
 - **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed] -->
 
-## Uses
+<!-- ## 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
+<!-- ### Direct Use -->
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Downstream Use [optional]
+<!-- ### 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]
+<!-- [More Information Needed] -->
 
-### Out-of-Scope Use
+<!-- ### Out-of-Scope Use -->
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Bias, Risks, and Limitations
+<!-- ## Bias, Risks, and Limitations -->
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Recommendations
+<!-- ### 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.
+<!-- 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
+<!-- ## How to Get Started with the Model -->
 
-Use the code below to get started with the model.
+<!-- Use the code below to get started with the model. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 ## Training Details
 
@@ -79,26 +90,41 @@ Use the code below to get started with the model.
 
 <!-- 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]
+<!-- [More Information Needed] -->
+Schroeder's edition of Maitrāyaṇī Sam̐hitā: https://huggingface.co/datasets/yzk/veda-ocr-ms (will be public)
 
-### Training Procedure
+<!-- ### 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]
+<!-- #### Preprocessing [optional] -->
 
-[More Information Needed]
+<!-- [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]
+```yaml
+params:
+  max_length: 512
+  train_batch_size: 16
+  eval_batch_size: 16 
+  learning_rate: 2e-5
+  weight_decay: 0.01
+  save_total_limit: 3
+  num_train_epochs: 20
+  logging_steps: 2
+  save_steps: 2000
+  eval_steps: 200
+```
+
+<!-- #### Speeds, Sizes, Times [optional] -->
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 ## Evaluation
 
@@ -132,41 +158,41 @@ Use the code below to get started with the model.
 
 
 
-## Model Examination [optional]
+<!-- ## Model Examination [optional] -->
 
 <!-- Relevant interpretability work for the model goes here -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Environmental Impact
+<!-- ## 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).
+<!-- 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]
+<!-- - **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]
+- **Carbon Emitted:** [More Information Needed] -->
 
-## Technical Specifications [optional]
+<!-- ## Technical Specifications [optional] -->
 
-### Model Architecture and Objective
+<!-- ### Model Architecture and Objective -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Compute Infrastructure
+<!-- ### Compute Infrastructure -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Hardware
+<!-- #### Hardware -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Software
+<!-- #### Software -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 ## Citation [optional]
 
@@ -180,20 +206,20 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [More Information Needed]
 
-## Glossary [optional]
+<!-- ## 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 Needed] -->
 
-## More Information [optional]
+<!-- ## More Information [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Model Card Authors [optional]
+<!-- ## Model Card Authors [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Model Card Contact
+<!-- ## Model Card Contact -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->