Teradata Python Package Function Reference - 16.20 - LAR - Teradata Python Package

Teradata® Python Package Function Reference

prodname
Teradata Python Package
vrm_release
16.20
created_date
February 2020
category
Programming Reference
featnum
B700-4008-098K

 
teradataml.analytics.mle.LAR = class LAR(builtins.object)
     Methods defined here:
__init__(self, formula=None, data=None, type='LASSO', max_steps=None, normalize=True, intercept=True, data_sequence_column=None)
DESCRIPTION:
    The LAR (Least Angle Regression) function creates a model that the function LARPredict uses to
    make predictions for the response variables.
 
 
PARAMETERS:
    formula:
        Required Argument.
        A string consisting of "formula". Specifies the model to be fitted.
        Only basic formula of the "col1 ~ col2 + col3 +..." form are
        supported and all variables must be from the same teradataml
        DataFrame object. The response should be column of type float, int or
        bool.
        Types: str
 
    data:
        Required Argument.
        Specifies the name of the input teradataml DataFrame.
 
    type:
        Optional Argument.
        Specifies the method to use for linear regression.
        Default Value: "LASSO"
        Permitted Values: LAR, LASSO
        Types: str
 
    max_steps :
        Optional Argument.
        Specifies the maximum number of steps the function executes. The
        default value is 8 * min(number_of_predictors, sample_size -
        intercept).
        For example, if the number of predictors is 11, the sample size
        (number of rows in the input teradataml DataFrame) is 1532, and the intercept
        is 1, then the default value is 8 * min(11, 1532 - 1) = 88.
        Types: int
 
    normalize:
        Optional Argument.
        Specifies whether each predictor is standardized to have unit L2
        norm.
        Default Value: True
        Types: bool
 
    intercept:
        Optional Argument.
        Specifies whether an intercept is included in the model (and not
        penalized).
        Default Value: True
        Types: bool
 
    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 LAR.
    Output teradataml DataFrames can be accessed using attribute
    references, such as LARObj.<attribute_name>.
    Output teradataml DataFrame attribute name is:
        1. output_table
        2. output
 
 
RAISES:
    TeradataMlException
 
 
EXAMPLES:
    # Load example data
    load_example_data("lar", "diabetes")
 
    # Create teradataml DataFrame objects.
    diabetes = DataFrame.from_table("diabetes")
 
    # Example - Build a LAR model with response variable 'y' and ten baseline predictors
    LAR_out = LAR(formula = "y ~ hdl + glu + ldl + map1 + sex + tch + age + ltg + bmi + tc",
                  data = diabetes,
                  type = "lar",
                  max_steps  = 20,
                  normalize = True,
                  intercept = True
                  )
 
    # Print the results
    print(LAR_out)
__repr__(self)
Returns the string representation for a LAR class instance.