evalml.automl.search¶
-
evalml.automl.search(X_train=None, y_train=None, problem_type=None, objective='auto', **kwargs)[source]¶ Given data and configuration, run an automl search.
This method will run EvalML’s default suite of data checks. If the data checks produce errors, the data check results will be returned before running the automl search. In that case we recommend you alter your data to address these errors and try again.
This method is provided for convenience. If you’d like more control over when each of these steps is run, consider making calls directly to the various pieces like the data checks and AutoMLSearch, instead of using this method.
- Parameters
X_train (pd.DataFrame) – The input training data of shape [n_samples, n_features]. Required.
y_train (pd.Series) – The target training data of length [n_samples]. Required for supervised learning tasks.
problem_type (str or ProblemTypes) – type of supervised learning problem. See evalml.problem_types.ProblemType.all_problem_types for a full list.
objective (str, ObjectiveBase) –
The objective to optimize for. Used to propose and rank pipelines, but not for optimizing each pipeline during fit-time. When set to ‘auto’, chooses:
LogLossBinary for binary classification problems,
LogLossMulticlass for multiclass classification problems, and
R2 for regression problems.
Other keyword arguments which are provided will be passed to AutoMLSearch.
- Returns
the automl search object containing pipelines and rankings, and the results from running the data checks. If the data check results contain errors, automl search will not be run and an automl search object will not be returned.
- Return type
(AutoMLSearch, dict)