SinaTools 0.1.27__py2.py3-none-any.whl → 0.1.28__py2.py3-none-any.whl

{SinaTools-0.1.27.dist-info → SinaTools-0.1.28.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: SinaTools
-Version: 0.1.27
+Version: 0.1.28
 Summary: Open-source Python toolkit for Arabic Natural Understanding, allowing people to integrate it in their system workflow.
 Home-page: https://github.com/SinaLab/sinatools
 License: MIT license
@@ -24,7 +24,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), (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 similarly, parser, tokenizers, corpora processing, transliteration, etc).
 
 See [Demo Pages](https://sina.birzeit.edu/sinatools/).
 

{SinaTools-0.1.27.dist-info → SinaTools-0.1.28.dist-info}/RECORD

@@ -1,18 +1,18 @@
-SinaTools-0.1.27.data/data/sinatools/environment.yml,sha256=OzilhLjZbo_3nU93EQNUFX-6G5O3newiSWrwxvMH2Os,7231
-sinatools/VERSION,sha256=W9ZpgLhiag6deRMB5DzdHO6EDLvNbZPVIRIUv6nHT3U,6
+SinaTools-0.1.28.data/data/sinatools/environment.yml,sha256=OzilhLjZbo_3nU93EQNUFX-6G5O3newiSWrwxvMH2Os,7231
+sinatools/VERSION,sha256=NhKxpb_MVtfi01FRu6rOIYrldV__GIvBYcyyn5UnDBM,6
 sinatools/__init__.py,sha256=bEosTU1o-FSpyytS6iVP_82BXHF2yHnzpJxPLYRbeII,135
 sinatools/environment.yml,sha256=OzilhLjZbo_3nU93EQNUFX-6G5O3newiSWrwxvMH2Os,7231
 sinatools/install_env.py,sha256=EODeeE0ZzfM_rz33_JSIruX03Nc4ghyVOM5BHVhsZaQ,404
 sinatools/sinatools.py,sha256=vR5AaF0iel21LvsdcqwheoBz0SIj9K9I_Ub8M8oA98Y,20
-sinatools/CLI/DataDownload/download_files.py,sha256=2jLohYd5Vjtz7gVd8zePhK6A_r0svpoV3ykbO5rwR8s,2613
-sinatools/CLI/morphology/ALMA_multi_word.py,sha256=ZImJ1vtcpSHydI1BjJmK3KcMJbGBZX16kO4L6rxvBvA,2086
-sinatools/CLI/morphology/morph_analyzer.py,sha256=ieIM47QK9Nct3MtCS9uq3h2rZN5r4qNhsLmlVeE6wiE,3503
-sinatools/CLI/ner/corpus_entity_extractor.py,sha256=Da-DHFrqT6if7w6WnodB4TBE5ze3DJYjb2Mmju_Qd7g,4034
-sinatools/CLI/ner/entity_extractor.py,sha256=IiTioe0px0aJ1E58FrDVa2yNgM8Ie4uS2LZKK_z2Qn4,2942
+sinatools/CLI/DataDownload/download_files.py,sha256=TzS0XjYDhusRBb2CRX1EjKjORa0wI6me_XoZ09dY4R8,2397
+sinatools/CLI/morphology/ALMA_multi_word.py,sha256=rmpa72twwIJHme_kpQ1lu3_7y_Jorj70QTvOnQMJRuI,1274
+sinatools/CLI/morphology/morph_analyzer.py,sha256=HPamEKos_JRYCJv_2q6c12N--da58_JXTno9haww5Ao,3497
+sinatools/CLI/ner/corpus_entity_extractor.py,sha256=DdvigsDQzko5nJBjzUXlIDqoBMBTVzktjSo7JfEXTIA,4778
+sinatools/CLI/ner/entity_extractor.py,sha256=G9j-t0WKm2CRORhqARJM-pI-KArQ2IXIvnBK_NHxlHs,2885
 sinatools/CLI/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sinatools/CLI/utils/arStrip.py,sha256=NLyp8vOu2xv80tL9jiKRvyptmbkRZVg-wcAr-9YyvNY,3264
 sinatools/CLI/utils/corpus_tokenizer.py,sha256=nH0T4h6urr_0Qy6-wN3PquOtnwybj0REde5Ts_OE4U8,1650
-sinatools/CLI/utils/implication.py,sha256=nvoiI5UHHaJdd6MICql0pB_-h3L0icYwP1WgJi2h7p0,2854
+sinatools/CLI/utils/implication.py,sha256=AojpkCwUQJiQjxhyEUWKRHmBnIt1tVqr485cAF7Thq0,2857
 sinatools/CLI/utils/jaccard.py,sha256=w56N_cNEFJ0A7WtunmY_xtms4srFagKBzrW_0YhH2DE,4216
 sinatools/CLI/utils/remove_latin.py,sha256=NOaTm2RHxt5IQrV98ySTmD8rTXTmcqSmfbPAwTyaXqU,848
 sinatools/CLI/utils/remove_punctuation.py,sha256=vJAZlEn7WGftZAFVFYnddkRrxdJ_rMmKB9vFZkY-jN4,1097
@@ -75,12 +75,12 @@ sinatools/arabert/aragpt2/grover/train_tpu.py,sha256=qNgLI_j6-KYkTMJfVoFlh4NIKwe
 sinatools/arabert/aragpt2/grover/utils.py,sha256=V5wMUxK03r5g_pb7R3_uGLOPqQJfbIB0VaJ8ZDM4XAo,8473
 sinatools/morphology/ALMA_multi_word.py,sha256=hj_-8ojrYYHnfCGk8WKtJdUR8mauzQdma4WUm-okDps,1346
 sinatools/morphology/__init__.py,sha256=I4wVBh8BhyNl-CySVdiI_nUSn6gj1j-gmLKP300RpE0,1216
-sinatools/morphology/morph_analyzer.py,sha256=tA78gWg6iaE_G1c2xqxZoXZWNbvHBJLrTSxPyir5Xn8,6941
+sinatools/morphology/morph_analyzer.py,sha256=3B-ewxFg_If83oYlk1bDdVS1clb-mgyAF4WgAMqcAVI,7009
 sinatools/ner/__init__.py,sha256=CLPaqUcvPGAA4lU-6hjAqjNfKJ5WtwRfsma6QkYZHEk,1379
 sinatools/ner/data.py,sha256=lvOW86dXse8SC75Q0supQaE0rrRffoxNjIA0Qbv5WZY,4354
 sinatools/ner/data_format.py,sha256=7Yt0aOicOn9_YuuyCkM_IYi_rgjGYxR9bCuUaNGM73o,4341
 sinatools/ner/datasets.py,sha256=mG1iwqSm3lXCFHLqE-b4wNi176cpuzNBz8tKaBU6z6M,5059
-sinatools/ner/entity_extractor.py,sha256=bDInJYLC1z_kze5jtQFgQVLZ76tRzUK_FJxqETfVw70,1885
+sinatools/ner/entity_extractor.py,sha256=O2epRwRFUUcQs3SnFIYHVBI4zVhr8hRcj0XJYeby4ts,3588
 sinatools/ner/helpers.py,sha256=dnOoDY5JMyOLTUWVIZLMt8mBn2IbWlVaqHhQyjs1voo,2343
 sinatools/ner/metrics.py,sha256=Irz6SsIvpOzGIA2lWxrEV86xnTnm0TzKm9SUVT4SXUU,2734
 sinatools/ner/relation_extractor.py,sha256=a85xGX6V72fDpJk0GKmmtlWf8S8ezY-2pm5oGc9_ESY,9750
@@ -97,28 +97,29 @@ sinatools/ner/trainers/BertNestedTrainer.py,sha256=Pb4O2WeBmTvV3hHMT6DXjxrTzgtuh
 sinatools/ner/trainers/BertTrainer.py,sha256=B_uVtUwfv_eFwMMPsKQvZgW_ZNLy6XEsX5ePR0s8d-k,6433
 sinatools/ner/trainers/__init__.py,sha256=UDok8pDDpYOpwRBBKVLKaOgSUlmqqb-zHZI1p0xPxzI,188
 sinatools/semantic_relatedness/__init__.py,sha256=S0xrmqtl72L02N56nbNMudPoebnYQgsaIyyX-587DsU,830
-sinatools/semantic_relatedness/compute_relatedness.py,sha256=JvI0cXgukKtuMpmAygMnlocCsPeAJ98LD1jZCP_6SyQ,1110
+sinatools/semantic_relatedness/compute_relatedness.py,sha256=_9HFPs3nQBLklHFfkc9o3gEjEI6Bd34Ha4E1Kvv1RIg,2256
 sinatools/synonyms/__init__.py,sha256=yMuphNZrm5XLOR2T0weOHcUysJm-JKHUmVLoLQO8390,548
-sinatools/synonyms/synonyms_generator.py,sha256=FgAiuduSFyM6vJobWZKHg4KNWIQz8T6MGBPVIuVuw-8,6506
+sinatools/synonyms/synonyms_generator.py,sha256=jRd0D3_kn-jYBaZzqY-7oOy0SFjSJ-mjM7JhsySzX58,9037
 sinatools/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sinatools/utils/charsets.py,sha256=rs82oZJqRqosZdTKXfFAJfJ5t4PxjMM_oAPsiWSWuwU,2817
 sinatools/utils/implication.py,sha256=MsbI6S1LNY-fCxGMxFTuaV639r3QijkkdcfH48rvY7A,27804
-sinatools/utils/jaccard.py,sha256=S7OgvaMqkN5HFgTZkKhMCNAuAnQ0LhRyXPN79jAzmKM,10113
-sinatools/utils/parser.py,sha256=CPPtCrsbxUqsjhY5C9wTOgkAs6iw0k_WvMUxLEPM1IU,6168
+sinatools/utils/jaccard.py,sha256=kLIptPNB2VIqnemVve9auyOL1kXHIsCkKCEwxFM8yP4,10114
+sinatools/utils/parser.py,sha256=qvHdln5R5CAv_0UOJWe0mcp8JCsGqgazoeIIkoALH88,6259
 sinatools/utils/readfile.py,sha256=xE4LEaCqXJIk9v37QUSSmWb-aY3UnCFUNb7uVdx3cpM,133
-sinatools/utils/similarity.py,sha256=oEdpcn3hm8v3qvNvr1USQ7eQlK0zU-7a7W090rCIFyw,5688
-sinatools/utils/text_dublication_detector.py,sha256=6yAOUtdw4TKiJkUPDDi3oK7CEoIuBDbliJ4PU7kapfo,4249
-sinatools/utils/text_transliteration.py,sha256=NQoXrxI-h0UXnvVtDA3skNJduxIy0IW26r46N4tDxGk,8766
-sinatools/utils/tokenizer.py,sha256=QHyrVqJA_On4rKxexiWR2ovq4pI1-u6iZkdhRbK9tew,6676
+sinatools/utils/similarity.py,sha256=CgKOJpRAU5UaSjOg-sdZcACCNl9tuKDRwdFAKATCL_w,10762
+sinatools/utils/text_dublication_detector.py,sha256=FeSkbfWGMQluz23H4CBHXION-walZPgjueX6AL8u_Q0,5660
+sinatools/utils/text_transliteration.py,sha256=F3smhr2AEJtySE6wGQsiXXOslTvSDzLivTYu0btgc10,8769
+sinatools/utils/tokenizer.py,sha256=nyk6lh5-p38wrU62hvh4wg7ni9ammkdqqIgcjbbBxxo,6965
 sinatools/utils/tokenizers_words.py,sha256=efNfOil9qDNVJ9yynk_8sqf65PsL-xtsHG7y2SZCkjQ,656
+sinatools/utils/word_compare.py,sha256=rS2Z74sf7R-7MTXyrFj5miRi2TnSG9OdTDp_qQYuo2Y,28200
 sinatools/wsd/__init__.py,sha256=mwmCUurOV42rsNRpIUP3luG0oEzeTfEx3oeDl93Oif8,306
-sinatools/wsd/disambiguator.py,sha256=43Iq7NTZsiYWGFg-NUDrQuJKO1NT9QOnfBPB10IOJNs,19828
+sinatools/wsd/disambiguator.py,sha256=h-3idc5rPPbMDSE_QVJAsEVkDHwzYY3L2SEPNXIdOcc,20104
 sinatools/wsd/settings.py,sha256=6XflVTFKD8SVySX9Wj7zYQtV26WDTcQ2-uW8-gDNHKE,747
 sinatools/wsd/wsd.py,sha256=gHIBUFXegoY1z3rRnIlK6TduhYq2BTa_dHakOjOlT4k,4434
-SinaTools-0.1.27.dist-info/AUTHORS.rst,sha256=aTWeWlIdfLi56iLJfIUAwIrmqDcgxXKLji75_Fjzjyg,174
-SinaTools-0.1.27.dist-info/LICENSE,sha256=uwsKYG4TayHXNANWdpfMN2lVW4dimxQjA_7vuCVhD70,1088
-SinaTools-0.1.27.dist-info/METADATA,sha256=jcBDhXCwjYOsgNkcEjQLG7l_kdWSHkEUpSsoMt7uI1c,3264
-SinaTools-0.1.27.dist-info/WHEEL,sha256=6T3TYZE4YFi2HTS1BeZHNXAi8N52OZT4O-dJ6-ome_4,116
-SinaTools-0.1.27.dist-info/entry_points.txt,sha256=ZwZLolnWog2fjdDrfaHNHob8SE_YtMbD6ayzsOzItxs,1234
-SinaTools-0.1.27.dist-info/top_level.txt,sha256=8tNdPTeJKw3TQCaua8IJIx6N6WpgZZmVekf1OdBNJpE,10
-SinaTools-0.1.27.dist-info/RECORD,,
+SinaTools-0.1.28.dist-info/AUTHORS.rst,sha256=aTWeWlIdfLi56iLJfIUAwIrmqDcgxXKLji75_Fjzjyg,174
+SinaTools-0.1.28.dist-info/LICENSE,sha256=uwsKYG4TayHXNANWdpfMN2lVW4dimxQjA_7vuCVhD70,1088
+SinaTools-0.1.28.dist-info/METADATA,sha256=oJ0szwQ8a_ykAsYn2uqU-pmhF4N4Sh0oIsv1JCYeX78,3267
+SinaTools-0.1.28.dist-info/WHEEL,sha256=6T3TYZE4YFi2HTS1BeZHNXAi8N52OZT4O-dJ6-ome_4,116
+SinaTools-0.1.28.dist-info/entry_points.txt,sha256=ZwZLolnWog2fjdDrfaHNHob8SE_YtMbD6ayzsOzItxs,1234
+SinaTools-0.1.28.dist-info/top_level.txt,sha256=8tNdPTeJKw3TQCaua8IJIx6N6WpgZZmVekf1OdBNJpE,10
+SinaTools-0.1.28.dist-info/RECORD,,

sinatools/CLI/DataDownload/download_files.py

@@ -2,7 +2,7 @@
 About:
 ------
 
-The download_files is a command-line interface for downloading various NLP resources from pre-specified URLs. It is a part of the sinatools package and provides options to choose which files to download and to specify a download directory. The tool automatically handles file extraction for zip and tar.gz files.
+The download_files command, allows users to select specific files and models to download and use it within SinaTools modules. Additionally, it automatically manages the extraction of compressed files, including zip and tar.gz formats.
 
 Usage:
 ------
@@ -18,7 +18,7 @@ Below is the usage information that can be generated by running download_files -
 
         Options:
         -f, --files FILES
-            Names of the files to download. Available files are: ner, morph, wsd_model, wsd_tokenizer, glosses_dic, five_grams, four_grams, three_grams, two_grams, synonyms_level2, synonyms_level3. 
+            Names of the files to download. Available files are: ner, morph, wsd, synonyms. 
             If no file is specified, all files will be downloaded.
 
 Examples:
@@ -28,7 +28,6 @@ Examples:
 
     download_files -f morph ner 
     This command will download only the `morph` and `ner` files to the default directory.
-
 """
 
 import argparse
@@ -72,5 +71,3 @@ def main():
 
 if __name__ == '__main__':
     main()
-
-#download_files -f morph ner

sinatools/CLI/morphology/ALMA_multi_word.py

@@ -1,37 +1,3 @@
-"""
-About:
-------
-The alma_multi_word tool performs multi-word morphological analysis using SinaTools' `ALMA_multi_word` utility. Given a multi-word Arabic text input, it returns a detailed analysis in JSON format.
-
-Usage:
-------
-Below is the usage information that can be generated by running alma_multi_word --help.
-
-.. code-block:: none
-
-    alma_multi_word --multi_word=MULTI_WORD_TEXT
-    alma_multi_word --file
-
-Options:
---------
-
-.. code-block:: none
-
-  --multi_word MULTI_WORD_TEXT
-        The multi-word Arabic text that needs to be analyzed.
-  --file
-        File containing the multi-word text to be analyzed
-
-Examples:
----------
-
-.. code-block:: none
-
-  alma_multi_word --multi_word "Your multi-word text here"
-  alma_multi_word --file "path/to/your/file.txt"
-
-"""
-
 import argparse
 from sinatools.morphology.ALMA_multi_word import ALMA_multi_word
 import json

sinatools/CLI/morphology/morph_analyzer.py

@@ -1,7 +1,7 @@
 """
 About:
 ------
-The morphology_analyzer command is designed to provide morphological analysis for Arabic text using the SinaTools morph_analyzer component. Users can specify the language and desired analysis task (lemmatization, part-of-speech tagging, or full morphological analysis), and flag.
+The morphology_analyzer command is designed to provide morphological analysis for Arabic text using the SinaTools morph_analyzer API. Users can specify the language and desired analysis task (lemmatization, part-of-speech tagging, or full morphological analysis), and flag.
 
 Usage:
 ------

sinatools/CLI/ner/corpus_entity_extractor.py

@@ -7,13 +7,26 @@ import argparse
 from sinatools.ner.entity_extractor import extract
 
 """
-This tool processes a csv file and returns named entites for each token within the text, based on the specified batch size. As follows:
+The following command takes a CSV file as input. It splits a specific column into tokens and tags them using named entity recognition (NER). It retains all other columns as they are, and it also adds sentences and tokens. Additionally, it assigns an auto-incrementing ID, a sentence ID, and a global sentence ID to each token. As follows:
 
 Usage:
 ------
-Run the script with the following command:
-
-corpus_entity_extractor  input.csv --text-columns "TextColumn1,TextColumn2" --additional-columns "Column3,Column4" --output-csv output.csv
+Below is the usage information that can be generated by running corpus_entity_extractor --help.
+
+corpus_entity_extractor --input_csv path/to/csv/file --text-columns "name of the column to be tokenized" --additional-columns "Column3,Column4" --output-csv path/to/csv/file
+
+Options:
+-------
+    --input_csv CSV_FILE_PATH
+          Path of csv file 
+    --text-columns STR
+          Name of the text column that need to be tagged
+    -- additional-columns      
+          name of columns that returned as they are
+    -- output-csv
+          path to csv file 
+
+corpus_entity_extractor  --input_csv "input.csv" --text-columns "TextColumn1" --additional-columns "Column3,Column4" --output-csv "output.csv"          
 """
 
 def jsons_to_list_of_lists(json_list):

sinatools/CLI/ner/entity_extractor.py

@@ -1,7 +1,7 @@
 """
 About:
 ------
-This tool processes an input text and returns named entites for each token within the text, based on the specified batch size. As follows:
+This command processes an input text and returns named entites for each token within the text. As follows:
 
 Usage:
 ------
@@ -10,7 +10,7 @@ Below is the usage information that can be generated by running entity_extractor
 .. code-block:: none
 
     entity_extractor --text=INPUT_TEXT
-    entity_extractor --dir=INPUT_FILE --output_csv=OUTPUT_FILE_NAME
+    entity_extractor --dir=DIRECTORY_PATH --output_csv "path/to/csv/file"
 
 Options:
 --------
@@ -18,11 +18,11 @@ Options:
 .. code-block:: none
 
   --text INPUT_TEXT
-        The text that needs to be analyzed for Named Entity Recognition.
-  --file INPUT_FILE
-        File containing the text to be analyzed for Named Entity Recognition.
-  --output_csv OUTPUT_FILE_NAME
-        A file containing the tokenized text and its Named Entity tags.
+      The text that needs to be analyzed for Named Entity Recognition.
+  --dir DIRECTORY_PATH
+        Directory containing the text files to be analyzed for Named Entity Recognition
+  --output_csv CSV_FILE
+        The path for output csv file 
 
 
 Examples:
@@ -31,7 +31,7 @@ Examples:
 .. code-block:: none
 
     entity_extractor --text "Your text here"
-    entity_extractor --dir "/path/to/your/directory" --output_csv "output.csv"
+    entity_extractor --dir "path/to/your/dir" --output_csv "path/to/your/file"
 
 """
 

sinatools/CLI/utils/implication.py

@@ -39,7 +39,7 @@ Examples:
 
 """
 import argparse
-from sinatools.utils.implication import Implication
+from sinatools.utils.word_compare import Implication
 
 def read_file(file_path):
     with open(file_path, 'r', encoding='utf-8') as file:
@@ -72,8 +72,8 @@ def main():
     # Instantiate the Implication class
     implication_obj = Implication(word1, word2)
     
-    # For this example, assuming there is a method `get_result()` in the Implication class.
-    result = implication_obj.get_result()
+    # For this example, assuming there is a method `get_verdict()` in the Implication class.
+    result = implication_obj.get_verdict()
     print(result)
 
 if __name__ == '__main__':

sinatools/VERSION

@@ -1 +1 @@
-0.1.27
+0.1.28

sinatools/morphology/morph_analyzer.py

@@ -24,27 +24,27 @@ def find_solution(token, language, flag):
 
 def analyze(text, language ='MSA', task ='full', flag="1"):
    """
-    This method processes an input text and returns morphological analysis for each token within the text, based on the specified language, task, and flag. As follows:
-    If:
-        The task is lemmatization, the morphological solution includes only the lemma_id, lemma, token, and token frequency.
-        The task is pos, the morphological solution includes only the part-of-speech, token, and token frequency.
-        The task is root, the morphological solution includes only the root, token, and token frequency.
-        The task is full, the morphological solution includes the lemma_id, lemma, part-of-speech, root, token, and token frequency.
+    This method processes an input text and returns morphological analysis for each token within the text, based on the specified language, task, and flag. You can try the demo online. See article for more details
+    
+        * If the task is lemmatization, the morphological solution includes only the lemma_id, lemma, token, and token frequency.
+        * If the task is pos, the morphological solution includes only the part-of-speech, token, and token frequency.
+        * If the task is root, the morphological solution includes only the root, token, and token frequency.
+        * If the task is full, the morphological solution includes the lemma_id, lemma, part-of-speech, root, token, and token frequency.    
      
-    Args:
+    Parameters:
         text (:obj:`str`): The Arabic text to be morphologically analyzed.
-        language (:obj:`str`): The type of the input text. Currently, only Modern Standard Arabic (MSA) is supported.
+        language (:obj:`str`): Currently, only Modern Standard Arabic (MSA) is supported.
         task (:obj:`str`): The task to filter the results by. Options are [lemmatization, pos, root, full]. The default task if not specified is `full`.
-        flag (:obj:`str`): The flag to filter the returned results. If the flag is `1`, the solution with the highest frequency will be returned. If the flag is `*`, all solutions will be returned, ordered descendingly, with the highest frequency solution first. The default flag if not specified is `1`.
+        flag (:obj:`str`):  The flag to filter the returned results. If the flag is `1`, the solution with the highest frequency will be returned. If the flag is `*`, all solutions will be returned, ordered descendingly, with the highest frequency solution first. The default flag if not specified is `1`.
          
     Returns:
         list (:obj:`list`): A list of JSON objects, where each JSON could be contains:
             token: The token from the original text.
-            lemma: The lemma of the token.
-            lemma_id: The id of the lemma.
-            pos: The part-of-speech of the token.
-            root: The root of the token.
-            frequency: The frequency of the token.
+            lemma: The lemma of the token (Lemmas from the Qabas lexicon).
+            lemma_id: The id of the lemma (qabas lemma ids).
+            pos: The part-of-speech of the token (see Qabas POS tags).
+            root: The root of the token (qabas roots).
+            frequency: The frequency of the token (see section 3 in article).        
 
     **Example:**
 
@@ -57,37 +57,36 @@ def analyze(text, language ='MSA', task ='full', flag="1"):
         #Example: task = full 
         analyze('ذهب الولد الى المدرسة')
 
-        [
-            { 
-              "token": "ذهب",
-              "lemma": "ذَهَبَ",
-              "lemma_id": "202001617",
-              "root": "ذ ه ب",
-              "pos": "فعل ماضي",
-              "frequency": "82202"
-            },{ 
-               "token": "الولد",
-               "lemma": "وَلَدٌ",
-               "lemma_id": "202003092",
-               "root": "و ل د",
-               "pos": "اسم",
-               "frequency": "19066"
-            },{ 
-               "token": "إلى",
-               "lemma": "إِلَى",
-               "lemma_id": "202000856",
-               "root": "إ ل ى",
-               "pos": "حرف جر",
-               "frequency": "7367507"
-            },{ 
-               "token": "المدرسة",
-               "lemma": "مَدْرَسَةٌ",
-               "lemma_id": "202002620",
-               "root": "د ر س",
-               "pos": "اسم",
-               "frequency": "145285"
-            }
-        ]
+        [{ 
+            "token": "ذهب",
+            "lemma": "ذَهَبَ",
+            "lemma_id": "202001617",
+            "root": "ذ ه ب",
+            "pos": "فعل ماضي",
+            "frequency": "82202"
+          },{ 
+            "token": "الولد",
+            "lemma": "وَلَدٌ",
+            "lemma_id": "202003092",
+            "root": "و ل د",
+            "pos": "اسم",
+            "frequency": "19066"
+          },{ 
+            "token": "إلى",
+            "lemma": "إِلَى",
+            "lemma_id": "202000856",
+            "root": "إ ل ى",
+            "pos": "حرف جر",
+            "frequency": "7367507"
+          },{ 
+            "token": "المدرسة",
+            "lemma": "مَدْرَسَةٌ",
+            "lemma_id": "202002620",
+            "root": "د ر س",
+            "pos": "اسم",
+            "frequency": "145285"
+        }]
+
    """
 
    output_list = []

sinatools/ner/entity_extractor.py

@@ -28,7 +28,48 @@ def convert_nested_to_flat(nested_tags):
     return flat_tags
 
 def extract(text, ner_method="nested"):
+    """
+    This method processes an input text and returns named entites for each token within the text. It support 21 class of entites. The method also support flat and nested NER. You can try the demo online. See article for details.
     
+    Args:
+        * text (:obj:`str`) – The Arabic text to be tagged.
+        * ner_method (:obj:`str`) – The NER method can produce either flat or nested output formats. The default method is nested.
+            nested method: If the method is nested, the output will include nested tags.
+            flat method: If the method is flat, the output will consist of only flat tags.
+        The choice between flat and nested methods determines the structure and detail of the named entity recognition output.    
+    
+    Returns:
+        A list of JSON objects, where each object could be contains:
+            token: The token from the original text.
+            NER tag: The label pairs for each segment.
+    
+    **Example:**
+    
+    .. highlight:: python
+    .. code-block:: python
+    
+        from sinatools.ner.entity_extractor import extract
+        #Example of nested ner. Notice that the last word in this sentense contains nested tags.
+        extract('ذهب محمد الى جامعة بيرزيت')
+        #the output
+        [{
+            "token":"ذهب",
+            "tags":"O"
+          },{
+            "token":"محمد",
+            "tags":"B-PERS"
+          },{
+            "token":"إلى",
+            "tags":"O"
+          },{
+            "token":"جامعة",
+            "tags":"B-ORG"
+          },{
+            "token":"بيرزيت",
+            "tags":"B-GPE I-ORG"
+        }]    
+    """
+
     dataset, token_vocab = text2segments(text)
 
     vocabs = namedtuple("Vocab", ["tags", "tokens"])

sinatools/semantic_relatedness/compute_relatedness.py

@@ -4,6 +4,28 @@ from . import model
 
 #cosine using average embedding 
 def get_similarity_score(sentence1, sentence2):
+  """
+    Computes the degree of association between two sentences across various dimensions, meaning, underlying concepts, domain-specificity, topic overlap, viewpoint alignment. This method is described and implemented on this article.
+
+    Args:
+        sentence1 (:obj:`str`) – The Arabic sentence to find the semantic relatedness between it and the second sentence.
+        sentence2 (:obj:`int`) – The Arabic sentence to find the semantic relatedness between it and the first sentence.
+    
+    Returns:
+        :obj:`float`: An float number that represents the degree of relatedness between two provided sentences.
+
+    **Example:**
+
+    .. highlight:: python
+    .. code-block:: python
+
+    from sinatools.semantic_relatedness.compute_relatedness import get_similarity_score
+
+    sentence1 = "تبلغ سرعة دوران الأرض حول الشمس حوالي 110 كيلومتر في الساعة."
+    sentence2 = "تدور الأرض حول محورها بسرعة تصل تقريبا 1670 كيلومتر في الساعة."    
+    get_similarity_score(sentence1, sentence2)
+    Score = 0.90
+  """         
 
   # Tokenize and encode sentences
   inputs1 = tokenizer(sentence1, return_tensors="pt")

sinatools/synonyms/synonyms_generator.py

@@ -76,7 +76,28 @@ def find_fuzzy_value_for_candidates(level, list_of_unique_synonyms, number_of_cy
 
 
 def extend_synonyms(synset, level):
-   
+    """
+    This method receives a set of one or more synonyms and a level number, then extends this set with additional synonyms. The more synonyms in the input, the more accurate in the results. Each synonym in the output is assigned a fuzzy value to indicate how much it is likely to be a synonymy. You can try the demo online. Read the article for more details.
+
+    Args:
+        synset (:obj:`str`) – A set of initial synonyms to be extended (string of synonyms seperated by |).
+        level (:obj:`int`) – The level number indicates the depth of the synonym graph that the method should explore. The level could be 2 or 3. The 3rd level is richer, but the 2nd is faster.
+    
+    Returns:
+        :obj:`list`: A list of lists, where each list could be contains:
+            synonym: Synonym related to the given synset (set of synonyms).
+            fuzzy_value: The synonyms strength as a percentage out of 100.
+
+    **Example:**
+
+    .. highlight:: python
+    .. code-block:: python
+
+        from sinatools.synonyms.synonyms_generator import extend_synonyms
+        extend_synonyms('ممر | طريق', 2)
+        [["مَسْلَك","61%"],["سبيل","61%"],["وَجْه","30%"],["نَهْج", "30%"],["نَمَطٌ","30%"],["مِنْهَج","30%"],["مِنهاج", "30%"],["مَوْر","30%"],["مَسَار","30%"],["مَرصَد", "30%"],["مَذْهَبٌ","30%"],["مَدْرَج","30%"],["مَجَاز","30%"]]
+
+    """         
     used_graph = {}
     if level == 2:
        used_graph = synonyms_level2_dict
@@ -119,6 +140,29 @@ def extend_synonyms(synset, level):
 
 def evaluate_synonyms(synset, level):
 
+   """
+    This method receives a set of synonyms and a level number, then evaluates how much each of these input synonyms is really a synonym (i.e., how much it belongs to the set). You can try the demo online.
+
+    Args:
+        synset (:obj:`str`) – A set of initial synonyms to be evaluated (string of synonyms seperated by |).
+        level (:obj:`int`) – The level number indicating the depth of synonym graph that the method will explore, which could be 2 or 3.
+    
+    Returns:
+        :obj:`list`: A list of lists, where each list could be contains:
+            synonym: Synonym related to the given synset (set of synonyms).
+            fuzzy_value: The synonyms strength as a percentage out of 100.
+
+    **Example:**
+
+    .. highlight:: python
+    .. code-block:: python
+
+    from sinatools.synonyms.synonyms_generator import evaluate_synonyms
+    
+    evaluate_synonyms('ممر | طريق | مَسْلَك | سبيل') 
+    [["مَسْلَك","61%"],["سبيل","60%"],["طريق","40%"],["ممر", "40%"]]
+   """         
+
    used_graph = {}
    if level == 2:
       used_graph = synonyms_level2_dict

sinatools/utils/jaccard.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 from sinatools.utils.parser import arStrip
-from sinatools.utils.implication import Implication
+from sinatools.utils.word_compare import Implication
 import argparse
 
 def normalize_word(word: str, ignore_all_diacritics_but_not_shadda: bool=True, ignore_shadda_diacritic: bool=True) -> str:

sinatools/utils/parser.py

@@ -4,16 +4,16 @@ import argparse
 def arStrip(text , diacs=True , small_diacs=True , shaddah=True , digit=True, alif=True , special_chars=True ):
     
     """
-    This method removes Arabic diacritics, small diacritcs, shaddah, Latin and Arabic digits, unify alif, remove special characters, extra spaces, underscore and Arabic tatwelah from the input text.
+    This method allows one to optionally remove (Arabic diacritics, small diacritics, shaddah, Latin and Arabic digits, unify alif, remove special characters, extra spaces, underscore and Arabic tatwelah) from the input text.
 
     Args:
         text (:obj:`str`): Arabic text to be processed.
-        diacs (:obj:`bool`): flag to remove Arabic diacretics [ ًٌٍَُِْ] (default is True).
-        small_diacs (:obj:`bool`): flag to remove small diacretics (default is True).
+        diacs (:obj:`bool`): flag to remove these 7 Arabic diacretics [ ٍ ِ ْ ٌ ُ َ ً] (default is True).
+        small_diacs (:obj:`bool`): flag to remove all Quranic annotation signs from this range [06D6-06ED] in addition to small alif. (default is True).
         shaddah (:obj:`bool`): flag to remove shaddah (default is True).
         digit (:obj:`bool`): flag to remove Latin and Arabic digits (default is True).
-        alif (:obj:`bool`): flag to unify alif (default is True).
-        special_chars (:obj:`bool`): flag to remove special characters (default is True).
+        alif (:obj:`bool`): flag to unify alif. Replace [ٱ أ إ آ] into [ا] (default is True).
+        special_chars (:obj:`bool`): flag to remove these special characters [?؟!@#$%] (default is True).
 
     Returns:
         :obj:`str`: stripped text.
@@ -30,10 +30,10 @@ def arStrip(text , diacs=True , small_diacs=True , shaddah=True , digit=True, al
         # output
         الجو جميل
 
-        output = parser.arStrip('أَلَمۡ یَأۡنِ لِلَّذِینَ ءَامَنُوۤا۟ أَن تَخۡشَعَ قُلُوبُهُمۡ لِذِكۡرِ ٱللَّهِ وَمَا نَزَلَ مِنَ ٱلۡحَقِّ وَلَا یَكُونُوا۟ كَٱلَّذِینَ أُوتُوا۟ ٱلۡكِتَـٰبَ مِن قَبۡلُ فَطَالَ عَلَیۡهِمُ ٱلۡأَمَدُ فَقَسَتۡ قُلُوبُهُمۡۖ وَكَثِیر مِّنۡهُمۡ فَـسِقُونَ' , True , True , True ,  True , True , True )
+        output =parser.arStrip('أَلَمۡ یَأۡنِ لِلَّذِینَ ءَامَنُوۤا۟ أَن تَخۡشَعَ قُلُوبُهُمۡ لِذِكۡرِ ٱللَّهِ وَمَا نَزَلَ مِنَ ٱلۡحَقِّ وَلَا یَكُونُوا۟ كَٱلَّذِینَ أُوتُوا۟ ٱلۡكِتَـٰبَ مِن قَبۡلُ فَطَالَ عَلَیۡهِمُ ٱلۡأَمَدُ فَقَسَتۡ قُلُوبُهُمۡۖ وَكَثِیر مِّنۡهُمۡ فَـسِقُونَ', True, True, True, True, False, False )
         print(output)
         #output
-        الم یان للذین ءامنوا ان تخشع قلوبهم لذكر الله وما نزل من الحق ولا یكونوا كالذین اوتوا الكتٰب من قبل فطال علیهم الامد فقست قلوبهم وكثیر منهم فسقون
+        ألم یأن للذین ءامنوا أن تخشع قلوبهم لذكر ٱلله وما نزل من ٱلحق ولا یكونوا كٱلذین أوتوا ٱلكتب من قبل فطال علیهم ٱلأمد فقست قلوبهم وكثیر منهم فسقون
     """
     try:
         if text: # if the input string is not empty do the following
@@ -67,13 +67,13 @@ def arStrip(text , diacs=True , small_diacs=True , shaddah=True , digit=True, al
     
 def remove_punctuation(text):
     """
-    Removes punctuation marks from the text.
+    Removes these arabic and english punctuation marks from the text [! " # $ % & ' ( ) * + , - . / : ; > = < ? @ [ \ ] ^ _ ` { | } ~ ، ؛ ؞ ؟ ـ ٓ ٬ ٪ ٫ ٭ ۔].
     
     Args:
       text (:obj:`str`): The input text.
     
     Returns:
-      :obj:`str`: The output text without punctuation marks.
+       :obj:`str`
 
     **Example:**
 
@@ -109,15 +109,12 @@ def remove_punctuation(text):
 
 def remove_latin(text):
     """
-    This method removes all Latin characters from the input text.
+    This method removes all Latin letters from the input text.
 
-    Args:
+    Parameters:
         text (:obj:`str`): The input text.
-
     Returns:
-         outputString (:obj:`str`): The text without Latin characters.
-    Note:
-        If an error occurs during processing, the original text is returned.
+        :obj:`str`
     **Example:**
 
     .. highlight:: python