Update docs

Author: wannaphong

docs/api/tokenize.rst

@@ -27,28 +27,17 @@ crfcut
 ------
 .. automodule::  pythainlp.tokenize.crfcut
 
-.. autofunction::  pythainlp.tokenize.crfcut.extract_features
-.. autofunction::  pythainlp.tokenize.crfcut.segment
-
 thaisumcut
 ----------
 .. automodule::  pythainlp.tokenize.thaisumcut
 
-.. autofunction::  pythainlp.tokenize.thaisumcut.list_to_string
-.. autofunction::  pythainlp.tokenize.thaisumcut.middle_cut
-.. autoclass:: pythainlp.tokenize.thaisumcut.ThaiSentenceSegmentor
-   :members:
-
 Word level
 ----------
 
 attacut
 +++++++
 .. automodule::  pythainlp.tokenize.attacut
 
-.. autoclass:: pythainlp.tokenize.attacut.AttacutTokenizer
-   :members:
-
 deepcut
 +++++++
 .. automodule::  pythainlp.tokenize.deepcut
@@ -57,22 +46,14 @@ multi_cut
 +++++++++
 .. automodule::  pythainlp.tokenize.multi_cut
 
-.. autofunction:: pythainlp.tokenize.multi_cut.segment
-.. autofunction:: pythainlp.tokenize.multi_cut.find_all_segment
-
 nlpo3
 +++++
 .. automodule::  pythainlp.tokenize.nlpo3
 
-.. autofunction:: pythainlp.tokenize.nlpo3.load_dict
-.. autofunction:: pythainlp.tokenize.nlpo3.segment
-
 longest
 +++++++
 .. automodule::  pythainlp.tokenize.longest
 
-.. autofunction:: pythainlp.tokenize.longest.segment
-
 pyicu
 +++++
 .. automodule::  pythainlp.tokenize.pyicu
@@ -81,8 +62,6 @@ nercut
 ++++++
 .. automodule::  pythainlp.tokenize.nercut
 
-.. autofunction:: pythainlp.tokenize.nercut.segment
-
 sefr_cut
 ++++++++
 .. automodule::  pythainlp.tokenize.sefr_cut
@@ -98,7 +77,6 @@ The default word tokenization engine.
 
 .. automodule::  pythainlp.tokenize.newmm
 
-.. autofunction:: pythainlp.tokenize.newmm.segment
 
 Subword level
 -------------
@@ -107,20 +85,10 @@ tcc
 +++
 .. automodule:: pythainlp.tokenize.tcc
 
-.. autofunction:: pythainlp.tokenize.tcc.segment
-.. autofunction:: pythainlp.tokenize.tcc.tcc
-.. autofunction:: pythainlp.tokenize.tcc.tcc_pos
-
 tcc+
 +++
 .. automodule:: pythainlp.tokenize.tcc_p
 
-.. autofunction:: pythainlp.tokenize.tcc_p.segment
-.. autofunction:: pythainlp.tokenize.tcc_p.tcc
-.. autofunction:: pythainlp.tokenize.tcc_p.tcc_pos
-
 etcc
 ++++
 .. automodule:: pythainlp.tokenize.etcc
-
-.. autofunction:: pythainlp.tokenize.etcc.segment

pythainlp/cls/param_free.py

@@ -48,7 +48,7 @@ def predict(self, x1: str, k: int = 1) -> str:
         ::
 
                 from pythainlp.cls import GzipModel
-                
+
                 training_data =  [
                     ("รายละเอียดตามนี้เลยค่าา ^^", "Neutral"),
                     ("กลัวพวกมึงหาย อดกินบาบิก้อน", "Neutral"),

pythainlp/khavee/core.py

@@ -418,6 +418,7 @@ def check_klon(self, text: str,k_type: int=8) -> Union[List[str], str]:
     def check_aek_too(self, text: Union[List[str], str], dead_syllable_as_aek:bool = False) -> Union[List[bool], List[str], bool, str]:
         """
         Thai tonal word checker
+
         :param Union[List[str], str] text: Thai word or list of Thai words
         :param bool dead_syllable_as_aek: if True, dead syllable will be considered as aek
         :return: the check if the word is aek or too or False(not both) or list of the check if input is list

pythainlp/tokenize/core.py

@@ -44,7 +44,8 @@ def clause_tokenize(doc: List[str]) -> List[List[str]]:
     :return: list of claues
     :rtype: list[list[str]]
     :Example:
-    Clause tokenizer::
+    ::
+
         from pythainlp.tokenize import clause_tokenize
         clause_tokenize(["ฉัน","นอน","และ","คุณ","เล่น","มือถือ","ส่วน","น้อง","เขียน","โปรแกรม"])
         # [['ฉัน', 'นอน'],
@@ -68,6 +69,12 @@ def word_detokenize(
     :param str output: the output type (str or list)
     :return: the thai text
     :rtype: Union[str,List[str]]
+    :Example:
+    ::
+
+        from pythainlp.tokenize import word_detokenize
+        print(word_detokenize(["เรา", "เล่น"]))
+        # output: เราเล่น
     """
     _list_all = []
     if isinstance(segments[0], str):

pythainlp/tokenize/etcc.py

@@ -68,7 +68,7 @@ def segment(text: str) -> List[str]:
 
     :param str text: text to be tokenized to character clusters
     :return: list of clusters, tokenized from the text
-    :return: list[str]
+    :return: List[str]
     """
 
     if not text or not isinstance(text, str):

pythainlp/translate/core.py

@@ -17,27 +17,6 @@
 class Translate:
     """
     Machine Translation
-
-    :param str src_lang: source language
-    :param str target_lang: target language
-    :param bool use_gpu: load model to gpu (Default is False)
-
-    **Options for source & target language**
-        * *th* - *en* - Thai to English
-        * *en* - *th* - English to Thai
-        * *th* - *zh* - Thai to Chinese
-        * *zh* - *th* - Chinese to Thai
-        * *th* - *fr* - Thai to French
-
-    :Example:
-
-    Translate text from Thai to English::
-
-        from pythainlp.translate import Translate
-        th2en = Translate('th', 'en')
-
-        th2en.translate("ฉันรักแมว")
-        # output: I love cat.
     """
 
     def __init__(

pythainlp/transliterate/wunsen.py

@@ -87,6 +87,7 @@ def transliterate(
 
         :Example:
         ::
+
             from pythainlp.transliterate.wunsen import WunsenTransliterate
 
             wt = WunsenTransliterate()