From b1c8e8920861891fdc6e7dcaa270f9221edaec24 Mon Sep 17 00:00:00 2001 From: ma-ilsi Date: Sat, 9 Nov 2024 15:55:26 +0300 Subject: [PATCH] Fix documentation errors and spelling Corrects function usage example for text_dublication_detector.py. Corrects minor spelling errors in project README files. --- README.md | 4 ++-- README.rst | 4 ++-- build/lib/sinatools/utils/text_dublication_detector.py | 4 ++-- sinatools/utils/text_dublication_detector.py | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8086488..1a886ea 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ SinaTools ====================== Open Source Toolkit for Arabic NLP and NLU developed by [SinaLab](http://sina.birzeit.edu/) at Birzeit University. SinaTools is available through Python APIs, command lines, colabs, and online demos. -See the full list of [Available Packages](https://sina.birzeit.edu/sinatools/), which include: (1) [Morphology Tagging](https://sina.birzeit.edu/sinatools/index.html#morph), (2) [Named Entity Recognition (NER)](https://sina.birzeit.edu/sinatools/index.html#ner), (3) [Word Sense Disambiguation (WSD)](https://sina.birzeit.edu/sinatools/index.html#wsd), (4) [Semantic Relatedness](https://sina.birzeit.edu/sinatools/index.html#sr), (5) [Synonymy Extraction and Evaluation](https://sina.birzeit.edu/sinatools/index.html#se), (6) [Relation Extraction](https://sina.birzeit.edu/sinatools/index.html#re), (7) [Utilities](https://sina.birzeit.edu/sinatools/index.html#u) (diacritic-based word matching, Jaccard similarly, parser, tokenizers, corpora processing, transliteration, etc). +See the full list of [Available Packages](https://sina.birzeit.edu/sinatools/), which include: (1) [Morphology Tagging](https://sina.birzeit.edu/sinatools/index.html#morph), (2) [Named Entity Recognition (NER)](https://sina.birzeit.edu/sinatools/index.html#ner), (3) [Word Sense Disambiguation (WSD)](https://sina.birzeit.edu/sinatools/index.html#wsd), (4) [Semantic Relatedness](https://sina.birzeit.edu/sinatools/index.html#sr), (5) [Synonymy Extraction and Evaluation](https://sina.birzeit.edu/sinatools/index.html#se), (6) [Relation Extraction](https://sina.birzeit.edu/sinatools/index.html#re), (7) [Utilities](https://sina.birzeit.edu/sinatools/index.html#u) (diacritic-based word matching, Jaccard similarity, parser, tokenizers, corpora processing, transliteration, etc). See [Demo Pages](https://sina.birzeit.edu/sinatools/). @@ -24,7 +24,7 @@ Some modules in SinaTools require some data files and fine-tuned models to be do Documentation -------- -For information, please refer to the [main page](https://sina.birzeit.edu/sinatools) or the [online domuementation](https://sina.birzeit.edu/sinatools/documentation). +For information, please refer to the [main page](https://sina.birzeit.edu/sinatools) or the [online documentation](https://sina.birzeit.edu/sinatools/documentation). Citation ------- diff --git a/README.rst b/README.rst index 31486b8..bba48fb 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ SinaTools ====================== Open Source Toolkit for Arabic NLP and NLU developed by [SinaLab](http://sina.birzeit.edu/) at Birzeit University. SinaTools is available through Python APIs, command lines, colabs, and online demos. -See the full list of [Available Packages](https://sina.birzeit.edu/sinatools/), which include: (1) [Morphology Tagging](https://sina.birzeit.edu/sinatools/index.html#morph), (2) [Named Entity Recognition (NER)](https://sina.birzeit.edu/sinatools/index.html#ner), (3) [Word Sense Disambiguation (WSD)](https://sina.birzeit.edu/sinatools/index.html#wsd), (4) [Semantic Relatedness](https://sina.birzeit.edu/sinatools/index.html#sr), (5) [Synonymy Extraction and Evaluation](https://sina.birzeit.edu/sinatools/index.html#se), (6) [Relation Extraction](https://sina.birzeit.edu/sinatools/index.html#re), (7) [Utilities](https://sina.birzeit.edu/sinatools/index.html#u) (diacritic-based word matching, Jaccard similarly, parser, tokenizers, corpora processing, transliteration, etc). +See the full list of [Available Packages](https://sina.birzeit.edu/sinatools/), which include: (1) [Morphology Tagging](https://sina.birzeit.edu/sinatools/index.html#morph), (2) [Named Entity Recognition (NER)](https://sina.birzeit.edu/sinatools/index.html#ner), (3) [Word Sense Disambiguation (WSD)](https://sina.birzeit.edu/sinatools/index.html#wsd), (4) [Semantic Relatedness](https://sina.birzeit.edu/sinatools/index.html#sr), (5) [Synonymy Extraction and Evaluation](https://sina.birzeit.edu/sinatools/index.html#se), (6) [Relation Extraction](https://sina.birzeit.edu/sinatools/index.html#re), (7) [Utilities](https://sina.birzeit.edu/sinatools/index.html#u) (diacritic-based word matching, Jaccard similarity, parser, tokenizers, corpora processing, transliteration, etc). See [Demo Pages](https://sina.birzeit.edu/sinatools/). @@ -24,7 +24,7 @@ Some modules in SinaTools require some data files and fine-tuned models to be do Documentation -------- -For information, please refer to the [main page](https://sina.birzeit.edu/sinatools) or the [online domuementation](https://sina.birzeit.edu/sinatools/documentation). +For information, please refer to the [main page](https://sina.birzeit.edu/sinatools) or the [online documentation](https://sina.birzeit.edu/sinatools/documentation). Citation ------- diff --git a/build/lib/sinatools/utils/text_dublication_detector.py b/build/lib/sinatools/utils/text_dublication_detector.py index 6d16147..4b6efb2 100644 --- a/build/lib/sinatools/utils/text_dublication_detector.py +++ b/build/lib/sinatools/utils/text_dublication_detector.py @@ -34,7 +34,7 @@ def removal(csv_file, columnName, finalFileName, deletedFileName, similarityThre .. code-block:: python from sinatools.utils.text_dublication_detector import removal - removal("/path/to/csv/file1", sentences, "/path/to/csv/file2", 0.8) + removal("/path/to/csv/file1", "sentences", "/path/to/final/file", "/path/to/deleted/file", 0.8) """ # Read CSV file @@ -129,4 +129,4 @@ def textToVector(text): # deletedFileName = "Arabic-Oct7-Feb12DeletedSent.csv" # result = removal(csvFile, columnName, finalFileName, deletedFileName, similarityThreshold) -# print(result) \ No newline at end of file +# print(result) diff --git a/sinatools/utils/text_dublication_detector.py b/sinatools/utils/text_dublication_detector.py index 6d16147..4b6efb2 100644 --- a/sinatools/utils/text_dublication_detector.py +++ b/sinatools/utils/text_dublication_detector.py @@ -34,7 +34,7 @@ def removal(csv_file, columnName, finalFileName, deletedFileName, similarityThre .. code-block:: python from sinatools.utils.text_dublication_detector import removal - removal("/path/to/csv/file1", sentences, "/path/to/csv/file2", 0.8) + removal("/path/to/csv/file1", "sentences", "/path/to/final/file", "/path/to/deleted/file", 0.8) """ # Read CSV file @@ -129,4 +129,4 @@ def textToVector(text): # deletedFileName = "Arabic-Oct7-Feb12DeletedSent.csv" # result = removal(csvFile, columnName, finalFileName, deletedFileName, similarityThreshold) -# print(result) \ No newline at end of file +# print(result)