Skip to content

Commit a0ede66

Browse files
authored
Update README.md
1 parent 01e81c1 commit a0ede66

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

tests/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Tests are categorized into three groups: core, compact, and extra.
44

55
## Core Tests (test_*.py)
66

7+
- Run `unittest tests.core`
78
- Focus on core functionalities.
89
- Do not rely on external dependencies beyond the standard library,
910
except for `requests` which is used for corpus downloading.
@@ -12,6 +13,7 @@ Tests are categorized into three groups: core, compact, and extra.
1213

1314
## Compact Tests (testc_*.py)
1415

16+
- Run `unittest tests.compact`
1517
- Test a limited set of additional functionalities that rely on optional
1618
dependencies specified in `requirements.txt`.
1719
- These dependencies are `PyYAML`, `numpy`, `pyicu`, `python-crfsuite`, and
@@ -20,13 +22,15 @@ Tests are categorized into three groups: core, compact, and extra.
2022

2123
## Extra Tests (testx_*.py)
2224

25+
- Run `unittest tests.extra`
2326
- Explore functionalities that rely on optional dependencies specified in the
2427
`extras` section of `setup.py`.
25-
- These dependencies might include libraries like `gensim`, `nltk`, or `torch`.
28+
- These dependencies might include libraries like `gensim`, `tltk`, or `torch`.
2629
- Due to dependency complexities, these functionalities are not part of the
2730
automated test suite and will not be tested in the CI/CD pipeline.
2831

2932
## Default Test Suite
3033

31-
The default test suite, executed by the `unittest tests` command, is defined
32-
within `__init__.py` in this directory.
34+
The default test suite, triggered by the `unittest tests` command, encompasses
35+
all test cases within the `tests.core` and `tests.compact` packages.
36+
This suite is defined within the `__init__.py` file in this directory.

0 commit comments

Comments
 (0)