|
| 1 | +--- |
| 2 | +SPDX-FileCopyrightText: 2016-2026 PyThaiNLP Project |
| 3 | +SPDX-FileType: DOCUMENTATION |
| 4 | +SPDX-License-Identifier: CC0-1.0 |
| 5 | +--- |
| 6 | + |
| 7 | +# PyThaiNLP development notebooks |
| 8 | + |
| 9 | +This directory contains Jupyter notebooks used for **development and testing purposes**. These notebooks are **not** intended for end-users and are primarily used by developers to: |
| 10 | + |
| 11 | +- Test new features and models |
| 12 | +- Develop ONNX model conversions |
| 13 | +- Experiment with algorithms |
| 14 | +- Debug and validate module functionality |
| 15 | + |
| 16 | +## Notebooks overview |
| 17 | + |
| 18 | +### Testing notebooks |
| 19 | + |
| 20 | +These notebooks test specific module functionality: |
| 21 | + |
| 22 | +- `test_aksonhan.ipynb` - Testing ancient Thai script conversion |
| 23 | +- `test_chat.ipynb` - Testing chatbot functionality with WangChanGLM |
| 24 | +- `test_el.ipynb` - Testing entity linking |
| 25 | +- `test_gzip_classify.ipynb` - Testing GZIP-based classification |
| 26 | +- `test_tcc.ipynb` - Testing Thai Character Cluster tokenization |
| 27 | +- `test_wangchanglm.ipynb` - Testing WangChanGLM text generation |
| 28 | +- `test_wsd.ipynb` - Testing word sense disambiguation |
| 29 | + |
| 30 | +### Development tools |
| 31 | + |
| 32 | +These notebooks are used for building and preparing models: |
| 33 | + |
| 34 | +- `convert_thai2rom_to_onnx.ipynb` - Convert Thai romanization models to ONNX format |
| 35 | +- `clean_dict.ipynb` - Dictionary cleaning and preprocessing |
| 36 | +- `create_words.ipynb` - Word list creation and curation |
| 37 | +- `word_detokenize.ipynb` - Testing word detokenization |
| 38 | + |
| 39 | +## For end-users |
| 40 | + |
| 41 | +If you're looking for examples and tutorials on how to use PyThaiNLP, please visit: |
| 42 | + |
| 43 | +- **Official Tutorials**: <https://pythainlp.org/tutorials> |
| 44 | +- **Get Started Guide**: <https://pythainlp.org/tutorials/notebooks/pythainlp_get_started.html> |
| 45 | +- **Documentation**: <https://pythainlp.org/docs> |
| 46 | +- **Example Scripts**: See the `/examples` directory in the repository root |
| 47 | + |
| 48 | +## Note |
| 49 | + |
| 50 | +These notebooks may: |
| 51 | + |
| 52 | +- Require additional dependencies not installed by default |
| 53 | +- Use experimental or development-only features |
| 54 | +- Contain incomplete or work-in-progress code |
| 55 | +- Not be regularly maintained or updated |
0 commit comments