Teradata Package for Python Function Reference - 17.00 - CCMPrepare - Teradata Package for Python

Teradata® Package for Python Function Reference

Product
Teradata Package for Python
Release Number
17.00
Release Date
April 2021
Content Type
Programming Reference
Publication ID
B700-4008-070K
Language
English (United States)

 
teradataml.analytics.mle.CCMPrepare = class CCMPrepare(builtins.object)
     Methods defined here:
__init__(self, data=None, data_partition_column='1', data_order_column=None)
DESCRIPTION:
    The CCMPrepare function prepares an input teradataml DataFrame for
    the CCM function by adding a partition column, ccm id, and
    partitioning the data. Using the CCMPrepare function is optional.
    However, partitioning the data, instead of having all sequences on
    one vworker, may increase the speed of the CCM function for large
    data sets consisting of multiple sequences.
 
 
PARAMETERS:
    data:
        Required Argument.
        Specifies the teradataml DataFrame containing the input data.
 
    data_partition_column:
        Optional Argument.
        Specifies the Partition By columns for "data".
        Values to this argument can be provided as list, if multiple
        columns are used for partition.
        Default Value: 1
        Types: str OR list of Strings (str)
 
    data_order_column:
        Optional Argument.
        Specifies Order By columns for data.
        Values to this argument can be provided as a list, if multiple
        columns are used for ordering.
        Types: str OR list of Strings (str)
 
RETURNS:
    Instance of CCMPrepare.
    Output teradataml DataFrames can be accessed using attribute
    references, such as CCMPrepareObj.<attribute_name>.
    Output teradataml DataFrame attribute name is:
        result
 
 
RAISES:
    TeradataMlException
 
 
EXAMPLES:
    # Load example data.
    load_example_data("ccmprepare", "ccmprepare_input")
 
    # Create teradataml DataFrame objects. The ccmprepare_input table,
    # ccmprepare_input, is a collection of nine time series consisting
    # of 10 values for each of three variables (expenditure, income,
    # and investment)
    ccmprepare_input = DataFrame.from_table("ccmprepare_input")
 
    # Example - Prepare the given input for CCM.
    ccmprepare_out = CCMPrepare(data=ccmprepare_input,
                        data_partition_column='id'
                        )
 
    # Print the result teradataml DataFrame
    print(ccmprepare_out)
__repr__(self)
Returns the string representation for a CCMPrepare class instance.
get_build_time(self)
Function to return the build time of the algorithm in seconds.
When model object is created using retrieve_model(), then the value returned is
as saved in the Model Catalog.
get_prediction_type(self)
Function to return the Prediction type of the algorithm.
When model object is created using retrieve_model(), then the value returned is
as saved in the Model Catalog.
get_target_column(self)
Function to return the Target Column of the algorithm.
When model object is created using retrieve_model(), then the value returned is
as saved in the Model Catalog.
show_query(self)
Function to return the underlying SQL query.
When model object is created using retrieve_model(), then None is returned.