Metadata-Version: 2.1
Name: udkundoku
Version: 1.6.7
Summary: Classical Chinese to Modern Japanese Translator
Home-page: https://github.com/KoichiYasuoka/UD-Kundoku
Author: Koichi Yasuoka
Author-email: yasuoka@kanji.zinbun.kyoto-u.ac.jp
License: MIT
Project-URL: ud-ja-kanbun, https://corpus.kanji.zinbun.kyoto-u.ac.jp/gitlab/Kanbun/ud-ja-kanbun
Project-URL: Source, https://github.com/KoichiYasuoka/UD-Kundoku
Project-URL: Tracker, https://github.com/KoichiYasuoka/UD-Kundoku/issues
Description: [![Current PyPI packages](https://badge.fury.io/py/udkundoku.svg)](https://pypi.org/project/udkundoku/)
        
        # UD-Kundoku
        
        Classical Chinese to Modern Japanese Translator, working on [Universal Dependencies](https://universaldependencies.org/format.html).
        
        ## Basic usage
        
        ```py
        >>> import udkundoku
        >>> lzh=udkundoku.load()
        >>> s=lzh("不入虎穴不得虎子")
        >>> t=udkundoku.translate(s)
        >>> print(t)
        # text = 虎の穴に入らずして虎の子を得ず
        1	虎	虎	NOUN	n,名詞,主体,動物	_	3	nmod	_	Gloss=tiger|SpaceAfter=No
        2	の	_	ADP	_	_	1	case	_	SpaceAfter=No
        3	穴	穴	NOUN	n,名詞,固定物,地形	Case=Loc	5	obj	_	Gloss=cave|SpaceAfter=No
        4	に	_	ADP	_	_	3	case	_	SpaceAfter=No
        5	入ら	入	VERB	v,動詞,行為,移動	_	0	root	_	Gloss=enter|SpaceAfter=No
        6	ずして	不	AUX	v,副詞,否定,無界	Polarity=Neg	5	advmod	_	Gloss=not|SpaceAfter=No
        7	虎	虎	NOUN	n,名詞,主体,動物	_	9	nmod	_	Gloss=tiger|SpaceAfter=No
        8	の	_	ADP	_	_	7	case	_	SpaceAfter=No
        9	子	子	NOUN	n,名詞,人,関係	_	11	obj	_	Gloss=child|SpaceAfter=No
        10	を	_	ADP	_	_	9	case	_	SpaceAfter=No
        11	得	得	VERB	v,動詞,行為,得失	_	5	parataxis	_	Gloss=get|SpaceAfter=No
        12	ず	不	AUX	v,副詞,否定,無界	Polarity=Neg	11	advmod	_	Gloss=not|SpaceAfter=No
        
        >>> print(t.sentence())
        虎の穴に入らずして虎の子を得ず
        
        >>> print(s.to_tree())
        不 <════╗   advmod
        入 ═══╗═╝═╗ root
        虎 <╗ ║   ║ nmod
        穴 ═╝<╝   ║ obj
        不 <════╗ ║ advmod
        得 ═══╗═╝<╝ parataxis
        虎 <╗ ║     nmod
        子 ═╝<╝     obj
        
        >>> print(t.to_tree())
        虎 ═╗<╗     nmod(体言による連体修飾語)
        の <╝ ║     case(格表示)
        穴 ═╗═╝<╗   obj(目的語)
        に <╝   ║   case(格表示)
        入 ═╗═══╝═╗ root(親)
        ら  ║     ║
        ず <╝     ║ advmod(連用修飾語)
        し        ║
        て        ║
        虎 ═╗<╗   ║ nmod(体言による連体修飾語)
        の <╝ ║   ║ case(格表示)
        子 ═╗═╝<╗ ║ obj(目的語)
        を <╝   ║ ║ case(格表示)
        得 ═╗═══╝<╝ parataxis(隣接表現)
        ず <╝       advmod(連用修飾語)
        ```
        
        `udkundoku.load()` is an alias for `udkanbun.load()` of [UD-Kanbun](https://github.com/KoichiYasuoka/UD-Kanbun/). `udkundoku.translate()` is a transcriptive converter from Classical Chinese (under Universal Dependencies of UD-Kanbun) into Modern Japanese (under Universal Dependencies of [UniDic2UD](https://github.com/KoichiYasuoka/UniDic2UD/)). `udkundoku.reorder()` is called to rearrange Classical Chinese into Japanese word-order inside `udkundoku.translate()`. `to_tree()` and `to_svg()` are borrowed from those of UD-Kanbun.
        
        You can simply use `udkundoku` on the command line:
        ```sh
        echo 不入虎穴不得虎子 | udkundoku -j
        ```
        
        ## HTTP-server usage
        
        ```sh
        python -m udkundoku.server 5000
        ```
        Try to connect `http://127.0.0.1:5000` with your local browser. Input a Classical Chinese sentence there and push 解析-button (at least) three times.
        
        ![不入虎穴不得虎子](https://raw.githubusercontent.com/KoichiYasuoka/UD-Kundoku/master/example.png)
        
        ## Installation for Linux
        
        Tar-ball is available for Linux, and is installed by default when you use `pip`:
        ```sh
        pip install udkundoku
        ```
        [旧仮名口語UniDic](https://unidic.ninjal.ac.jp/download_all#unidic_qkana) is automatically downloaded for UniDic2UD.
        
        ## Installation for Cygwin
        
        Make sure to get `gcc-g++` `python37-pip` `python37-devel` packages, and then:
        ```sh
        pip3.7 install udkundoku
        ```
        Use `python3.7` command in [Cygwin](https://www.cygwin.com/install.html) instead of `python`.
        
        ## Installation for Jupyter Notebook (Google Colaboratory)
        
        ```py
        !pip install udkundoku
        ```
        
        Try [notebook](https://colab.research.google.com/github/KoichiYasuoka/UD-Kundoku/blob/master/udkundoku.ipynb) for Google Colaboratory.
        
        ## Author
        
        Koichi Yasuoka (安岡孝一)
        
        ## References
        
        * 安岡孝一: [漢文の依存文法解析にもとづく自動訓読システム](http://hdl.handle.net/2433/259315), 日本漢字学会第3回研究大会予稿集(2020年11月), pp.60-73.
        * 安岡孝一: [漢文の依存文法解析と返り点の関係について](http://hdl.handle.net/2433/235609), 日本漢字学会第1回研究大会予稿集(2018年12月), pp.33-48.
        
        
Keywords: udkanbun nlp
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Natural Language :: Japanese
Requires-Python: >=3.6
Description-Content-Type: text/markdown
