Metadata-Version: 2.1
Name: ishi
Version: 0.0.3
Summary: A volition classifier for Japanese
Home-page: https://github.com/ku-nlp/ishi
Author: Hirokazu Kiyomaru
Author-email: kiyomaru@nlp.ist.i.kyoto-u.ac.jp
License: MIT
Keywords: NLP,Japanese
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: pyknp
Requires-Dist: mojimoji

# Ishi: A volition classifier for Japanese

## Requirements

- Python v3.6 or later
- [Jumanpp](https://github.com/ku-nlp/jumanpp)
- [KNP](http://nlp.ist.i.kyoto-u.ac.jp/index.php?KNP)

## Installation

```
$ pip install ishi
```

## How to Use

```python
from ishi import Ishi

ishi = Ishi()

# Ishi accepts a string
print(ishi('自然言語処理の勉強をする'))  # True
print(ishi('自然言語処理は楽しい'))  # False because "楽しい" is an adjective
print(ishi('自然言語処理を学べる'))  # False because "学べる" is a potential verb
print(ishi('自然言語処理の勉強を始めてびっくりした'))  # False because "びっくり (した)" is in a non-volition dictionary

# Ishi also accepts a KNP output
from pyknp import KNP
knp = KNP()
knp_output = knp.parse('自然言語処理の研究に必要なのは言語に対する深い洞察だ')
print(ishi(knp_output))  # False
```


