https://github.com/megagonlabs/bunkai
Sentence boundary disambiguation tool for Japanese texts (日本語文境界判定器)
https://github.com/megagonlabs/bunkai
japanese python sentence-boundary-detection sentence-tokenizer
Last synced: about 1 year ago
JSON representation
Sentence boundary disambiguation tool for Japanese texts (日本語文境界判定器)
- Host: GitHub
- URL: https://github.com/megagonlabs/bunkai
- Owner: megagonlabs
- License: apache-2.0
- Created: 2021-04-21T03:07:43.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T00:49:25.000Z (over 2 years ago)
- Last Synced: 2025-03-29T19:06:43.411Z (about 1 year ago)
- Topics: japanese, python, sentence-boundary-detection, sentence-tokenizer
- Language: Python
- Homepage: https://pypi.org/project/bunkai/
- Size: 1.18 MB
- Stars: 189
- Watchers: 3
- Forks: 11
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Citation: CITATION.cff
Awesome Lists containing this project
README
# Bunkai
[](https://badge.fury.io/py/bunkai)
[](https://pypi.org/project/bunkai/)
[](https://opensource.org/licenses/Apache-2.0)
[](https://pepy.tech/project/bunkai)
[](https://github.com/megagonlabs/bunkai/actions/workflows/ci.yml)
[](https://github.com/megagonlabs/bunkai/actions/workflows/typos.yml)
[](https://github.com/megagonlabs/bunkai/actions/workflows/codeql-analysis.yml)
[](https://codeclimate.com/github/megagonlabs/bunkai/maintainability)
[](https://codeclimate.com/github/megagonlabs/bunkai/test_coverage)
[](https://github.com/markdownlint/markdownlint)
[](https://github.com/dmeranda/demjson)
[](https://github.com/adrienverge/yamllint)
Bunkai is a sentence boundary (SB) disambiguation tool for Japanese texts.
Bunkaiは日本語文境界判定器です．
## Quick Start
### Install
```console
$ pip install -U bunkai
```
### Disambiguation without Models
```console
$ echo -e '宿を予約しました♪!まだ2ヶ月も先だけど。早すぎかな(笑)楽しみです★\n2文書目の先頭行です。▁改行はU+2581で表現します。' \
| bunkai
宿を予約しました♪!│まだ2ヶ月も先だけど。│早すぎかな(笑)│楽しみです★
2文書目の先頭行です。▁│改行はU+2581で表現します。
```
- Feed a document as one line by using ``▁`` (U+2581) for line breaks.
1行は1つの文書を表します．文書中の改行は ``▁`` (U+2581) で与えてください．
- The output shows sentence boundaries with ``│`` (U+2502).
出力では文境界は``│`` (U+2502) で表示されます．
### Disambiguation for Line Breaks with a Model
If you want to disambiguate sentence boundaries for line breaks, please add a ``--model`` option with the path to the model.
改行記号に対しても文境界判定を行いたい場合は，``--model``オプションを与える必要があります．
First, please install extras to use ``--model`` option.
``--model``オプションを利用するために、まずextraパッケージをインストールしてください．
```console
$ pip install -U 'bunkai[lb]'
```
Second, please setup a model. It will take some time.
次にモデルをセットアップする必要があります．セットアップには少々時間がかかります．
```console
$ bunkai --model bunkai-model-directory --setup
```
Then, please designate the directory.
そしてモデルを指定して動かしてください．
```console
$ echo -e "文の途中で改行を▁入れる文章ってありますよね▁それも対象です。" | bunkai --model bunkai-model-directory
文の途中で改行を▁入れる文章ってありますよね▁│それも対象です。
```
### Morphological Analysis Result
You can get morphological analysis results with ``--ma`` option.
``--ma``オプションを付与すると形態素解析結果が得られます．
It can be used with the ``--model`` option.
``--model``オプションと同時に使えます．
```console
$ echo -e '形態素解析し▁ます。結果を 表示します！' | bunkai --ma --model bunkai-model-directory
形態素 名詞,一般,*,*,*,*,形態素,ケイタイソ,ケイタイソ
解析 名詞,サ変接続,*,*,*,*,解析,カイセキ,カイセキ
し 動詞,自立,*,*,サ変・スル,連用形,する,シ,シ
▁
ます 助動詞,*,*,*,特殊・マス,基本形,ます,マス,マス
。 記号,句点,*,*,*,*,。,。,。
EOS
結果 名詞,副詞可能,*,*,*,*,結果,ケッカ,ケッカ
を 助詞,格助詞,一般,*,*,*,を,ヲ,ヲ
記号,空白,*,*,*,*, ,*,*
表示 名詞,サ変接続,*,*,*,*,表示,ヒョウジ,ヒョージ
し 動詞,自立,*,*,サ変・スル,連用形,する,シ,シ
ます 助動詞,*,*,*,特殊・マス,基本形,ます,マス,マス
！ 記号,一般,*,*,*,*,！,！,！
EOS
```
### Python Library
You can also use Bunkai as Python library.
BunkaiはPythonライブラリとしても使えます．
```python
from bunkai import Bunkai
bunkai = Bunkai()
for sentence in bunkai("はい。このようにpythonライブラリとしても使えます！"):
print(sentence)
```
改行を文境界判定に含める場合はセットアップしたモデルパスを指定してください．
If you want to disambiguate line breaks too, please designate the model path where you set up.
```python
from pathlib import Path
from bunkai import Bunkai
bunkai = Bunkai(path_model=Path("bunkai-model-directory"))
for sentence in bunkai("そうなんです▁このように▁pythonライブラリとしても▁使えます！"):
print(sentence)
"""
Output:
そうなんです▁
このように▁pythonライブラリとしても▁使えます！
"""
```
For more information, see [examples](example).
ほかの例は[examples](example)をご覧ください．
## Documents
- [Documents](docs)
## References
- Yuta Hayashibe and Kensuke Mitsuzawa.
Sentence Boundary Detection on Line Breaks in Japanese.
Proceedings of The 6th Workshop on Noisy User-generated Text (W-NUT 2020), pp.71-75.
November 2020.
[[PDF]](https://www.aclweb.org/anthology/2020.wnut-1.10.pdf)
[[bib]](https://www.aclweb.org/anthology/2020.wnut-1.10.bib)
## License
Apache License 2.0