.. image:: https://jacksonllee.com/logos/pycantonese-logo.png :width: 250px
Full Documentation: https://pycantonese.org
|
.. image:: https://badge.fury.io/py/pycantonese.svg :target: https://pypi.python.org/pypi/pycantonese :alt: PyPI version
.. image:: https://img.shields.io/pypi/pyversions/pycantonese.svg :target: https://pypi.python.org/pypi/pycantonese :alt: Supported Python versions
.. image:: https://circleci.com/gh/jacksonllee/pycantonese.svg?style=shield :target: https://circleci.com/gh/jacksonllee/pycantonese :alt: CircleCI Builds
|
.. start-sphinx-website-index-page
PyCantonese is a Python library for Cantonese linguistics and natural language processing (NLP). Currently implemented features (more to come!):
.. _download_install:
To download and install the stable, most recent version::
$ pip install --upgrade pycantonese
Ready for more?
Check out the Quickstart <https://pycantonese.org/quickstart.html>
_ page.
If your team would like professional assistance in using PyCantonese,
freelance consulting and training services are available for both academic and commercial groups.
Please email Jackson L. Lee <https://jacksonllee.com>
_.
If you have found PyCantonese useful and would like to offer support,
buying me a coffee <https://www.buymeacoffee.com/pycantonese>
_ would go a long way!
Facebook <https://www.facebook.com/pycantonese>
and Twitter <https://twitter.com/pycantonese>
PyCantonese is authored and maintained by Jackson L. Lee <https://jacksonllee.com>
_.
Lee, Jackson L., Litong Chen, Charles Lam, Chaak Ming Lau, and Tsz-Him Tsui. 2022.
PyCantonese: Cantonese Linguistics and NLP in Python <https://jacksonllee.com/papers/pycantonese_lrec_2022-05-06.pdf>
_.
Proceedings of the 13th Language Resources and Evaluation Conference.
.. code-block:: latex
@inproceedings{lee-etal-2022-pycantonese,
title = "PyCantonese: Cantonese Linguistics and NLP in Python",
author = "Lee, Jackson L. and
Chen, Litong and
Lam, Charles and
Lau, Chaak Ming and
Tsui, Tsz-Him",
booktitle = "Proceedings of The 13th Language Resources and Evaluation Conference",
month = june,
year = "2022",
publisher = "European Language Resources Association",
language = "English",
}
MIT License. Please see LICENSE.txt
in the GitHub source code for details.
The HKCanCor dataset included in PyCantonese is substantially modified from
its source in terms of format. The original dataset has a CC BY license.
Please see pycantonese/data/hkcancor/README.md
in the GitHub source code for details.
The rime-cantonese data (release 2021.05.16) is
incorporated into PyCantonese for word segmentation and
characters-to-Jyutping conversion.
This data has a CC BY 4.0 license.
Please see pycantonese/data/rime_cantonese/README.md
in the GitHub source code for details.
The PyCantonese logo is the Chinese character 粵 meaning Cantonese, with artistic design by albino.snowman (Instagram handle).
Wonderful resources with a permissive license that have been incorporated into PyCantonese:
Individuals who have contributed pull requests, bug reports, and other feedback (in alphabetical order of last names):
.. end-sphinx-website-index-page
Please see CHANGELOG.md
.
The latest code under development is available on GitHub at
jacksonllee/pycantonese <https://github.com/jacksonllee/pycantonese>
_.
To obtain this version for experimental features or for development:
.. code-block:: bash
$ git clone https://github.com/jacksonllee/pycantonese.git $ cd pycantonese $ pip install -e ".[dev]"
To run tests and styling checks:
.. code-block:: bash
$ pytest $ flake8 src tests $ black --check src tests
To build the documentation website files:
.. code-block:: bash
$ python docs/source/build_docs.py