Skip to content

Commit 0551d6e

Browse files
authored
Merge pull request #1296 from bact/dev
Fix markdownlint
2 parents 84a342d + 4fd5f9b commit 0551d6e

6 files changed

Lines changed: 42 additions & 18 deletions

File tree

.markdownlint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"default": true,
33
"MD013": {
44
"line_length": 150,
5-
"tables": false
5+
"tables": false,
6+
"code_blocks": false
67
},
78
"MD033": false,
89
"MD041": false,

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ please cite the software as follows:
104104

105105
> Phatthiyaphaibun, Wannaphong, Korakot Chaovavanich, Charin Polpanumas,
106106
> Arthit Suriyawongkul, Lalita Lowphansirikul, and Pattarawat Chormai.
107-
> Pythainlp: Thai Natural Language Processing in Python”.
107+
> PyThaiNLP: Thai Natural Language Processing in Python”.
108108
> Zenodo, 2 June 2024. <http://doi.org/10.5281/zenodo.3519354>.
109109
110110
with this BibTeX entry:

README_TH.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,10 @@ PyThaiNLP ดาวน์โหลดข้อมูล (ดูแค็ตต
131131

132132
หากคุณใช้ซอฟต์แวร์ `PyThaiNLP` ในโครงงานหรืองานวิจัยของคุณ คุณสามารถอ้างอิงได้ตามนี้:
133133

134-
> Phatthiyaphaibun, Wannaphong, Korakot Chaovavanich, Charin Polpanumas, Arthit Suriyawongkul, Lalita Lowphansirikul, and Pattarawat Chormai. “Pythainlp: Thai Natural Language Processing in Python”. Zenodo, 2 June 2024. <http://doi.org/10.5281/zenodo.3519354>.
134+
> Phatthiyaphaibun, Wannaphong, Korakot Chaovavanich, Charin Polpanumas,
135+
> Arthit Suriyawongkul, Lalita Lowphansirikul, and Pattarawat Chormai.
136+
> “PyThaiNLP: Thai Natural Language Processing in Python”.
137+
> Zenodo, 2 June 2024. <http://doi.org/10.5281/zenodo.3519354>.
135138
136139
โดยใช้รายการ BibTeX นี้:
137140

@@ -157,7 +160,15 @@ PyThaiNLP ดาวน์โหลดข้อมูล (ดูแค็ตต
157160
[NLP-OSS 2023](https://nlposs.github.io/2023/)
158161
คุณสามารถอ้างอิงได้ตามนี้:
159162

160-
> Wannaphong Phatthiyaphaibun, Korakot Chaovavanich, Charin Polpanumas, Arthit Suriyawongkul, Lalita Lowphansirikul, Pattarawat Chormai, Peerat Limkonchotiwat, Thanathip Suntorntip, and Can Udomcharoenchaikit. 2023. [PyThaiNLP: Thai Natural Language Processing in Python.](https://aclanthology.org/2023.nlposs-1.4) In Proceedings of the 3rd Workshop for Natural Language Processing Open Source Software (NLP-OSS 2023), pages 25–36, Singapore, Singapore. Empirical Methods in Natural Language Processing.
163+
> Wannaphong Phatthiyaphaibun, Korakot Chaovavanich, Charin Polpanumas,
164+
> Arthit Suriyawongkul, Lalita Lowphansirikul, Pattarawat Chormai,
165+
> Peerat Limkonchotiwat, Thanathip Suntorntip, and Can Udomcharoenchaikit.
166+
> 2023.
167+
> [PyThaiNLP: Thai Natural Language Processing in Python.](https://aclanthology.org/2023.nlposs-1.4)
168+
> In Proceedings of the 3rd Workshop for Natural Language Processing
169+
> Open Source Software (NLP-OSS 2023),
170+
> pages 25–36, Singapore, Singapore.
171+
> Empirical Methods in Natural Language Processing.
161172
162173
โดยใช้รายการ BibTeX นี้:
163174

pythainlp/corpus/corpus_license.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
# Corpus License
22

3-
- Corpora, datasets, and documentation created by the PyThaiNLP project are released under [Creative Commons Zero 1.0 Universal Public Domain Dedication License](https://creativecommons.org/publicdomain/zero/1.0/) (CC0).
4-
- Language models created by the PyThaiNLP project are released under [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/) (CC-by).
5-
- For more information about corpora that PyThaiNLP uses, see [https://github.com/PyThaiNLP/pythainlp-corpus/](https://github.com/PyThaiNLP/pythainlp-corpus/).
3+
- Corpora, datasets, and documentation created by the PyThaiNLP project are
4+
released under
5+
[Creative Commons Zero 1.0 Universal Public Domain Dedication License][cc0]
6+
(CC0-1.0).
7+
- Language models created by the PyThaiNLP project are released under
8+
[Creative Commons Attribution 4.0 International Public License][cc-by] (CC-BY-4.0).
9+
- For more information about corpora that PyThaiNLP uses, see
10+
<https://github.com/PyThaiNLP/pythainlp-corpus/>.
11+
12+
[cc0]: https://creativecommons.org/publicdomain/zero/1.0/
13+
[cc-by]: https://creativecommons.org/licenses/by/4.0/
614

715
## Dictionaries and Word Lists
816

tests/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
SPDX-FileCopyrightText: 2026 PyThaiNLP Project
23
SPDX-FileType: DOCUMENTATION
34
SPDX-License-Identifier: Apache-2.0
@@ -88,11 +89,13 @@ on their dependency requirements.
8889

8990
Different ML/AI frameworks often have conflicting version requirements for
9091
their dependencies. For example:
92+
9193
- PyTorch and TensorFlow may require different versions of numpy or protobuf
9294
- Large frameworks take significant time to install (~1-3 GB each)
9395
- Some packages require Cython compilation or system libraries
9496

9597
By separating tests by dependency group, we can:
98+
9699
- Test each framework independently without conflicts
97100
- Optimize CI/CD resources by running only relevant test groups
98101
- Make it easier for developers to test specific functionality
@@ -106,9 +109,9 @@ By separating tests by dependency group, we can:
106109
- Use this for comprehensive testing when all dependencies are available
107110
- Test case class suffix: `TestCaseN`
108111

109-
#### Modular suites by dependency:
112+
#### Modular suites by dependency
110113

111-
**PyTorch-based: tests.noauto_torch**
114+
##### PyTorch-based: tests.noauto_torch
112115

113116
- Run `unittest tests.noauto_torch`
114117
- Need dependencies from `pip install "pythainlp[noauto-torch]"`
@@ -121,7 +124,7 @@ By separating tests by dependency group, we can:
121124
- Dependencies: ~2-3 GB
122125
- Test case class suffix: `TestCaseN`
123126

124-
**TensorFlow-based: tests.noauto_tensorflow**
127+
##### TensorFlow-based: tests.noauto_tensorflow
125128

126129
- Run `unittest tests.noauto_tensorflow`
127130
- Need dependencies from `pip install "pythainlp[noauto-tensorflow]"`
@@ -131,7 +134,7 @@ By separating tests by dependency group, we can:
131134
- Note: May conflict with PyTorch dependencies
132135
- Test case class suffix: `TestCaseN`
133136

134-
**ONNX Runtime-based: tests.noauto_onnx**
137+
##### ONNX Runtime-based: tests.noauto_onnx
135138

136139
- Run `unittest tests.noauto_onnx`
137140
- Need dependencies from `pip install "pythainlp[noauto-onnx]"`
@@ -140,7 +143,7 @@ By separating tests by dependency group, we can:
140143
- Dependencies: ~200-500 MB
141144
- Test case class suffix: `TestCaseN`
142145

143-
**Cython-compiled: tests.noauto_cython**
146+
##### Cython-compiled: tests.noauto_cython
144147

145148
- Run `unittest tests.noauto_cython`
146149
- Need dependencies from `pip install "pythainlp[noauto-cython]"`
@@ -150,12 +153,12 @@ By separating tests by dependency group, we can:
150153
- Platform-specific build requirements
151154
- Test case class suffix: `TestCaseN`
152155

153-
**Network-dependent: tests.noauto_network**
156+
##### Network-dependent: tests.noauto_network
154157

155158
- Run `unittest tests.noauto_network`
156159
- Need dependencies from `pip install "pythainlp[noauto-network]"`
157160
- Tests requiring network access:
158-
- HuggingFace Hub model downloads
161+
- Hugging Face Hub model downloads
159162
- External API calls
160163
- Requires: Internet connection, may involve large downloads
161164
- Test case class suffix: `TestCaseN`

tests/corpus/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
SPDX-FileCopyrightText: 2026 PyThaiNLP Project
23
SPDX-FileType: DOCUMENTATION
34
SPDX-License-Identifier: Apache-2.0
@@ -91,11 +92,11 @@ Each test verifies:
9192
1. **Loadability**: File can be loaded without errors
9293
2. **Type correctness**: Returns expected data type
9394
(frozenset, list, dict)
94-
4. **Non-empty**: Contains actual data
95-
5. **Format validity**: Data structure matches expected format
96-
6. **Content validity**: Contains expected content
95+
3. **Non-empty**: Contains actual data
96+
4. **Format validity**: Data structure matches expected format
97+
5. **Content validity**: Contains expected content
9798
(e.g., Thai characters)
98-
8. **Catalog functionality**: Catalog can be downloaded
99+
6. **Catalog functionality**: Catalog can be downloaded
99100
and queried correctly
100101

101102
## Adding new tests

0 commit comments

Comments
 (0)