Update README.md

README.md

@@ -0,0 +1,65 @@
+---
+license: apache-2.0
+---
+Hok2Han Seq2Seq Transformer Model
+
+這是一個基於 PyTorch 的 Seq2Seq Transformer 模型，用於將台語拼音轉成台語漢字。
+模型權重與設定已上傳至 Hugging Face Hub。
+
+---
+
+Repo 內容
+- best_model.pth：訓練好的模型權重
+- config.json：模型配置檔
+- hok2han_model.py：模型結構程式碼（需放在本地使用）
+- input__tokenizer/：輸入 Tokenizer 資料夾
+- output_tokenizer/：輸出 Tokenizer 資料夾
+
+---
+
+安裝需求
+pip install torch transformers huggingface_hub
+
+---
+
+使用說明
+
+1. 放置 hok2han_model.py 至工作目錄。
+
+2. 載入模型：
+from hok2han_model import Seq2SeqTransformer
+model = Seq2SeqTransformer.from_pretrained("KikKoh/Hok2Han")
+model.eval()
+
+3. 載入 Tokenizer：
+from transformers import Wav2Vec2Processor, BertTokenizer
+input_processor = Wav2Vec2Processor.from_pretrained("你的輸入tokenizer路徑或repo")
+output_tokenizer = BertTokenizer.from_pretrained("你的輸出tokenizer路徑或repo")
+
+4. 推論範例（簡略）：
+output = model(src=input_ids, tgt=tgt_ids,
+               src_pad_idx=input_tokenizer.pad_token_id,
+               tgt_pad_idx=output_tokenizer.pad_token_id)
+
+pred_ids = output.argmax(dim=-1)
+pred_text = output_tokenizer.decode(pred_ids[0], skip_special_tokens=True)
+print(pred_text)
+
+---
+
+注意事項
+- 本模型為自訂架構，請使用 hok2han_model.py 中 from_pretrained 載入。
+- 根據設備調整推論裝置。
+
+---
+
+聯絡
+<strong>KikKoh</strong><br>
+<a href="https://www.facebook.com/kikkoh.2024" target="_blank" style="text-decoration:none; color:#1877F2;">
+ <img src="https://upload.wikimedia.org/wikipedia/commons/5/51/Facebook_f_logo_%282019%29.svg" alt="Facebook" style="width:16px; vertical-align:middle; margin-right:6px;">Facebook: KikKoh
+</a>
+
+---
+
+授權
+apache-2.0