teradataml 17.20.0.7__py3-none-any.whl → 20.0.0.1__py3-none-any.whl

teradataml/data/docs/sqle/docs_17_10/CategoricalSummary.py

@@ -1,86 +1,86 @@
-def CategoricalSummary(data = None, target_columns = None, **generic_arguments):
-    """
-    DESCRIPTION:
-        The CategoricalSummary() function displays the distinct values and their counts for
-        each specified input DataFrame column.
-
-
-    PARAMETERS:
-        data:
-            Required Argument.
-            Specifies the input teradataml DataFrame.
-            Types: teradataml DataFrame
-
-        target_columns:
-            Required Argument.
-            Specifies the name(s) of the column(s) in "data" for which
-            categorical summary needs to be determined.
-            Types: str OR list of Strings (str)
-
-        **generic_arguments:
-            Specifies the generic keyword arguments SQLE functions accept.
-            Below are the generic keyword arguments:
-                persist:
-                    Optional Argument.
-                    Specifies whether to persist the results of the function in table or
-                    not. When set to True, results are persisted in table; otherwise,
-                    results are garbage collected at the end of the session.
-                    Default Value: False
-                    Types: boolean
-
-                volatile:
-                    Optional Argument.
-                    Specifies whether to put the results of the function in volatile table
-                    or not. When set to True, results are stored in volatile table,
-                    otherwise not.
-                    Default Value: False
-                    Types: boolean
-
-                Function allows the user to partition, hash, order or local order the input
-                data. These generic arguments are available for each argument that accepts
-                teradataml DataFrame as input and can be accessed as:
-                    * "<input_data_arg_name>_partition_column" accepts str or list of str (Strings)
-                    * "<input_data_arg_name>_hash_column" accepts str or list of str (Strings)
-                    * "<input_data_arg_name>_order_column" accepts str or list of str (Strings)
-                    * "local_order_<input_data_arg_name>" accepts boolean
-                Note:
-                    These generic arguments are supported by teradataml if the underlying
-                    SQLE Engine function supports, else an exception is raised.
-
-    RETURNS:
-        Instance of CategoricalSummary.
-        Output teradataml DataFrames can be accessed using attribute
-        references, such as CategoricalSummaryObj.<attribute_name>.
-        Output teradataml DataFrame attribute name is:
-            result
-
-    RAISES:
-        TeradataMlException, TypeError, ValueError
-
-
-    EXAMPLES:
-        # Notes:
-        #     1. Get the connection to Vantage to execute the function.
-        #     2. One must import the required functions mentioned in
-        #        the example from teradataml.
-        #     3. Function will raise error if not supported on the Vantage
-        #        user is connected to.
-
-        # Load the example data.
-        load_example_data("teradataml", "titanic")
-
-        # Create teradataml DataFrame object.
-        titanic_data = DataFrame.from_table("titanic")
-
-        # Check the list of available analytic functions.
-        display_analytic_functions()
-
-        # Example: Find the distinct values and counts for column 'sex'.
-        obj = CategoricalSummary(data=titanic_data,
-                                 target_columns="sex"
-                                )
-
-        # Print the result DataFrame.
-        print(obj.result)
-
-    """
+def CategoricalSummary(data = None, target_columns = None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The CategoricalSummary() function displays the distinct values and their counts for
+        each specified input DataFrame column.
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input teradataml DataFrame.
+            Types: teradataml DataFrame
+
+        target_columns:
+            Required Argument.
+            Specifies the name(s) of the column(s) in "data" for which
+            categorical summary needs to be determined.
+            Types: str OR list of Strings (str)
+
+        **generic_arguments:
+            Specifies the generic keyword arguments SQLE functions accept.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the function in table or
+                    not. When set to True, results are persisted in table; otherwise,
+                    results are garbage collected at the end of the session.
+                    Default Value: False
+                    Types: boolean
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the function in volatile table
+                    or not. When set to True, results are stored in volatile table,
+                    otherwise not.
+                    Default Value: False
+                    Types: boolean
+
+                Function allows the user to partition, hash, order or local order the input
+                data. These generic arguments are available for each argument that accepts
+                teradataml DataFrame as input and can be accessed as:
+                    * "<input_data_arg_name>_partition_column" accepts str or list of str (Strings)
+                    * "<input_data_arg_name>_hash_column" accepts str or list of str (Strings)
+                    * "<input_data_arg_name>_order_column" accepts str or list of str (Strings)
+                    * "local_order_<input_data_arg_name>" accepts boolean
+                Note:
+                    These generic arguments are supported by teradataml if the underlying
+                    SQLE Engine function supports, else an exception is raised.
+
+    RETURNS:
+        Instance of CategoricalSummary.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as CategoricalSummaryObj.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            result
+
+    RAISES:
+        TeradataMlException, TypeError, ValueError
+
+
+    EXAMPLES:
+        # Notes:
+        #     1. Get the connection to Vantage to execute the function.
+        #     2. One must import the required functions mentioned in
+        #        the example from teradataml.
+        #     3. Function will raise error if not supported on the Vantage
+        #        user is connected to.
+
+        # Load the example data.
+        load_example_data("teradataml", "titanic")
+
+        # Create teradataml DataFrame object.
+        titanic_data = DataFrame.from_table("titanic")
+
+        # Check the list of available analytic functions.
+        display_analytic_functions()
+
+        # Example: Find the distinct values and counts for column 'sex'.
+        obj = CategoricalSummary(data=titanic_data,
+                                 target_columns="sex"
+                                )
+
+        # Print the result DataFrame.
+        print(obj.result)
+
+    """

teradataml/data/docs/sqle/docs_17_10/ChiSq.py

@@ -1,90 +1,90 @@
-def ChiSq(data=None, alpha=0.05, **generic_arguments):
-    """
-    DESCRIPTION:
-        The ChiSq() function performs Pearson's chi-squared (χ2) test for independence,
-        which determines if there is a statistically significant difference between
-        the expected and observed frequencies in one or more categories of a
-        contingency table (also called a cross tabulation).
-
-
-    PARAMETERS:
-        data:
-            Required Argument.
-            Specifies the input teradataml DataFrame.
-            Types: teradataml DataFrame
-
-        alpha:
-            Optional Argument.
-            Specifies the probability below which the null hypothesis is rejected.
-            "alpha" must be a numeric value in the range [0, 1].
-            Default Value: 0.05
-            Types: float
-
-        **generic_arguments:
-            Specifies the generic keyword arguments SQLE functions accept.
-            Below are the generic keyword arguments:
-                persist:
-                    Optional Argument.
-                    Specifies whether to persist the results of the function in table or
-                    not. When set to True, results are persisted in table; otherwise,
-                    results are garbage collected at the end of the session.
-                    Default Value: False
-                    Types: boolean
-
-                volatile:
-                    Optional Argument.
-                    Specifies whether to put the results of the function in volatile table
-                    or not. When set to True, results are stored in volatile table,
-                    otherwise not.
-                    Default Value: False
-                    Types: boolean
-
-                Function allows the user to partition, hash, order or local order the input
-                data. These generic arguments are available for each argument that accepts
-                teradataml DataFrame as input and can be accessed as:
-                    * "<input_data_arg_name>_partition_column" accepts str or list of str (Strings)
-                    * "<input_data_arg_name>_hash_column" accepts str or list of str (Strings)
-                    * "<input_data_arg_name>_order_column" accepts str or list of str (Strings)
-                    * "local_order_<input_data_arg_name>" accepts boolean
-                Note:
-                    These generic arguments are supported by teradataml if the underlying
-                    SQLE Engine function supports, else an exception is raised.
-
-    RETURNS:
-        Instance of ChiSq.
-        Output teradataml DataFrames can be accessed using attribute
-        references, such as ChiSq.<attribute_name>.
-        Output teradataml DataFrame attribute names are:
-            1. output_data
-            2. output
-
-    RAISES:
-        TeradataMlException, TypeError, ValueError
-
-
-    EXAMPLES:
-        # Notes:
-        #     1. Get the connection to Vantage to execute the function.
-        #     2. One must import the required functions mentioned in
-        #        the example from teradataml.
-        #     3. Function will raise error if not supported on the Vantage
-        #        user is connected to.
-
-        # Load the example data.
-        load_example_data("teradataml", "chi_sq")
-
-        # Create teradataml DataFrame object.
-        chi_sq_data = DataFrame.from_table("chi_sq")
-
-        # Check the list of available analytic functions.
-        display_analytic_functions()
-
-        # Example: Run ChiSq() with all arguments.
-        obj = ChiSq(data=chi_sq_data,
-                    alpha=0.5)
-
-        # Print the output DataFrame and expected values DataFrame.
-        print(obj.output)
-        print(obj.output_data)
-
-    """
+def ChiSq(data=None, alpha=0.05, **generic_arguments):
+    """
+    DESCRIPTION:
+        The ChiSq() function performs Pearson's chi-squared (χ2) test for independence,
+        which determines if there is a statistically significant difference between
+        the expected and observed frequencies in one or more categories of a
+        contingency table (also called a cross tabulation).
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input teradataml DataFrame.
+            Types: teradataml DataFrame
+
+        alpha:
+            Optional Argument.
+            Specifies the probability below which the null hypothesis is rejected.
+            "alpha" must be a numeric value in the range [0, 1].
+            Default Value: 0.05
+            Types: float
+
+        **generic_arguments:
+            Specifies the generic keyword arguments SQLE functions accept.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the function in table or
+                    not. When set to True, results are persisted in table; otherwise,
+                    results are garbage collected at the end of the session.
+                    Default Value: False
+                    Types: boolean
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the function in volatile table
+                    or not. When set to True, results are stored in volatile table,
+                    otherwise not.
+                    Default Value: False
+                    Types: boolean
+
+                Function allows the user to partition, hash, order or local order the input
+                data. These generic arguments are available for each argument that accepts
+                teradataml DataFrame as input and can be accessed as:
+                    * "<input_data_arg_name>_partition_column" accepts str or list of str (Strings)
+                    * "<input_data_arg_name>_hash_column" accepts str or list of str (Strings)
+                    * "<input_data_arg_name>_order_column" accepts str or list of str (Strings)
+                    * "local_order_<input_data_arg_name>" accepts boolean
+                Note:
+                    These generic arguments are supported by teradataml if the underlying
+                    SQLE Engine function supports, else an exception is raised.
+
+    RETURNS:
+        Instance of ChiSq.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as ChiSq.<attribute_name>.
+        Output teradataml DataFrame attribute names are:
+            1. output_data
+            2. output
+
+    RAISES:
+        TeradataMlException, TypeError, ValueError
+
+
+    EXAMPLES:
+        # Notes:
+        #     1. Get the connection to Vantage to execute the function.
+        #     2. One must import the required functions mentioned in
+        #        the example from teradataml.
+        #     3. Function will raise error if not supported on the Vantage
+        #        user is connected to.
+
+        # Load the example data.
+        load_example_data("teradataml", "chi_sq")
+
+        # Create teradataml DataFrame object.
+        chi_sq_data = DataFrame.from_table("chi_sq")
+
+        # Check the list of available analytic functions.
+        display_analytic_functions()
+
+        # Example: Run ChiSq() with all arguments.
+        obj = ChiSq(data=chi_sq_data,
+                    alpha=0.5)
+
+        # Print the output DataFrame and expected values DataFrame.
+        print(obj.output)
+        print(obj.output_data)
+
+    """

teradataml/data/docs/sqle/docs_17_10/ColumnSummary.py

@@ -1,86 +1,86 @@
-def ColumnSummary(data = None, target_columns = None, **generic_arguments):
-    """
-    DESCRIPTION:
-        The ColumnSummary() function can be used to take a quick look at the columns,
-        their datatypes, and summary of NULLs/non-NULLs for a given table.
-
-    PARAMETERS:
-        data:
-            Required Argument.
-            Specifies the input teradataml DataFrame.
-            Types: teradataml DataFrame
-
-        target_columns:
-            Required Argument.
-            Specifies the input teradataml DataFrame columns for which column
-            summary needs to be determined.
-            Types: str OR list of Strings (str)
-
-        **generic_arguments:
-            Specifies the generic keyword arguments SQLE functions accept.
-            Below are the generic keyword arguments:
-                persist:
-                    Optional Argument.
-                    Specifies whether to persist the results of the function in table or
-                    not. When set to True, results are persisted in table; otherwise,
-                    results are garbage collected at the end of the session.
-                    Default Value: False
-                    Types: boolean
-
-                volatile:
-                    Optional Argument.
-                    Specifies whether to put the results of the function in volatile table
-                    or not. When set to True, results are stored in volatile table,
-                    otherwise not.
-                    Default Value: False
-                    Types: boolean
-
-                Function allows the user to partition, hash, order or local order the input
-                data. These generic arguments are available for each argument that accepts
-                teradataml DataFrame as input and can be accessed as:
-                    * "<input_data_arg_name>_partition_column" accepts str or list of str (Strings)
-                    * "<input_data_arg_name>_hash_column" accepts str or list of str (Strings)
-                    * "<input_data_arg_name>_order_column" accepts str or list of str (Strings)
-                    * "local_order_<input_data_arg_name>" accepts boolean
-                Note:
-                    These generic arguments are supported by teradataml if the underlying
-                    SQLE Engine function supports, else an exception is raised.
-
-
-    RETURNS:
-        Instance of ColumnSummary.
-        Output teradataml DataFrames can be accessed using attribute
-        references, such as ColumnSummaryObj.<attribute_name>.
-        Output teradataml DataFrame attribute name is:
-            result
-
-    RAISES:
-        TeradataMlException, TypeError, ValueError
-
-
-    EXAMPLES:
-        # Notes:
-        #     1. Get the connection to Vantage to execute the function.
-        #     2. One must import the required functions mentioned in
-        #        the example from teradataml.
-        #     3. Function will raise error if not supported on the Vantage
-        #        user is connected to.
-
-        # Load the example data.
-        load_example_data("teradataml", "titanic")
-
-        # Create teradataml DataFrame object.
-        titanic_data = DataFrame.from_table("titanic")
-
-        # Check the list of available analytic functions.
-        display_analytic_functions()
-
-        # Example: Find datatypes, NULL and non-NULL counts etc.
-        obj = ColumnSummary(data=titanic_data,
-                            target_columns=['age', 'pclass', 'embarked', 'cabin']
-                           )
-
-        # Print the result DataFrame.
-        print(obj.result)
-        
+def ColumnSummary(data = None, target_columns = None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The ColumnSummary() function can be used to take a quick look at the columns,
+        their datatypes, and summary of NULLs/non-NULLs for a given table.
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input teradataml DataFrame.
+            Types: teradataml DataFrame
+
+        target_columns:
+            Required Argument.
+            Specifies the input teradataml DataFrame columns for which column
+            summary needs to be determined.
+            Types: str OR list of Strings (str)
+
+        **generic_arguments:
+            Specifies the generic keyword arguments SQLE functions accept.
+            Below are the generic keyword arguments:
+                persist:
+                    Optional Argument.
+                    Specifies whether to persist the results of the function in table or
+                    not. When set to True, results are persisted in table; otherwise,
+                    results are garbage collected at the end of the session.
+                    Default Value: False
+                    Types: boolean
+
+                volatile:
+                    Optional Argument.
+                    Specifies whether to put the results of the function in volatile table
+                    or not. When set to True, results are stored in volatile table,
+                    otherwise not.
+                    Default Value: False
+                    Types: boolean
+
+                Function allows the user to partition, hash, order or local order the input
+                data. These generic arguments are available for each argument that accepts
+                teradataml DataFrame as input and can be accessed as:
+                    * "<input_data_arg_name>_partition_column" accepts str or list of str (Strings)
+                    * "<input_data_arg_name>_hash_column" accepts str or list of str (Strings)
+                    * "<input_data_arg_name>_order_column" accepts str or list of str (Strings)
+                    * "local_order_<input_data_arg_name>" accepts boolean
+                Note:
+                    These generic arguments are supported by teradataml if the underlying
+                    SQLE Engine function supports, else an exception is raised.
+
+
+    RETURNS:
+        Instance of ColumnSummary.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as ColumnSummaryObj.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            result
+
+    RAISES:
+        TeradataMlException, TypeError, ValueError
+
+
+    EXAMPLES:
+        # Notes:
+        #     1. Get the connection to Vantage to execute the function.
+        #     2. One must import the required functions mentioned in
+        #        the example from teradataml.
+        #     3. Function will raise error if not supported on the Vantage
+        #        user is connected to.
+
+        # Load the example data.
+        load_example_data("teradataml", "titanic")
+
+        # Create teradataml DataFrame object.
+        titanic_data = DataFrame.from_table("titanic")
+
+        # Check the list of available analytic functions.
+        display_analytic_functions()
+
+        # Example: Find datatypes, NULL and non-NULL counts etc.
+        obj = ColumnSummary(data=titanic_data,
+                            target_columns=['age', 'pclass', 'embarked', 'cabin']
+                           )
+
+        # Print the result DataFrame.
+        print(obj.result)
+        
     """