Update README.md

README.md

@@ -1,121 +1,128 @@
----
-license: apache-2.0
-tags:
-- light-novel
-- translation
-- Chinese
-- English
-- named-entity-recognition
-- term-extraction
-- unsloth
-- trl
-- sft
-model_type: translation
-language_bcp47:
-- zh
-- en
-finetuned_from: unsloth/Yi-1.5-6B-bnb-4bit
-description: 'Mythical Translator is a fine-tuned model specifically designed to translate
-  Chinese light novels into natural-sounding English suitable for the genre. It also
-  extracts terms and proper nouns for consistency in future translations.
-
-  '
----
-
-# Model Card for Mythical Translator
-
-## Model Details
-
-### Model Description
-
-Mythical Translator is a fine-tuned model specifically designed to translate Chinese light novels into natural-sounding English suitable for the genre. It also extracts terms and proper nouns for consistency in future translations. The model uses the unsloth fine-tuning technique and is trained on a dataset of high-quality, strictly translated Chinese light novels.
-
--   **Developed by:** Arben Apura
--   **Model type:** Translation Model
--   **Language(s) (NLP):** Chinese to English
--   **License:** Apache-2.0
--   **Finetuned from model:** unsloth/Yi-1.5-6B-bnb-4bit
-
-## Uses
-
-### Direct Use
-
-Translate a passage from a Chinese light novel into natural-sounding English, using the provided context as a dictionary. List the proper nouns and terminologies with their Chinese characters and English translations as they appear in the passage.
-
-### Out-of-Scope Use
-
-The model may not perform well with texts outside the light novel genre or with languages other than Chinese. It should not be used for tasks other than translating light novels or extracting terms.
-
-## Bias, Risks, and Limitations
-
-### Recommendations
-
-Users should be aware of potential biases in translation related to genre-specific language and cultural nuances. Regular updates and reviews are recommended to maintain high translation quality.
-
-## How to Get Started with the Model
-
-Use the following template to start translating:
-
-```markdown
-Translate a passage from a Chinese light novel into natural-sounding English, using the provided context as a dictionary. List the proper nouns and terminologies with their Chinese characters and English translations as they appear in the passage.
-
-<context>
-
-</context>
-
-<passage>
-
-</passage>
-
-<translation>
-```
-
-## Sample Text Generation Output
-
-```markdown
-Translate a passage from a Chinese light novel into natural-sounding English, using the provided context as a dictionary. List the proper nouns and terminologies with their Chinese characters and English translations as they appear in the passage.
-
-<context>
-剑 = sword
-兵器 = weapon
-师妹 = junior sister
-孟师兄 = Senior Brother Meng
-</context>
-
-<passage>
-孟师兄一握，赞许道，“不错，工艺精湛，比起一般的下品兵器要好上很多，只不过这名字，倒是有些……依我看，此剑灵光流动，表面灵光如水，不如便叫灵动剑更为合适，师妹你看如何？”
-</passage>
-
-<translation>
-Senior Brother Meng grasped the sword and, with approval, said, “Not bad, the craftsmanship is exquisite. It’s much better than an ordinary inferior-grade weapon. However, the name is a bit… In my opinion, since the sword's spiritual light flows and its surface spiritual light is like water, it would be more appropriate to call it the Spirit-Flow Sword. What do you think, junior sister?”
-</translation>
-
-<terms>
-孟师兄 = Senior Brother Meng
-剑 = sword
-下品 = inferior-grade
-兵器 = weapon
-灵光 = spiritual light
-灵动剑 = Spirit-Flow Sword
-</terms>
-```
-
-## Training Details
-
-### Training Data
-
-The training data consists of multiple Chinese light novels, selected for their high-quality translations to ensure accuracy and fluency.
-
-## Evaluation
-
-#### Testing Data
-
-The model's performance is evaluated using a dataset of light novel passages translated into natural-sounding English.
-
-#### Metrics
-
-Evaluation metrics include translation accuracy, fluency, and consistency of term extraction.
-
-## More Information
-
-For additional details, please contact Arben Apura at arbenapura.official@gmail.com.
+---
+license: apache-2.0
+tags:
+- light-novel
+- translation
+- Chinese
+- English
+- named-entity-recognition
+- term-extraction
+- unsloth
+- trl
+- sft
+model_type: translation
+language_bcp47:
+- zh
+- en
+finetuned_from: unsloth/OpenHermes-2.5-Mistral-7B-bnb-4bit
+description: 'Mythical Translator is a fine-tuned model specifically designed to translate
+  Chinese light novels into natural-sounding English suitable for the genre. It also
+  extracts terms and proper nouns for consistency in future translations.
+
+  '
+---
+
+# Model Card for Mythical Translator
+
+## Model Details
+
+### Model Description
+
+Mythical Translator is a fine-tuned model specifically designed to translate Chinese light novels into natural-sounding English suitable for the genre. It also extracts terms and proper nouns for consistency in future translations. The model uses the unsloth fine-tuning technique and is trained on a dataset of high-quality, strictly translated Chinese light novels.
+
+-   **Developed by:** Arben Apura
+-   **Model type:** Translation Model
+-   **Language(s) (NLP):** Chinese to English
+-   **License:** Apache-2.0
+-   **Finetuned from model:** unsloth/OpenHermes-2.5-Mistral-7B-bnb-4bit
+
+## Uses
+
+### Direct Use
+
+Translate a passage from a Chinese light novel into natural-sounding English, using the provided context as a dictionary. List the proper nouns and terminologies with their Chinese characters and English translations as they appear in the passage.
+
+### Out-of-Scope Use
+
+The model may not perform well with texts outside the light novel genre or with languages other than Chinese. It should not be used for tasks other than translating light novels or extracting terms.
+
+## Bias, Risks, and Limitations
+
+### Recommendations
+
+Users should be aware of potential biases in translation related to genre-specific language and cultural nuances. Regular updates and reviews are recommended to maintain high translation quality.
+
+## How to Get Started with the Model
+
+Use the following template to start translating:
+
+```markdown
+<|im_start|>system
+Translate a passage from a Chinese light novel into natural-sounding English, using the provided context as a dictionary. List the proper nouns and terminologies with their Chinese characters and English translations as they appear in the passage.<|im_end|>
+<|im_start|>user
+<context>
+...
+</context>
+
+<passage>
+...
+</passage>
+
+<translation>
+<|im_end|>
+<|im_start|>assistant
+
+```
+
+## Sample Text Generation Output
+
+```markdown
+<|im_start|>system
+Translate a passage from a Chinese light novel into natural-sounding English, using the provided context as a dictionary. List the proper nouns and terminologies with their Chinese characters and English translations as they appear in the passage.<|im_end|>
+<|im_start|>user
+<context>
+剑 = sword
+兵器 = weapon
+师妹 = junior sister
+孟师兄 = Senior Brother Meng
+</context>
+
+<passage>
+孟师兄一握，赞许道，“不错，工艺精湛，比起一般的下品兵器要好上很多，只不过这名字，倒是有些……依我看，此剑灵光流动，表面灵光如水，不如便叫灵动剑更为合适，师妹你看如何？”
+</passage>
+
+<translation>
+<|im_end|>
+<|im_start|>assistant
+Senior Brother Meng grasped the sword and, with approval, said, “Not bad, the craftsmanship is exquisite. It’s much better than an ordinary inferior-grade weapon. However, the name is a bit… In my opinion, since the sword's spiritual light flows and its surface spiritual light is like water, it would be more appropriate to call it the Spirit-Flow Sword. What do you think, junior sister?”
+</translation>
+
+<terms>
+孟师兄 = Senior Brother Meng
+剑 = sword
+下品 = inferior-grade
+兵器 = weapon
+灵光 = spiritual light
+灵动剑 = Spirit-Flow Sword
+</terms><|im_end|>
+```
+
+## Training Details
+
+### Training Data
+
+The training data consists of multiple Chinese light novels, selected for their high-quality translations to ensure accuracy and fluency.
+
+## Evaluation
+
+#### Testing Data
+
+The model's performance is evaluated using a dataset of light novel passages translated into natural-sounding English.
+
+#### Metrics
+
+Evaluation metrics include translation accuracy, fluency, and consistency of term extraction.
+
+## More Information
+
+For additional details, please contact Arben Apura at arbenapura.official@gmail.com.