Skip to content

esun-ai/bopomofo

Repository files navigation

玉山ㄅㄆㄇㄈ注音標註系統

Summary

此為一個注音校正系統,運用 AI 技術自動為文章選擇準確的注音,提供教育人員可以花更短的時間編定注音教材。並提供多種輸出格式,包含已帶有對應注音字型的 Word 檔案、包含注音資訊的純文字檔案。

  • 精準注音轉換

  • 簡單易用的操作介面

  • 多種輸出格式

Features Display

More Features Display

Adapting this Project

  • docker 管理元件
  • reactJS 撰寫前端,nginx 構建的 web service
  • python fastAPI 建立的後端系統

Dependencies

  • You will need Docker, and it is recommended to use Docker Desktop. Docker can be used to start all services directly on your local machine.

快速建置

step 1.

git clone [repo]

step 2.

sudo sh install_bert.sh

如果下載成功,在 resource/bert-base-chinese 會有以下三個檔案 config.json、pytorch_model.bin、vocab.txt

step3.

安裝 docker 和安裝 docker compose(如已安裝可跳過),詳參 docker compose 安裝

啟動服務

step1.

docker compose -f docker-compose.prod.yml up -d

啟動後,在瀏覽器中輸入 http://localhost/editor

backend 啟動時間較有,若出現請求失敗,請等待後再試

如果 server 不是 local 端,而是架在 server 上 將 docker-compose.prod.yml 中 VITE_API_URL 參數的 localhost 替換成該台機器的 ip 或是 domain name

  • dev 啟動服務指令
docker compose -f docker-compose.dev.yml up -d

其他

  • image build 請參考 build image
  • 本系統使用開源 IVS 字體,如果使用為文鼎類字體,可參考文鼎字體版本
  • 其他問題可以參考 FAQ

Acknowledgements

IVS 字體和轉換規則取自 ButTaiwan/bpmfvs

License

Copyright (C) 2024 E.SUN BANK.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2.1 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

About

為一個注音校正系統,運用 AI 技術自動為文章選擇準確的注音,提供教育人員可以花更短的時間編定注音教材。並提供多種輸出格式,包含已帶有對應注音字型的Word 檔案、包含注音資訊的純文字檔案。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors