labeltype doc changes

VowpalWabbit · Mar 17, 2020 · 98e3989 · 98e3989
1 parent 34777f2
commit 98e3989
Showing 1 changed file with 20 additions and 7 deletions.
diff --git a/python/vowpalwabbit/pyvw.py b/python/vowpalwabbit/pyvw.py
@@ -89,15 +89,15 @@ def example(self, initStringOrDict=None, labelType=pylibvw.vw.lDefault):
         initStringOrDict : str/dict
             Example in either string or dictionary form
         labelType : integer
-            labelType of the example, by default is 0(lDefault). The integer is
-            used to map the labels. Following are the available options:
             - 0 : lDEFAULT
             - 1 : lBINARY
             - 2 : lMULTICLASS
             - 3 : lCOST_SENSITIVE
             - 4 : lCONTEXTUAL_BANDIT
             - 5 : lMAX
             - 6 : lCONDITIONAL_CONTEXTUAL_BANDIT
+            The integer is used to map the corresponding labelType using the
+            above available options
 
         Returns
         -------
@@ -250,15 +250,15 @@ def parse(self, str_ex, labelType=pylibvw.vw.lDefault):
             line is considered as an example. In case of list, each string
             element is considered as an example
         labelType : integer
-            labelType of the example, by default is 0(lDefault). The integer is
-            used to map the labels. Following are the available options:
             - 0 : lDEFAULT
             - 1 : lBINARY
             - 2 : lMULTICLASS
             - 3 : lCOST_SENSITIVE
             - 4 : lCONTEXTUAL_BANDIT
             - 5 : lMAX
             - 6 : lCONDITIONAL_CONTEXTUAL_BANDIT
+            The integer is used to map the corresponding labelType using the
+            above available options
 
         Examples
         --------
@@ -457,15 +457,15 @@ def example(self, stringOrDict=None, labelType=pylibvw.vw.lDefault):
         initStringOrDict : str/dict
             Example in either string or dictionary form
         labelType : integer
-            labelType of the example, by default is 0(lDefault). The integer is
-            used to map the labels. Following are the available options:
             - 0 : lDEFAULT
             - 1 : lBINARY
             - 2 : lMULTICLASS
             - 3 : lCOST_SENSITIVE
             - 4 : lCONTEXTUAL_BANDIT
             - 5 : lMAX
             - 6 : lCONDITIONAL_CONTEXTUAL_BANDIT
+            The integer is used to map the corresponding labelType using the
+            above available options
 
         Returns
         -------
@@ -931,13 +931,26 @@ def __init__(self,
             we (repeatedly) execute it fn() until it's not a function
             any more(for lazy feature computation). By default is None
         labelType : integer
-            The labelType of example, by default is 0(lDefault)
+            - 0 : lDEFAULT
+            - 1 : lBINARY
+            - 2 : lMULTICLASS
+            - 3 : lCOST_SENSITIVE
+            - 4 : lCONTEXTUAL_BANDIT
+            - 5 : lMAX
+            - 6 : lCONDITIONAL_CONTEXTUAL_BANDIT
+            The integer is used to map the corresponding labelType using the
+            above available options
 
         Returns
         -------
 
         self : Example
 
+        See Also
+        --------
+
+        pyvw.vw
+
         """
 
         while hasattr(initStringOrDictOrRawExample, '__call__'):