AutoCluster is a dedicated AutoML pipeline designed specifically for clustering tasks. It automates the process of building, training, and evaluating clustering models, streamlining the workflow for unsupervised learning use cases where the goal is to group data into clusters.
Optional Parameters
- include
- Specifies the model algorithms to be used for model training phase.
By default, two models are used for training for clustering.
Permitted values are "KMeans", "GaussianMixture".
- exclude
- Specifies the model algorithms to be excluded from model training phase.
No model is excluded by default.
Permitted values are "KMeans", "GaussianMixture".
- verbose
- Specifies the detailed execution steps based on verbose level.Permitted values are:
- 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.
Default value is 0.
- max_runtime_secs
- Specifies the time limit in seconds for model training.
- stopping_metric
- Specifies the stopping metrics for stopping tolerance in model training.This argument is required if stopping_tolerance is set; otherwise, optional.
Permitted values are "SILHOUETTE", "CALINSKI", "DAVIES".
- stopping_tolerance
- Specifies the stopping tolerance for stopping metrics in model training.This argument is required if stopping_metric is set; otherwise, optional.
- max_models
- Specifies the maximum number of models to be trained.
- custom_config_file
- Specifies the path of JSON file in case of custom run.
- **kwargs
- Specifies additional arguments for AutoCluster.
- volatile
- 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
- persist
- 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
- seed
- Specifies the random seed for reproducibility.
Default value: 42
- raise_errors
- Specifies whether to raise errors or warnings for non-blocking errors. When set to True, raises errors, otherwise raises warnings.
Default value: False