pyLiteracy: Mandarin Grammar Checker

Repetitive-zai (再) and LocativePeriodic-zai (在) share the same pronunciation in Mandarin. This has led to many typos due to lack of language-decency self-awareness in modern texts. This project aims to make a Loki model that can examine whether the zai is used correctly or not.

檔案總覽

.
│  .gitignore
│  account.info
│  README.md
│
├─corpus  # 測試語料
│      KNOWLEDGE_schoolTW.json
│      LokiUserList.txt
│      sketch engine 再.txt
│      sketch engine 在.txt
│
├─purged corpus  # 清洗後語料
│      loc_zai_purged.json
│      loc_zai_purged.txt
│
├─Loki 
│  │  UI_main.py
│  │  
│  ├─Gua_Zai
│  │  │  Gua_Zai.py
│  │  │  missing_zai_1301-2300_revised.json
│  │  │  missing_zai_301-1300_revised.json
│  │  │  utteranceChecker.py
│  │  │  __init__.py
│  │  │
│  │  └─intent # 負責處理「在」的使用意圖
│  │     Loki_Zai_Aspect.py
│  │     Loki_Zai_idiom.py
│  │     Loki_Zai_Loc.py
│  │     Loki_Zai_Range.py
│  │     Loki_Zai_State.py
│  │     Loki_Zai_verbP.py
│  │     Updater.py
│  │     USER_DEFINED.json
│  │     __init__.py
│  │          
│  ├─static
│  │      person-man.gif
│  │
│  └─templates
│         homepage.html
│
├─ref  # 啟用 Loki 服務時，需要將裡面所有的檔案匯入 Loki project 中
│      Zai_Aspect.ref
│      Zai_idiom.ref
│      Zai_Loc.ref
│      Zai_Range.ref
│      Zai_State.ref
│      Zai_verbP.ref
│
└─toolbox  # 小工具放在這
       corpus_pos.py
       LokiTool.md
       LokiTool.py
       text_tool.py
       USER_DEFINED.json
     

設置環境

• 環境需求
  • Python 3.6 or above
  • pip or pip3 is installed
• 安裝相關套件
  • 執行指令：$ pip install -r requirements.txt

啟用 Loki 服務

1. 登入後進入 Loki 控制台
2. 輸入專案名稱，點選 建立專案
3. 點選剛建立完成的專案名稱以進入專案
4. 點選 選擇檔案 > 選擇所有 ref 內的檔案 > 點選 讀取意圖
5. 點選左上角房子圖示，回到 Loki 控制台，點選 複製 專案金鑰
6. 將複製下來的金鑰貼上到檔案 account.info 中：

{
    "username" : " ***輸入 USERNAME (註冊信箱)*** ",
    "api-key" : " ***將 Articut 金鑰貼到這裡*** ",
    "loki-key" : " ***將專案金鑰貼到這裡*** ",
}

開始使用

• 執行指令：$ python .\Loki\UI_main.py
• 在瀏覽器開啟 http://127.0.0.1:5000

聯絡資訊

若您還有其他任何的疑問，歡迎透過E-mail聯繫我們，謝謝。

Jonathan Chen：chenjonathan901210@gmail.com

Joe Huang：joehuangx@gmail.com

PeterWolf：peter.w@droidtown.co

Lisi Yang：lisi16810@gmail.com

Spec : https://docs.google.com/document/d/1QGHcbVy7gJJZVTW6DK2HHFGLnOvNRLaBPIwmPiWWSv4/edit?usp=sharing