Upload README.md with huggingface_hub

README.md

@@ -1,15 +1,15 @@
 ---
 language:
-- en
-- th
+  - en
+  - th
 tags:
-- transliteration
-- thai
-- english
-- byt5
+  - transliteration
+  - thai
+  - english
+  - byt5
 license: mit
 datasets:
-- custom
+  - custom
 library_name: transformers
 pipeline_tag: text2text-generation
 ---
@@ -25,7 +25,7 @@ This model is based on ByT5, a token-free sequence-to-sequence model that operat
 - **Developed by**: Thai NLP Research Group  
 - **Model type**: ByT5 (Sequence-to-Sequence)  
 - **Language(s)**: English → Thai  
-- **License**: MIT  
+- **License**: MIT (free for commercial use)  
 
 ## Intended Uses & Limitations
 
@@ -53,13 +53,15 @@ The model was trained on a custom dataset of English-Thai transliteration pairs.
 - **Training hyperparameters**:
   - Learning rate: `2e-4`
   - Batch size: `16`
-  - Number of epochs: `20`
+  - Number of epochs: `10`
   - Optimizer: `AdamW`
+  - Mixed precision: FP16 
+  - Gradient clipping: Yes (max_grad_norm=1.0)
 
 ### Evaluation Results
-- **Accuracy**: `0.78`
-- **Character Error Rate**: `0.12`
-- **Mean Levenshtein Distance**: `1.45`
+- **Accuracy**: `0.7709`
+- **Character Error Rate**: `0.0597`
+- **Mean Levenshtein Distance**: `0.4708`
 
 ## How to Use
 
@@ -87,6 +89,9 @@ print(f"English: {english_text} → Thai: {thai_text}")
 | computer | คอมพิวเตอร์  |
 | thailand | ไทยแลนด์   |
 | bangkok  | แบงค็อก    |
+| graph    | กราฟ      |
+| grossular | กรอสซูลาร์ |
+| grossularite | กรอสซูลาไรต์ |
 
 ## Limitations and Bias
 
@@ -96,3 +101,34 @@ The model's performance may vary based on:
 - The phonetic complexity of the input
 - Whether the input contains sounds that are difficult to represent in Thai
 - The coverage of similar words in the training data
+
+## Common Errors
+
+Some common error patterns observed:
+- group → กรุ๊ป (should be: กรูป)
+- glaucochroite → กลอโคครอยต์ (should be: กลอโคโครไอต์)
+- glasgow → กลาสโกว์ (should be: กลาสโกว)
+
+## License
+
+MIT License
+
+Copyright (c) 2023 Thai NLP Research Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.