Teradata Package for Python Function Reference | 20.00 - predict - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.

Teradata® Package for Python Function Reference - 20.00

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Teradata Package for Python
Release Number
20.00
Published
March 2024
Language
English (United States)
Last Update
2024-04-10
dita:id
TeradataPython_FxRef_Enterprise_2000
Product Category
Teradata Vantage
teradataml.automl.__init__.AutoRegressor.predict = predict(self, data=None, rank=1)
DESCRIPTION:
    Function generates prediction on either default test data or any other data 
    using model rank in leaderboard and displays performance metrics 
    of the specified model.
    
    If test data contains target column, then it displays both prediction 
    and performance metrics, otherwise displays only prediction.
 
PARAMETERS:
    data:
        Optional Argument.
        Specifies the dataset on which prediction and performance
        metrices needs to be generated using model rank in leaderboard.
        When "data" is not specified default test data is used. Default 
        test data is the dataset generated at the time of training.
        Types: teradataml DataFrame
 
    rank:
        Optional Argument.
        Specifies the rank of the model in the leaderboard to be used for prediction.
        Default Value: 1
        Types: int
        
RETURNS:
    Pandas DataFrame with predictions.
 
RAISES:
    TeradataMlException, TypeError, ValueError
 
EXAMPLES:
    # Create an instance of the AutoML called "automl_obj" 
    # by referring "AutoML() or AutoRegressor() or AutoClassifier()" method.
    # Perform fit() operation on the "automl_obj".
    # Perform predict() operation on the "automl_obj".
    
    # Example 1: Run predict with best performing model.
    >>> prediction = automl_obj.predict()
    >>> prediction
    
    # Example 2: Run predict with second best performing model.
    >>> prediction = automl_obj.predict(rank=2)
    >>> prediction
    
    # Example 3: Run predict for new test data with best performing model.
    >>> prediction = automl_obj.predict(admissions_test)
    >>> prediction
    
    # Example 4: Run predict for new test data with second best performing model.
    >>> prediction = automl_obj.predict(admissions_test, rank=2)
    >>> prediction