Teradata Package for Python Function Reference - 17.00 - Antiselect - 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.Antiselect = class Antiselect(builtins.object)
     Methods defined here:
__init__(self, data=None, exclude=None, data_sequence_column=None, data_order_column=None)
DESCRIPTION:
    AntiSelect returns all columns except those specified in the
    exclude argument.
 
 
PARAMETERS:
    data:
        Required Argument.
        Specifies the name of the teradataml DataFrame.
 
    data_order_column:
        Optional Argument.
        Specifies Order By columns for data.
        Values to this argument can be provided as list, if multiple columns
        are used for ordering.
        Types: str OR list of Strings (str)
 
    exclude:
        Required Argument.
        Specifies the names of the columns not to return.
        Types: str OR list of Strings (str)
 
    data_sequence_column:
        Optional Argument.
        Specifies the list of column(s) that uniquely identifies each row of
        the input argument "data". The argument is used to ensure
        deterministic results for functions which produce results that vary
        from run to run.
        Types: str OR list of Strings (str)
 
RETURNS:
    Instance of Antiselect.
    Output teradataml DataFrames can be accessed using attribute
    references, such as AntiselectObj.<attribute_name>.
    Output teradataml DataFrame attribute name is:
        result
 
 
RAISES:
    TeradataMlException
 
 
EXAMPLES:
    # Load the data to run the example.
    load_example_data("antiselect", "antiselect_input")
 
    # Create teradataml DataFrame objects
    antiselect_input = DataFrame.from_table("antiselect_input")
 
    # Example1 -
    antiselect_out = Antiselect(data=antiselect_input,
                                exclude=['rowids','orderdate','discount','province','custsegment'])
 
    # Print the results
    print(antiselect_out.result)
__repr__(self)
Returns the string representation for a Antiselect 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.