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

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

@@ -1,83 +1,83 @@
-def FillRowId(data = None, row_id_column = None, **generic_arguments):
-    """
-    DESCRIPTION:
-        The FillRowId() function adds a column of unique row identifiers to the
-        input DataFrame.
-
-    PARAMETERS:
-        data:
-            Required Argument.
-            Specifies the input teradataml DataFrame.
-            Types: teradataml DataFrame
-
-        row_id_column:
-            Optional Argument.
-            Specifies a name for the ID column in the output.
-            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 FillRowID.
-        Output teradataml DataFrames can be accessed using attribute
-        references, such as FillRowIDObj.<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: Add column "PassengerId" with unique row identifiers to the input
-        #          teradataml DataFrame.
-        obj = FillRowId(data=titanic_data,
-                        row_id_column='PassengerId'
-                       )
-
-        # Print the result DataFrame.
-        print(obj.result)
+def FillRowId(data = None, row_id_column = None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The FillRowId() function adds a column of unique row identifiers to the
+        input DataFrame.
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input teradataml DataFrame.
+            Types: teradataml DataFrame
+
+        row_id_column:
+            Optional Argument.
+            Specifies a name for the ID column in the output.
+            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 FillRowID.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as FillRowIDObj.<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: Add column "PassengerId" with unique row identifiers to the input
+        #          teradataml DataFrame.
+        obj = FillRowId(data=titanic_data,
+                        row_id_column='PassengerId'
+                       )
+
+        # Print the result DataFrame.
+        print(obj.result)
     """

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

@@ -1,88 +1,88 @@
-def Fit(data = None, object = None, **generic_arguments):
-    """
-    DESCRIPTION:
-        The Fit() function determines whether specified numeric transformations can be
-        applied to specified "target_columns" and outputs a DataFrame to use as input
-        "data" for Transform() function, which does the transformations.
-
-    PARAMETERS:
-        data:
-            Required Argument.
-            Specifies the input teradataml DataFrame.
-            Types: teradataml DataFrame
-
-        object:
-            Required Argument.
-            Specifies the transformation teradataml DataFrame that contains transformation
-            information for the columns in "data".
-            Types: teradataml DataFrame
-
-        **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 Fit.
-        Output teradataml DataFrames can be accessed using attribute
-        references, such as FitObj.<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", ["iris_input", "transformation_table"])
-
-        # Create teradataml DataFrame objects.
-        iris_input = DataFrame.from_table("iris_input")
-        transformation_df = DataFrame.from_table("transformation_table")
-
-        # Check the list of available analytic functions.
-        display_analytic_functions()
-
-        # Example 1: Run Fit() with all arguments.
-        fit_df = Fit(data=iris_input,
-                     object=transformation_df,
-                     object_order_column='TargetColumn'
-                    )
-
-        # Print the result DataFrame.
-        print(fit_df)
-
+def Fit(data=None, object=None, **generic_arguments):
+    """
+    DESCRIPTION:
+        The Fit() function determines whether specified numeric transformations can be
+        applied to specified "target_columns" and outputs a DataFrame to use as input
+        "data" for Transform() function, which does the transformations.
+
+    PARAMETERS:
+        data:
+            Required Argument.
+            Specifies the input teradataml DataFrame.
+            Types: teradataml DataFrame
+
+        object:
+            Required Argument.
+            Specifies the transformation teradataml DataFrame that contains transformation
+            information for the columns in "data".
+            Types: teradataml DataFrame
+
+        **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 Fit.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as FitObj.<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", ["iris_input", "transformation_table"])
+
+        # Create teradataml DataFrame objects.
+        iris_input = DataFrame.from_table("iris_input")
+        transformation_df = DataFrame.from_table("transformation_table")
+
+        # Check the list of available analytic functions.
+        display_analytic_functions()
+
+        # Example 1: Run Fit() with all arguments.
+        fit_df = Fit(data=iris_input,
+                     object=transformation_df,
+                     object_order_column='TargetColumn'
+                    )
+
+        # Print the result DataFrame.
+        print(fit_df)
+
     """

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

@@ -1,144 +1,144 @@
-def GLMPredict(modeldata = None, newdata = None, terms = None, family = None, linkfunction = "CANONICAL",
-               output_prob = False, output_responses = None, **generic_arguments):
-    
-    """
-    DESCRIPTION:
-    The GLMPredict() function uses the model generated by the function GLM()
-    to perform generalized linear model prediction on new input data.
-
-    Note:
-        * The GLMPredict() function accepts models from the GLM() function in MLE,
-          whereas the TDGLMPredict() function accepts models from GLM() function in SQLE.
-
-
-    PARAMETERS:
-        modeldata:
-            Required Argument.
-            Specifies the teradataml DataFrame containing the model data
-            generated by GLM() function or an instance of GLM.
-            Types: teradataml DataFrame or GLM
-
-        newdata:
-            Required Argument.
-            Specifies the teradataml DataFrame containing the input data.
-            Types: teradataml DataFrame
-
-        terms:
-            Optional Argument.
-            Specifies the names of newdata columns to copy to the output
-            teradataml DataFrame.
-            Types: str OR list of Strings (str)
-
-        family:
-            Optional Argument.
-            Specifies the distribution exponential family. The default value is
-            read from modeldata. If you specify this argument, you must give it
-            the same value that you used for the Family argument of the function
-            when you generated the model.
-            Permitted Values: LOGISTIC, BINOMIAL, POISSON, GAUSSIAN, GAMMA,
-            INVERSE_GAUSSIAN, NEGATIVE_BINOMIAL
-            Types: str
-
-        linkfunction:
-            Optional Argument.
-            The canonical link functions (default link functions) and the link
-            functions that are allowed for each exponential family.
-            Note:
-                Use the same value that you used for the Link argument of the
-                function  when you generated the model.
-            Default Value: "CANONICAL"
-            Permitted Values: CANONICAL, IDENTITY, INVERSE, LOG,
-            COMPLEMENTARY_LOG_LOG, SQUARE_ROOT, INVERSE_MU_SQUARED, LOGIT,
-            PROBIT, CAUCHIT
-            Types: str
-
-        output_prob:
-            Optional Argument.
-            Specifies whether to output probabilities.
-            Default Value: False
-            Types: bool
-
-        output_responses:
-            Optional Argument.
-            Specifies responses for which to output probabilities.
-            Types: str OR list of strs
-
-        **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 GLMPredict.
-        Output teradataml DataFrames can be accessed using attribute
-        references, such as GLMPredictObj.<attribute_name>.
-        Output teradataml DataFrame attribute name is:
-            result
-
-
-    RAISES:
-        TeradataMlException
-
-
-    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 data to run the example.
-        load_example_data("GLMPredict", "admissions_test")
-        load_example_data("teradataml", "glm_admissions_model")
-
-        # Create teradataml DataFrame objects.
-        admissions_test = DataFrame.from_table("admissions_test")
-
-        # Create teradataml DataFrame object for model data.
-        glm_admissions_model = DataFrame.from_table("glm_admissions_model")
-
-        # Check the list of available analytic functions.
-        display_analytic_functions()
-
-        # Example 1: Predicting if student is admitted or not with probabilities of
-        #            the both the responses. Response '1' means admitted and '0' means
-        #            not admitted.
-        obj = teradataml.GLMPredict(modeldata = glm_admissions_model,
-                                    newdata = admissions_test,
-                                    newdata_order_column="id",
-                                    modeldata_order_column=["attribute", "predictor"],
-                                    family="LOGISTIC",
-                                    terms=["id", "masters", "gpa", "stats", "programming", "admitted"],
-                                    linkfunction="CANONICAL",
-                                    output_prob=True,
-                                    output_responses=["1", "0"])
-
-        # Print the result DataFrame.
-        print(obj.result)
-
-    """
+def GLMPredict(modeldata = None, newdata = None, terms = None, family = None, linkfunction = "CANONICAL",
+               output_prob = False, output_responses = None, **generic_arguments):
+    
+    """
+    DESCRIPTION:
+    The GLMPredict() function uses the model generated by the function GLM()
+    to perform generalized linear model prediction on new input data.
+
+    Note:
+        * The GLMPredict() function accepts models from the GLM() function in MLE,
+          whereas the TDGLMPredict() function accepts models from GLM() function in SQLE.
+
+
+    PARAMETERS:
+        modeldata:
+            Required Argument.
+            Specifies the teradataml DataFrame containing the model data
+            generated by GLM() function or an instance of GLM.
+            Types: teradataml DataFrame or GLM
+
+        newdata:
+            Required Argument.
+            Specifies the teradataml DataFrame containing the input data.
+            Types: teradataml DataFrame
+
+        terms:
+            Optional Argument.
+            Specifies the names of newdata columns to copy to the output
+            teradataml DataFrame.
+            Types: str OR list of Strings (str)
+
+        family:
+            Optional Argument.
+            Specifies the distribution exponential family. The default value is
+            read from modeldata. If you specify this argument, you must give it
+            the same value that you used for the Family argument of the function
+            when you generated the model.
+            Permitted Values: LOGISTIC, BINOMIAL, POISSON, GAUSSIAN, GAMMA,
+            INVERSE_GAUSSIAN, NEGATIVE_BINOMIAL
+            Types: str
+
+        linkfunction:
+            Optional Argument.
+            The canonical link functions (default link functions) and the link
+            functions that are allowed for each exponential family.
+            Note:
+                Use the same value that you used for the Link argument of the
+                function  when you generated the model.
+            Default Value: "CANONICAL"
+            Permitted Values: CANONICAL, IDENTITY, INVERSE, LOG,
+            COMPLEMENTARY_LOG_LOG, SQUARE_ROOT, INVERSE_MU_SQUARED, LOGIT,
+            PROBIT, CAUCHIT
+            Types: str
+
+        output_prob:
+            Optional Argument.
+            Specifies whether to output probabilities.
+            Default Value: False
+            Types: bool
+
+        output_responses:
+            Optional Argument.
+            Specifies responses for which to output probabilities.
+            Types: str OR list of strs
+
+        **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 GLMPredict.
+        Output teradataml DataFrames can be accessed using attribute
+        references, such as GLMPredictObj.<attribute_name>.
+        Output teradataml DataFrame attribute name is:
+            result
+
+
+    RAISES:
+        TeradataMlException
+
+
+    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 data to run the example.
+        load_example_data("GLMPredict", "admissions_test")
+        load_example_data("teradataml", "glm_admissions_model")
+
+        # Create teradataml DataFrame objects.
+        admissions_test = DataFrame.from_table("admissions_test")
+
+        # Create teradataml DataFrame object for model data.
+        glm_admissions_model = DataFrame.from_table("glm_admissions_model")
+
+        # Check the list of available analytic functions.
+        display_analytic_functions()
+
+        # Example 1: Predicting if student is admitted or not with probabilities of
+        #            the both the responses. Response '1' means admitted and '0' means
+        #            not admitted.
+        obj = teradataml.GLMPredict(modeldata = glm_admissions_model,
+                                    newdata = admissions_test,
+                                    newdata_order_column="id",
+                                    modeldata_order_column=["attribute", "predictor"],
+                                    family="LOGISTIC",
+                                    terms=["id", "masters", "gpa", "stats", "programming", "admitted"],
+                                    linkfunction="CANONICAL",
+                                    output_prob=True,
+                                    output_responses=["1", "0"])
+
+        # Print the result DataFrame.
+        print(obj.result)
+
+    """