chikkarpy
chikkarpyはchikkarのPython版です。 chikkarpy is a Python version of chikkar.
chikkarpy は Sudachi 同義語辞書を利用し、SudachiPyの出力に同義語展開を追加するために開発されたライブラリです。
単体でも同義語辞書の検索ツールとして利用できます。
利用方法 Usage
TL;DR
$ pip install chikkarpy
$ echo "閉店" | chikkarpy
閉店 クローズ,close,店仕舞い
Step 1. chikkarpyのインストール
$ pip install chikkarpy
Step 2. 使用方法
コマンドライン
$ echo "閉店" | chikkarpy
閉店 クローズ,close,店仕舞い
chikkarpyは入力された単語を見て一致する同義語のリストを返します。 同義語辞書内の曖昧性フラグが1の見出し語をトリガーにすることはできません。 出力はクエリ\t同義語リストの形式です。
$ chikkarpy search -h
usage: chikkarpy search [-h] [-d [file [file ...]]] [-ev] [-o file] [-v]
[file [file ...]]
Search synonyms
positional arguments:
file text written in utf-8
optional arguments:
-h, --help show this help message and exit
-d [file [file ...]] synonym dictionary (default: system synonym
dictionary)
-ev Enable verb and adjective synonyms.
-o file the output file
-v, --version print chikkarpy version
自分で用意したユーザー辞書を使いたい場合は-dで読み込むバイナリ辞書を指定できます。 （バイナリ辞書のビルドは辞書の作成を参照してください。） 複数辞書を読み込む場合は順番に注意してください。 以下の場合，user2 > user > system の順で同義語を検索して見つかった時点で検索結果を返します。
chikkarpy -d system.dic user.dic user2.dic
また、出力はデフォルトで体言のみです。 用言も出力したい場合は-evを有効にしてください。
$ echo "開放" | chikkarpy
開放 オープン,open
$ echo "開放" | chikkarpy -ev
開放 開け放す,開く,オープン,open
python ライブラリ
使用例
from chikkarpy import Chikkar
from chikkarpy.dictionarylib import Dictionary
chikkar = Chikkar()
system_dic = Dictionary("system.dic", False)
chikkar.add_dictionary(system_dic)
print(chikkar.find("閉店"))
# => ['クローズ', 'close', '店仕舞い']
print(chikkar.find("閉店", group_ids=[5])) # グループIDによる検索
# => ['クローズ', 'close', '店仕舞い']
print(chikkar.find("開放"))
# => ['オープン', 'open']
chikkar.enable_verb() # 用言の出力制御（デフォルトは体言のみ出力）
print(chikkar.find("開放"))
# => ['開け放す', '開く', 'オープン', 'open']
chikkar.add_dictionary()で複数の辞書を読み込ませる場合は順番に注意してください。 最後に読み込んだ辞書を優先して検索します。
辞書の作成 Build a dictionary
新しく辞書を追加する場合は、利用前にバイナリ形式辞書の作成が必要です。 Before using new dictionary, you need to create a binary format dictionary.
$ chikkarpy build -i synonym_dict.csv -o system.dic
$ chikkarpy build -h
usage: chikkarpy build [-h] -i file [-o file] [-d string]
Build Synonym Dictionary
optional arguments:
-h, --help show this help message and exit
-i file dictionary file (csv)
-o file output file (default: synonym.dic)
-d string description comment to be embedded on dictionary
開発者向け
Code Format
scripts/lint.sh を実行して、コードが正しいフォーマットかを確認してください。
flake8 flake8-import-order flake8-builtins が必要です。
Test
scripts/test.sh を実行してテストしてください。
Contact
chikkarpyはWAP Tokushima Laboratory of AI and NLPによって開発されています。
開発者やユーザーの方々が質問したり議論するためのSlackワークスペースを用意しています。
- https://sudachi-dev.slack.com/ (こちらから招待を受けてください)
2 Jan 6, 2022
32 Dec 14, 2022
3 Dec 22, 2021
5 Oct 29, 2022
13 Aug 11, 2022
325 Jan 5, 2023
60 Nov 11, 2022
55 Nov 17, 2022
19 Jun 30, 2022
33 Dec 18, 2022
10 Dec 19, 2022
117 Dec 27, 2022
461 Nov 21, 2022
84 Dec 15, 2022
20 Aug 22, 2022
2 Jun 19, 2022
24 Sep 11, 2022
544 Jan 09, 2023
4 Oct 15, 2022
11.2k Jan 05, 2023
2 Mar 04, 2022
1 Jan 31, 2022
10 Dec 14, 2022
209 Dec 30, 2022
109 Jan 04, 2023
16 Mar 10, 2022
762 Dec 29, 2022
11 Jul 21, 2022
220 Dec 11, 2022