teradataml.automl.AutoChurn.__init__ = __init__(self, include=None, exclude=None, verbose=0, max_runtime_secs=None, stopping_metric=None, stopping_tolerance=None, max_models=None, custom_config_file=None, **kwargs)

DESCRIPTION:
    AutoChurn is a dedicated AutoML pipeline designed specifically for churn prediction 
    tasks. It automates the process of building, training, and evaluating models 
    tailored to identify customer churn, streamlining the workflow for churn prediction 
    use cases.
    Note:
        * configure.temp_object_type="VT" follows sequential execution.
    
PARAMETERS:  
    include:
        Optional Argument.
        Specifies the model algorithms to be used for model training phase.
        By default, all 5 models are used for training for this specific binary
        classification problem.
        Permitted Values: "glm", "svm", "knn", "decision_forest", "xgboost"
        Types: str OR list of str  
    
    exclude:
        Optional Argument.
        Specifies the model algorithms to be excluded from model training phase.
        No model is excluded by default. 
        Permitted Values: "glm", "svm", "knn", "decision_forest", "xgboost"
        Types: str OR list of str
            
    verbose:
        Optional Argument.
        Specifies the detailed execution steps based on verbose level.
        Default Value: 0
        Permitted Values: 
            * 0: prints the progress bar and leaderboard
            * 1: prints the execution steps of AutoML.
            * 2: prints the intermediate data between the execution of each step of AutoML.
        Types: int
        
    max_runtime_secs:
        Optional Argument.
        Specifies the time limit in seconds for model training.
        Types: int
        
    stopping_metric:
        Required, when "stopping_tolerance" is set, otherwise optional.
        Specifies the stopping mertics for stopping tolerance in model training.
        Permitted Values: 'MICRO-F1','MACRO-F1','MICRO-RECALL','MACRO-RECALL',
                          'MICRO-PRECISION', 'MACRO-PRECISION','WEIGHTED-PRECISION',
                          'WEIGHTED-RECALL', 'WEIGHTED-F1', 'ACCURACY'
        Types: str
 
    stopping_tolerance:
        Required, when "stopping_metric" is set, otherwise optional.
        Specifies the stopping tolerance for stopping metrics in model training.
        Types: float
    
    max_models:
        Optional Argument.
        Specifies the maximum number of models to be trained.
        Types: int
        
    custom_config_file:
        Optional Argument.
        Specifies the path of json file in case of custom run.
        Types: str
 
    **kwargs:
        Specifies the additional arguments for AutoClassifier. Below
        are the additional arguments:
            volatile:
                Optional Argument.
                Specifies whether to put the interim results of the
                functions in a volatile table or not. When set to
                True, results are stored in a volatile table,
                otherwise not.
                Default Value: False
                Types: bool
 
            persist:
                Optional Argument.
                Specifies whether to persist the interim results of the
                functions in a table or not. When set to True,
                results are persisted in a table; otherwise,
                results are garbage collected at the end of the
                session.
                Default Value: False
                Types: bool
 
            seed:
                Optional Argument.
                Specifies the random seed for reproducibility.
                Default Value: 42
                Types: int
            
            imbalance_handling_method:
                Optional Argument.
                Specifies which data imbalance method to use.
                Default Value: SMOTE
                Permitted Values: "SMOTE", "ADASYN", "SMOTETomek", "NearMiss"
                Types: str
            
            enable_lasso:
                Optional Argument.
                Specifies whether to use lasso regression for feature selection.
                By default, only RFE and PCA are used for feature selection.
                Default Value: False
                Types: bool
            
            raise_errors:
                Optional Argument.
                Specifies whether to raise errors or warnings for
                non-blocking errors. When set to True, raises errors,
                otherwise raises warnings.
                Default Value: False
                Types: bool
        
RETURNS:
    Instance of AutoChurn.
 
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", "bank_churn")
 
    # Create teradataml DataFrame object.
    >>> churn_df = DataFrame.from_table("bank_churn")
    
    # Example 1 : Run AutoChurn for churn prediction problem
    # Scenario : Predict whether a customer churn for bank or not
    
    # Split the data into train and test.
    >>> churn_sample = churn_df.sample(frac = [0.8, 0.2])
    >>> churn_train= churn_sample[churn_sample['sampleid'] == 1].drop('sampleid', axis=1)
    >>> churn_test = churn_sample[churn_sample['sampleid'] == 2].drop('sampleid', axis=1)
 
    # Create instance of AutoChurn.
    >>> automl_obj = AutoChurn()
 
    # Fit the data.
    >>> automl_obj.fit(churn_train, "churn")
    
    # Display leaderboard.
    >>> automl_obj.leaderboard()
 
    # Display best performing model.
    >>> automl_obj.leader()
    
    # Run predict on test data using best performing model.
    >>> prediction = automl_obj.predict(churn_test)
    >>> prediction
    
    # Run predict on test data using second best performing model.
    >>> prediction = automl_obj.predict(churn_test, rank=2)
    >>> prediction
    
    # Run evaluate to get performance metrics using best performing model.
    >>> performance_metrics = automl_obj.evaluate(churn_test)
    >>> performance_metrics
    
    # Run evaluate to get performance metrics using model rank 4.
    >>> performance_metrics = automl_obj.evaluate(churn_test, 4)
    >>> performance_metrics
 
    # Example 2 : Run AutoChurn for churn prediction with stopping metric and tolerance and imbalance handling method.
    # Scenario : Predict whether a customer churn a bank or not. Use custom configuration 
    #            file to customize different processes of AutoML Run. Define
    #            performance threshold to acquire for the available models, and 
    #            terminate training upon meeting the stipulated performance criteria.
    
    # Split the data into train and test.
    >>> churn_sample = churn_df.sample(frac = [0.8, 0.2])
    >>> churn_train= churn_sample[churn_sample['sampleid'] == 1].drop('sampleid', axis=1)
    >>> churn_test = churn_sample[chrun_sample['sampleid'] == 2].drop('sampleid', axis=1)
 
    # Generate custom configuration file.
    >>> AutoChurn.generate_custom_config("custom_churn")
 
    # Create instance of AutoChurn.
    >>> automl_obj = AutoChurn(verbose=2,
    >>>                        stopping_metric="MACRO-F1",
    >>>                        stopping_tolerance=0.7,
    >>>                        imbalance_handling_method="ADASYN",
    >>>                        custom_config_file="custom_churn.json")
    # Fit the data.
    >>> automl_obj.fit(churn_train, churn_train.churn)
    
    # Display leaderboard.
    >>> automl_obj.leaderboard()
 
    # Run predict on test data using best performing model.
    >>> prediction = automl_obj.predict(churn_test)
    >>> prediction
    
    # Run evaluate to get performance metrics using best performing model.
    >>> performance_metrics = automl_obj.evaluate(churn_test)
    >>> performance_metrics