From 372c9bd34c61bf4d7b7e51b3db2ff69975199a2b Mon Sep 17 00:00:00 2001 From: Joshua Hamilton Date: Sat, 28 Sep 2024 13:10:08 -0500 Subject: [PATCH 1/4] all tests now pass --- tests/test_jreadability.py | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/tests/test_jreadability.py b/tests/test_jreadability.py index 485ab10..e165f29 100644 --- a/tests/test_jreadability.py +++ b/tests/test_jreadability.py @@ -71,19 +71,17 @@ def test_lower_intermediate(self): assert 3.5 <= score < 4.5 - # test currently failing (score=4.19) - #def test_upper_elementary(self): - # - # score = compute_readability(upper_elementary_text) - # - # assert 4.5 <= score < 5.5 - - # test currently failing (score=5.12) - #def test_lower_elementary(self): - # - # score = compute_readability(lower_elementary_text) - # - # assert 5.5 <= score < 6.5 + def test_upper_elementary(self): + + score = compute_readability(upper_elementary_text) + + assert 4.5 <= score < 5.5 + + def test_lower_elementary(self): + + score = compute_readability(lower_elementary_text) + + assert 5.5 <= score < 6.5 def test_batch(self): From 4217271068ac053ccbe87eda2ddd1e4aa73d919c Mon Sep 17 00:00:00 2001 From: Joshua Hamilton Date: Sat, 28 Sep 2024 13:20:56 -0500 Subject: [PATCH 2/4] udate readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 638c62f..af981c4 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@
-jreadability allows python developers to calculate the readability of Japanese text using the model developed by Jae-ho Lee and Yoichiro Hasebe in "[Readability measurement of Japanese texts based on levelled corpora](https://researchmap.jp/jhlee/published_papers/21426109)." **Note that this is not an official implementation.** +jReadability allows python developers to calculate the readability of Japanese text using the model developed by Jae-ho Lee and Yoichiro Hasebe in "[Introducing a readability evaluation system for Japanese language education](https://jreadability.net/file/hasebe-lee-2015-castelj.pdf)." **Note that this is not an official implementation.** ## Installation @@ -33,7 +33,7 @@ text = 'おはようございます！今日は天気がいいですね。' score = compute_readability(text) -print(score) # 5.596333333333334 +print(score) # 6.438000000000001 ``` ## Readability scores @@ -56,7 +56,7 @@ readability = {mean number of words per sentence} * -0.056 + {proportion of kango} * -0.126 + {proportion of wago} * -0.042 + {proportion of verbs} * -0.145 - + {proportion of auxiliary verbs} * -0.044 + + {proportion of particles} * -0.044 + 11.724 ``` @@ -64,7 +64,7 @@ readability = {mean number of words per sentence} * -0.056 #### Note on model consistency -The readability scores produced by this python package tend to differ slightly from the scores produced on the official [jreadability website](https://jreadability.net/sys/en). This is likely due to the version difference in UniDic between these two implementations as this package uses UniDic 2.1.2 while theirs uses UniDic 2.2.0. This issue will hopefully be resolved in the future. +The readability scores produced by this python package tend to differ slightly from the scores produced on the official [jreadability website](https://jreadability.net/sys/en). This is likely due to the version difference in UniDic between these two implementations as this package uses UniDic 2.1.2 while theirs uses UniDic 2.2.0. This issue may be resolved in the future. ## Batch processing From 8dcc6bb379e308c0688d7af13a44b7a2c60e7c17 Mon Sep 17 00:00:00 2001 From: Joshua Hamilton Date: Sat, 28 Sep 2024 13:21:50 -0500 Subject: [PATCH 3/4] bump patch 1.1.0 -> 1.1.1 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 2311407..84cf72a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "jreadability" -version = "1.1.0" +version = "1.1.1" description = "Calculate readability scores for Japanese texts." readme = "README.md" authors = [{ name = "Joshua Hamilton", email = "hamiltonjoshuadavid@gmail.com" }] From c7626e25c03708190c935d9d8aaed5d43109d985 Mon Sep 17 00:00:00 2001 From: Joshua Hamilton Date: Sat, 28 Sep 2024 13:31:35 -0500 Subject: [PATCH 4/4] link to other implementations --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index af981c4..f14d9a8 100644 --- a/README.md +++ b/README.md @@ -82,4 +82,10 @@ for text in texts: score = compute_readability(text, tagger) # fast :D #score = compute_readability(text) # slow :'( ... -``` \ No newline at end of file +``` + +## Other implementations + +The official jReadability implementation can be found on [jreadability.net](https://jreadability.net/) + +A node.js implementation can also be found [here](https://github.com/Bennycopter/jreadability). \ No newline at end of file