teradataml 20.0.0.8__py3-none-any.whl

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

@@ -0,0 +1,166 @@
+def OutlierFilterFit(data=None, target_columns=None, group_columns=None, lower_percentile=None,
+                     upper_percentile=None, iqr_multiplier=1.5, outlier_method=None, replacement_value=None,
+                     remove_tail="BOTH", percentile_method=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The OutlierFilterFit() function calculates the lower percentile, upper percentile,
+        count of rows and median for all the "target_columns" provided by the user.
+        These metrics for each column help the function OutlierTransform() detect
+        outliers in data. It stores parameters from arguments into an output used
+        during transformation.
+
+
+    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 to compute the metrics.
+            Types: str OR list of Strings (str)
+
+        lower_percentile:
+            Required Argument.
+            Specifies the lower range of percentile to be used.
+            Types: float
+
+        upper_percentile:
+            Required Argument.
+            Specifies the upper range of percentile to be used.
+            Types: float
+
+        outlier_method:
+            Required Argument.
+            Specifies the method for filtering the outliers.
+            Permitted Values:
+                * PERCENTILE - [min_value, max_value].
+                * TUKEY - [Q1 - k*(Q3-Q1), Q1 + k*(Q3-Q1)]
+                          where:
+                            Q1 = 25th quartile of data
+                            Q3 = 75th quartile of data
+                            k = interquantile range multiplier (see "iqr_multiplier")
+                * CARLING - Q2 ± c*(Q3-Q1)
+                            where:
+                                Q2 = median of data
+                                Q1 = 25th quartile of data
+                                Q3 = 75th quartile of data
+                                c = (17.63*r - 23.64) / (7.74*r - 3.71)
+                                r = count of rows in group_columns if you specify "group_columns",
+                                    otherwise count of rows in "data"
+            Types: str
+
+        replacement_value:
+            Required Argument.
+            Specifies the method to handle outliers.
+            Permitted Values:
+                * DELETE - Do not copy row to output DataFrame.
+                * NULL - Copy row to output DataFrame, replacing each outlier with NULL.
+                * MEDIAN - Copy row to output DataFrame, replacing each outlier with median
+                           value for its group.
+                * replacement value - Copy row to output DataFrame, replacing each outlier with
+                                      a replacement value. Replacement value must be numeric.
+            Types: str, int, float
+
+        percentile_method:
+            Required Argument.
+            Specifies the teradata percentile methods to be used for calculating the upper
+            and lower percentiles of the "target_columns".
+            Permitted Values:
+                * PERCENTILECONT - Considering continuous distribution.
+                * PERCENTILEDISC - Considering discrete distibution.
+            Types: str
+
+        group_columns:
+            Optional Argument.
+            Specifies the name(s) of the column(s) in "data" to group.
+            Types: str
+
+        iqr_multiplier:
+            Optional Argument.
+            Specifies the multiplier of interquartile range for 'TUKEY' filtering.
+            Default Value: 1.5
+            Types: float
+
+        remove_tail:
+            Optional Argument.
+            Specifies the tail of the distribution to remove.
+            Permitted Values:
+                * LOWER - The lower tail.
+                * UPPER - The upper tail.
+                * BOTH - Both tails.
+            Default Value: "BOTH"
+            Types: 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 OutlierFilterFit.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as OutlierFilterFitObj.<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 1: Generating fit object to find outlier values in column "fare".
+        fit_obj = OutlierFilterFit(data=titanic_data,
+                                   target_columns="fare",
+                                   lower_percentile=0.1,
+                                   upper_percentile=0.9,
+                                   outlier_method="PERCENTILE",
+                                   replacement_value="MEDIAN",
+                                   percentile_method="PERCENTILECONT")
+
+        # Print the result DataFrame.
+        print(fit_obj.result)
+    """

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

@@ -0,0 +1,105 @@
+def OutlierFilterTransform(data=None, object=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        OutlierFilterTransform() function filters the outliers from the input teradataml DataFrame.
+        OutlierFilterTransform() uses the result DataFrame from OutlierFilterFit() function to get
+        statistics like median, count of rows, lower percentile and upper percentile for every column
+        specified in target columns argument and filters the outliers in the input data.
+        Notes:
+            * Partitioning of input data and model is allowed using 'data_partition_column' and
+              'object_partition_column' only if 'group_columns' are passed while creating model
+              using OutlierFilterFit() function.
+            * Neither 'data_partition_column' nor 'object_partition_column' can be used independently.
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input teradataml DataFrame.
+            Types: teradataml DataFrame
+
+        object:
+            Required Argument.
+            Specifies the teradataml DataFrame containing the outlier metrics generated by
+            OutlierFilterFit() function or an instance of OutlierFilterFit.
+            Types: teradataml DataFrame or OutlierFilterFit
+
+        **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 OutlierFilterTransform.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as OutlierFilterTransformObj.<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 1: Finding outliers in column "fare" using "PERCENTILE" method.
+        # Generate fit object for column "fare".
+        fit_obj = OutlierFilterFit(data=titanic_data,
+                                   target_columns="fare",
+                                   lower_percentile=0.1,
+                                   upper_percentile=0.9,
+                                   outlier_method="PERCENTILE",
+                                   replacement_value="MEDIAN",
+                                   percentile_method="PERCENTILECONT")
+
+        # Print the result DataFrame.
+        print(fit_obj.result)
+
+        # Find the outliers by transforming fit object result DataFrame.
+        obj = OutlierFilterTransform(data=titanic_data,
+                                     object=fit_obj.result
+                                     )
+
+        # Print the result DataFrame.
+        print(obj.result)
+    """

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

@@ -0,0 +1,128 @@
+def Pack(data=None, input_columns=None, output_column=None, delimiter=",",
+         include_column_name=True, col_cast=False, accumulate=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The Pack() function packs data from multiple input DataFrame columns into a single column.
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input teradataml DataFrame.
+            Types: teradataml DataFrame
+
+        input_columns:
+            Optional Argument.
+            Specifies the names of the input columns to pack into a single output
+            column. These names become the column names of the virtual columns.
+            By default, all input teradataml DataFrame columns are packed into a
+            single output column. If you specify this argument, but do not
+            specify all input teradataml DataFrame columns, the function copies
+            the unspecified input tablecolumns to the output table.
+            Types: str OR list of Strings (str)
+
+        output_column:
+            Required Argument.
+            Specifies the name to give to the packed output column.
+            Types: str
+
+        delimiter:
+            Optional Argument.
+            Specifies the delimiter (a string) that separates the virtual columns
+            in the packed data.
+            Default Value: ","
+            Types: str
+
+        include_column_name:
+            Optional Argument.
+            Specifies whether to label each virtual column value with its
+            column name (making the virtual column target_column:value).
+            Default Value: True
+            Types: bool
+
+        col_cast:
+            Optional Argument.
+            Specifies whether to get better elapsed times with use cases involving numeric
+            columns to be packed.
+            Default Value: False
+            Types: bool
+
+        accumulate:
+            Optional Argument.
+            Specifies the input teradataml DataFrame columns to copy to the
+            output table. By default, the function copies no input teradataml
+            DataFrame columns to the output table.
+            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 Pack.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as PackObj.<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("pack", ["ville_temperature"])
+
+        # Create teradataml DataFrame object.
+        ville_temperature = DataFrame.from_table("ville_temperature")
+
+        # Check the list of available analytic functions.
+        display_analytic_functions()
+
+        # Example 1: Packs data from multiple input DataFrame columns
+        #            into a single column.
+        obj = Pack(data=ville_temperature,
+                   input_columns=['city','state','period','temp_f'],
+                   output_column='packed_data',
+                   delimiter=',',
+                   accumulate='city',
+                   include_column_name=True)
+
+        # Print the result DataFrame.
+        print(obj.result)
+
+
+    """

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

@@ -0,0 +1,112 @@
+def PolynomialFeaturesFit(data=None, target_columns=None, include_bias=True, interaction_only=False, degree=2,
+                          **generic_arguments):
+    """
+    DESCRIPTION:
+        PolynomialFeaturesFit() function stores all the specified values in the argument in a DataFrame format.
+        All polynomial combinations of the features with degrees less than or equal to the specified degree are
+        generated. For example, for a two-dimensional input sample [x, y], the degree-2 polynomial features are
+        [x, y, x-squared, xy, y-squared, 1].
+
+
+    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 polynomial
+            features needs to be generated.
+            Types: str OR list of Strings (str)
+
+        include_bias:
+            Optional Argument.
+            Specifies whether to include bias column in the output or not.
+            A bias column acts as an intercept term in a linear model.
+            Default Value: True
+            Types: bool
+
+        interaction_only:
+            Optional Argument.
+            Specifies whether to output polynomial combinations only for interaction features
+            (features that are products of at most degree distinct input features).
+            Default Value: False
+            Types: bool
+
+        degree:
+            Optional Argument.
+            Specifies the maximum degree of the input features to output polynomial combinations.
+            Permitted Values: 1, 2, 3
+            Default Value: 2
+            Types: int
+
+        **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 PolynomialFeaturesFit.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as PolynomialFeaturesFitObj.<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", ["numerics"])
+
+        # Create teradataml DataFrame object.
+        numerics = DataFrame.from_table("numerics")
+
+        # Check the list of available analytic functions.
+        display_analytic_functions()
+
+        # Example 1: Create fit object to create polynomial features for columns
+        #            "integer_col" and "smallint_col".
+        fit_obj = PolynomialFeaturesFit(data=numerics,
+                                        target_columns=["integer_col", "smallint_col"],
+                                        degree=2)
+
+        # Print the result DataFrame.
+        print(fit_obj.output)
+        print(fit_obj.output_data)
+    """

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

@@ -0,0 +1,102 @@
+def PolynomialFeaturesTransform(data=None, object=None, accumulate=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        PolynomialFeaturesTransform() function generates a feature matrix of all polynomial
+        combinations of the feature by extracting the target column, degree, bias and interaction
+        information from the output of the PolynomialFeaturesFit() function.
+
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input teradataml DataFrame.
+            Types: teradataml DataFrame
+        
+        object:
+            Required Argument.
+            Specifies the teradataml DataFrame containing the output of generated by
+            PolynomialFeaturesFit() function or the instance of PolynomialFeaturesFit.
+            Types: teradataml DataFrame or PolynomialFeaturesFit
+        
+        accumulate:
+            Optional Argument.
+            Specifies the names of input teradataml DataFrame columns to copy to the output.
+            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 PolynomialFeaturesTransform.
+        Output teradataml DataFrames can be accessed using attribute 
+        references, such as 
+        PolynomialFeaturesTransformObj.<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", ["numerics"])
+
+        # Create teradataml DataFrame object.
+        numerics = DataFrame.from_table("numerics")
+
+        # Check the list of available analytic functions.
+        display_analytic_functions()
+
+        # Example 1: Generate feature DataFrame for all 2D polynomial combination of columns
+        #            "integer_col"and "smallint_col".
+        fit_obj = PolynomialFeaturesFit(data=numerics,
+                                        target_columns=["integer_col", "smallint_col"],
+                                        degree=2)
+
+        # Print the result DataFrame.
+        print(fit_obj.output)
+        print(fit_obj.output_data)
+
+        # Generate feature matrix.
+        obj = PolynomialFeaturesTransform(data=numerics,
+                                          object=fit_obj.output
+                                          )
+
+        # Print the result DataFrame.
+        print(obj.result)
+    """