burmesenlp 1.0.1__tar.gz

burmesenlp-1.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

burmesenlp-1.0.1/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: burmesenlp
+Version: 1.0.1
+Summary: Production-oriented Myanmar (Burmese) NLP preprocessing: syllable, word and sentence segmentation, rule-based POS tagging, and phrase chunking.
+Author: BurmeseNLP contributors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/aungthuhein2005/burmesenlp
+Project-URL: Documentation, https://aungthuhein2005.github.io/burmesenlp/
+Project-URL: Repository, https://github.com/aungthuhein2005/burmesenlp
+Project-URL: Issues, https://github.com/aungthuhein2005/burmesenlp/issues
+Project-URL: Changelog, https://github.com/aungthuhein2005/burmesenlp/blob/main/CHANGELOG.md
+Keywords: myanmar,burmese,nlp,segmentation,pos-tagging,chunking
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: mypy<2,>=1.8; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material>=9.5; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.26; extra == "docs"
+Dynamic: license-file
+
+# BurmeseNLP
+
+Rule-based Myanmar (Burmese) NLP preprocessing: normalization, syllable / word /
+sentence segmentation, POS tagging, phrase chunking, gazetteer NER, clause
+parsing, and corpus export.
+
+## Install
+
+```bash
+pip install burmesenlp
+```
+
+Requires **Python 3.9+**. Runtime depends on **PyYAML**.
+
+No dictionary path or model download is required.
+
+## Quick start
+
+```python
+from burmesenlp import (
+    BurmeseNLP,
+    CorpusExporter,
+    process,
+    word_tokenize,
+    pos_tag,
+    zg2uni,
+)
+import json
+
+# One-shot pipeline (returns a Document)
+doc = process("စာပေကိုဖတ်သည်။သူကစားသည်။")
+doc.words
+doc.sentences
+doc.pos_tags
+doc.chunks
+doc.entities   # gazetteer NER (empty if no list hits)
+doc.clauses    # clause layer over phrases
+
+# Document JSON
+json.dumps(doc.to_dict(), ensure_ascii=False, indent=2)
+```
+
+`Document` also supports dict-style access (`doc["words"]`).
+
+## Gazetteer NER & clauses
+
+```python
+doc = process("ဒေါ်အောင်ဆန်းစုကြည် ရန်ကုန်ကို သွားသည်။")
+for e in doc.entities:
+    print(e.text, e.entity_type)
+
+for clause in doc.clauses:
+    print(clause.type, clause.text)
+
+# Skip gazetteer matching
+doc = process("...", gazetteer=False)
+```
+
+## Corpus export
+
+```python
+from burmesenlp import CorpusExporter, process
+
+doc = process("စာပေကိုဖတ်သည်။")
+exporter = CorpusExporter()
+print(exporter.to_jsonl(doc))   # also CoNLL / BRAT / Label Studio
+```
+
+## Stateful pipeline
+
+```python
+from burmesenlp import BurmeseNLP
+
+nlp = BurmeseNLP()
+nlp.syllable_segment("မြန်မာစာပေ")
+nlp.word_segment("ကျွန်တော်ကျောင်းသို့သွားသည်")
+nlp.sentence_segment("စာပေကိုဖတ်သည်။သူကစားသည်။")
+nlp.pos_tag(["ကျွန်တော်", "ကျောင်း", "သို့", "သွား", "သည်"])
+```
+
+## Helpers
+
+```python
+from burmesenlp import word_tokenize, pos_tag, zg2uni
+
+word_tokenize("ကျွန်တော်ကျောင်းသို့သွားသည်", engine="longest")
+pos_tag(["ကျွန်တော်", "ကျောင်း"], engine="rule")
+zg2uni("ျမန္မာစာေပ")
+```
+
+## Custom dictionary
+
+```python
+from burmesenlp import BurmeseNLP
+
+nlp = BurmeseNLP(dictionary_path="my_dict.json")  # or .txt import
+nlp.add_to_dictionary("နည်းပညာ", ["NOUN"])
+nlp.save_dictionary("my_dict.json")
+```
+
+Canonical JSON: `{ "word": ["tag1", "tag2"] }`. Tags must be from
+`burmesenlp.POS_TAGS`.
+
+## CLI
+
+```bash
+burmesenlp --mode words "ကျွန်တော်ကျောင်းသို့သွားသည်။"
+burmesenlp --json --mode all "စာပေကိုဖတ်သည်။"
+burmesenlp --mode zg2uni "ျမန္မာစာေပ"
+```
+

burmesenlp-1.0.1/README.md

@@ -0,0 +1,205 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/aungthuhein2005/burmesenlp/main/docs/images/logo.png" alt="BurmeseNLP" width="180" />
+</p>
+
+# BurmeseNLP
+
+**BurmeseNLP** (`burmesenlp`) is an open-source Python library for rule-based
+Myanmar (Burmese) natural language processing.
+
+Version **1.0** focuses on preprocessing: normalization, Zawgyi ↔ Unicode
+**APIs**, syllable / word / sentence segmentation, multi-word expressions
+(BMWE), lexicon management, rule-based POS tagging, phrase chunking,
+gazetteer NER, clause parsing, and corpus export.
+It is fast, dependency-light, and designed as the foundation for future
+hybrid and machine-learning engines.
+
+```bash
+pip install burmesenlp
+```
+
+**Docs:** [https://aungthuhein2005.github.io/burmesenlp/](https://aungthuhein2005.github.io/burmesenlp/)
+(source in [`docs/`](docs/); build with `pip install -e ".[docs]" && mkdocs serve`)
+
+```python
+from burmesenlp import process
+
+doc = process("ကျွန်တော်ကျောင်းသို့သွားသည်။")
+print(doc["words"])
+# ['ကျွန်တော်', 'ကျောင်း', 'သို့', 'သွား', 'သည်', '။']
+```
+
+No dictionary path or model download is required.
+
+## Features
+
+- **Normalization** — strip zero-width characters, Unicode NFC
+- **Zawgyi ↔ Unicode** — conversion rules plus a heuristic detector
+- **Syllable tokenization** — sylbreak-style boundaries
+- **Word segmentation** — dictionary longest-match (`engine="longest"`)
+- **Sentence segmentation** — grammar-aware (after POS + phrase chunks)
+- **Multi-word expressions** — BMWE trie merge (idioms)
+- **Lexicon** — bundled tagged vocabulary (~24k entries) + mergeable custom JSON/txt
+- **POS tagging** — rule / lexicon-based (`engine="rule"`)
+- **Gazetteer NER** — list-based entities (`doc.entities`; PERSON / TOWN / …), on by default
+- **Phrase chunking** — YAML-driven NP / VP / PP / … (entity spans locked as NP)
+- **Clause parsing** — MAIN / PURPOSE / … over phrases (`doc.clauses`)
+- **Corpus export** — JSONL / CoNLL / BRAT / Label Studio via `CorpusExporter`
+- **Pipeline API** — `process(text)` and stateful `BurmeseNLP`
+- **CLI** — `burmesenlp` console script
+
+## Installation
+
+```bash
+pip install burmesenlp
+```
+
+From a clone (development):
+
+```bash
+pip install -e ".[dev]"
+```
+
+Requires **Python 3.9+**. Runtime depends on **PyYAML** (phrase grammar); there
+are no other third-party NLP dependencies.
+
+## Quick start
+
+```python
+from burmesenlp import (
+    BurmeseNLP,
+    CorpusExporter,
+    process,
+    word_tokenize,
+    pos_tag,
+    zg2uni,
+)
+import json
+
+# One-shot pipeline (returns a Document)
+doc = process("စာပေကိုဖတ်သည်။သူကစားသည်။")
+doc.words
+doc.sentences
+doc.pos_tags
+doc.chunks
+doc.entities   # gazetteer NER (empty if no list hits)
+doc.clauses    # clause layer over phrases
+
+# Document JSON
+json.dumps(doc.to_dict(), ensure_ascii=False, indent=2)
+
+# Gazetteer NER (default on; skip with gazetteer=False)
+doc = process("ဒေါ်အောင်ဆန်းစုကြည် ရန်ကုန်ကို သွားသည်။")
+for e in doc.entities:
+    print(e.text, e.entity_type)
+
+# Clause parse
+for clause in doc.clauses:
+    print(clause.type, clause.text)
+
+# Corpus export (JSONL / CoNLL / BRAT / Label Studio)
+exporter = CorpusExporter()
+print(exporter.to_jsonl(doc))
+
+# Stateful pipeline
+nlp = BurmeseNLP()
+nlp.syllable_segment("မြန်မာစာပေ")
+nlp.word_segment("ကျွန်တော်ကျောင်းသို့သွားသည်")
+nlp.sentence_segment("စာပေကိုဖတ်သည်။သူကစားသည်။")
+nlp.pos_tag(["ကျွန်တော်", "ကျောင်း", "သို့", "သွား", "သည်"])
+
+# Helpers
+word_tokenize("ကျွန်တော်ကျောင်းသို့သွားသည်", engine="longest")
+pos_tag(["ကျွန်တော်", "ကျောင်း"], engine="rule")
+zg2uni("ျမန္မာစာေပ")
+```
+
+### Custom dictionary
+
+`BurmeseNLP()` loads bundled `lexicon/data/*.json` merged with closed-class
+seed lists. Extra files **merge** onto that default (per-word tag union).
+Missing or malformed files raise `LexiconError` — there is no silent fallback.
+
+```python
+nlp = BurmeseNLP(dictionary_path="my_dict.json")  # or .txt import
+nlp.add_to_dictionary("နည်းပညာ", ["NOUN"])
+nlp.save_dictionary("my_dict.json")               # atomic JSON write
+```
+
+**Canonical JSON:** `{ "word": ["tag1", "tag2"] }`
+
+**Import** `.txt`**:** `word<TAB>tag1,tag2`
+
+Tags must be from `burmesenlp.POS_TAGS`. To load a file *instead of* the
+bundled default, use `BurmeseNLP(lexicon=Lexicon.from_file(path))`.
+
+### CLI
+
+```bash
+burmesenlp --mode words "ကျွန်တော်ကျောင်းသို့သွားသည်။"
+burmesenlp --json --mode all "စာပေကိုဖတ်သည်။"
+burmesenlp --mode zg2uni "ျမန္မာစာေပ"
+```
+
+## Module overview
+
+| Module      | Role                                           |
+| ----------- | ---------------------------------------------- |
+| `pipeline`  | `BurmeseNLP`, `process()`, `Document`          |
+| `normalize` | NFC / zero-width / Zawgyi heuristic            |
+| `zawgyi`    | `uni2zg` / `zg2uni` / `to_unicode`             |
+| `tokenize`  | syllable, word (`longest`), sentences          |
+| `mwe`       | BMWE multi-word expression merge               |
+| `tag`       | rule-based POS                                 |
+| `gazetteer` | list-based NER → `Document.entities`           |
+| `chunking`  | phrase chunks + clause parse                   |
+| `export`    | `CorpusExporter` / `CorpusImporter`            |
+| `lexicon`   | dictionary load / merge / save                 |
+| `grammar`   | closed-class lists                             |
+| `cli`       | console entry point                            |
+
+See [STRUCTURE.md](STRUCTURE.md) for the full layout and the
+[documentation site](https://aungthuhein2005.github.io/burmesenlp/) for guides
+and API reference. Corpus trees under `corpus/` hold V1 grammar/idioms/gazetteers
+plus scaffolds for later versions.
+
+## Current limitations
+
+Version 1 is **rule-based only**:
+
+- No machine learning, Transformers, CRF, or embeddings
+- No SentencePiece / BPE / EvoPiece tokenizers
+- NER is **gazetteer / list-based only** (not statistical or neural); coverage
+  is limited to bundled entity lists, and short place names need locative cues
+- No sentiment analysis or spell checking
+- Word segmentation quality depends on lexicon coverage; longest-match may
+  prefer compounds present in the dictionary
+- POS and chunk rules are heuristic — expect residual tagging/chunk errors
+- Zawgyi *detection* is heuristic — prefer explicit `zg2uni` when encoding
+  is known
+- `process()` **does not auto-convert Zawgyi.** It only runs `normalize()`
+  (NFC / zero-width). Convert first:
+
+```python
+from burmesenlp import zg2uni, process
+
+doc = process(zg2uni(zawgyi_text))
+```
+
+These gaps are intentional for a lightweight, deterministic V1.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md), [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md),
+and [SECURITY.md](SECURITY.md).
+Please keep V1 PRs focused on rule-based quality, packaging, docs, and tests —
+do not add unfinished ML features to the public API.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).
+
+## References
+
+- Ye Kyaw Thu et al., myPOS / sylbreak conventions for Myanmar NLP
+- Rabbit Converter–style Zawgyi ↔ Unicode rule tables

burmesenlp-1.0.1/README.pypi.md

@@ -0,0 +1,111 @@
+# BurmeseNLP
+
+Rule-based Myanmar (Burmese) NLP preprocessing: normalization, syllable / word /
+sentence segmentation, POS tagging, phrase chunking, gazetteer NER, clause
+parsing, and corpus export.
+
+## Install
+
+```bash
+pip install burmesenlp
+```
+
+Requires **Python 3.9+**. Runtime depends on **PyYAML**.
+
+No dictionary path or model download is required.
+
+## Quick start
+
+```python
+from burmesenlp import (
+    BurmeseNLP,
+    CorpusExporter,
+    process,
+    word_tokenize,
+    pos_tag,
+    zg2uni,
+)
+import json
+
+# One-shot pipeline (returns a Document)
+doc = process("စာပေကိုဖတ်သည်။သူကစားသည်။")
+doc.words
+doc.sentences
+doc.pos_tags
+doc.chunks
+doc.entities   # gazetteer NER (empty if no list hits)
+doc.clauses    # clause layer over phrases
+
+# Document JSON
+json.dumps(doc.to_dict(), ensure_ascii=False, indent=2)
+```
+
+`Document` also supports dict-style access (`doc["words"]`).
+
+## Gazetteer NER & clauses
+
+```python
+doc = process("ဒေါ်အောင်ဆန်းစုကြည် ရန်ကုန်ကို သွားသည်။")
+for e in doc.entities:
+    print(e.text, e.entity_type)
+
+for clause in doc.clauses:
+    print(clause.type, clause.text)
+
+# Skip gazetteer matching
+doc = process("...", gazetteer=False)
+```
+
+## Corpus export
+
+```python
+from burmesenlp import CorpusExporter, process
+
+doc = process("စာပေကိုဖတ်သည်။")
+exporter = CorpusExporter()
+print(exporter.to_jsonl(doc))   # also CoNLL / BRAT / Label Studio
+```
+
+## Stateful pipeline
+
+```python
+from burmesenlp import BurmeseNLP
+
+nlp = BurmeseNLP()
+nlp.syllable_segment("မြန်မာစာပေ")
+nlp.word_segment("ကျွန်တော်ကျောင်းသို့သွားသည်")
+nlp.sentence_segment("စာပေကိုဖတ်သည်။သူကစားသည်။")
+nlp.pos_tag(["ကျွန်တော်", "ကျောင်း", "သို့", "သွား", "သည်"])
+```
+
+## Helpers
+
+```python
+from burmesenlp import word_tokenize, pos_tag, zg2uni
+
+word_tokenize("ကျွန်တော်ကျောင်းသို့သွားသည်", engine="longest")
+pos_tag(["ကျွန်တော်", "ကျောင်း"], engine="rule")
+zg2uni("ျမန္မာစာေပ")
+```
+
+## Custom dictionary
+
+```python
+from burmesenlp import BurmeseNLP
+
+nlp = BurmeseNLP(dictionary_path="my_dict.json")  # or .txt import
+nlp.add_to_dictionary("နည်းပညာ", ["NOUN"])
+nlp.save_dictionary("my_dict.json")
+```
+
+Canonical JSON: `{ "word": ["tag1", "tag2"] }`. Tags must be from
+`burmesenlp.POS_TAGS`.
+
+## CLI
+
+```bash
+burmesenlp --mode words "ကျွန်တော်ကျောင်းသို့သွားသည်။"
+burmesenlp --json --mode all "စာပေကိုဖတ်သည်။"
+burmesenlp --mode zg2uni "ျမန္မာစာေပ"
+```
+