def score_batch(self, pipelines, X, y, objectives):
"""Score a batch of pipelines.
Arguments:
pipelines (list(PipelineBase)): A batch of fitted pipelines to score.
X (ww.DataTable, pd.DataFrame): Features to score on.
y (ww.DataTable, pd.DataFrame): Data to score on.
objectives (list(ObjectiveBase), list(str)): Objectives to score on.
Returns:
Dict[pipeline name, score]: Scores for all objectives for all pipelines.
"""
check_all_pipeline_names_unique(pipelines)
def train_batch(self, pipelines):
"""Train a batch of pipelines using the current dataset.
Arguments:
pipelines (list(PipelineBase)): A batch of pipelines to fit.
Returns:
list(PipelineBase): List of fitted pipelines
"""
if self.X_train is None or self.y_train is None:
raise ValueError("Dataset has not been loaded into the engine.")
check_all_pipeline_names_unique(pipelines)
def score_pipelines(self, pipelines, X_holdout, y_holdout, objectives):
"""Score a list of pipelines on the given holdout data.
Arguments:
pipelines (list(PipelineBase)): List of pipelines to train.
X_holdout (ww.DataTable, pd.DataFrame): Holdout features.
y_holdout (ww.DataTable, pd.DataFrame): Holdout targets for scoring.
objectives (list(str), list(ObjectiveBase)): Objectives used for scoring.
Returns:
Dict[str, Dict[str, float]]: Dictionary keyed by pipeline name that maps to a dictionary of scores.
Note that the any pipelines that error out during scoring will not be included in the dictionary
but the exception and stacktrace will be displayed in the log.
"""
check_all_pipeline_names_unique(pipelines)
scores = {}
objectives = [get_objective(o, return_instance=True) for o in objectives]
computations = []
for pipeline in pipelines:
computations.append(self._engine.submit_scoring_job(self.automl_config, pipeline, X_holdout, y_holdout, objectives))
while computations:
computation = computations.pop(0)
if computation.done():
pipeline_name = computation.meta_data["pipeline_name"]
try:
scores[pipeline_name] = computation.get_result()
except Exception as e:
logger.error(f"Score error for {pipeline_name}: {str(e)}")
if isinstance(e, PipelineScoreError):
nan_scores = {objective: np.nan for objective in e.exceptions}
scores[pipeline_name] = {**nan_scores, **e.scored_successfully}
else:
# Traceback already included in the PipelineScoreError so we only
# need to include it for all other errors
tb = traceback.format_tb(sys.exc_info()[2])
logger.error("Traceback:")
logger.error("\n".join(tb))
scores[pipeline_name] = {objective.name: np.nan for objective in objectives}
else:
computations.append(computation)
return scores
def train_pipelines(self, pipelines):
"""Train a list of pipelines on the training data.
This can be helpful for training pipelines once the search is complete.
Arguments:
pipelines (list(PipelineBase)): List of pipelines to train.
Returns:
Dict[str, PipelineBase]: Dictionary keyed by pipeline name that maps to the fitted pipeline.
Note that the any pipelines that error out during training will not be included in the dictionary
but the exception and stacktrace will be displayed in the log.
"""
check_all_pipeline_names_unique(pipelines)
fitted_pipelines = {}
computations = []
X_train = self.X_train
y_train = self.y_train
# Apply sampling
if hasattr(self.data_splitter, "transform_sample"):
train_indices = self.data_splitter.transform_sample(X_train, y_train)
X_train = X_train.iloc[train_indices]
y_train = y_train.iloc[train_indices]
for pipeline in pipelines:
computations.append(self._engine.submit_training_job(self.automl_config, pipeline, X_train, y_train))
while computations:
computation = computations.pop(0)
if computation.done():
try:
fitted_pipeline = computation.get_result()
fitted_pipelines[fitted_pipeline.name] = fitted_pipeline
except Exception as e:
logger.error(f'Train error for {pipeline.name}: {str(e)}')
tb = traceback.format_tb(sys.exc_info()[2])
logger.error("Traceback:")
logger.error("\n".join(tb))
else:
computations.append(computation)
return fitted_pipelines
def __init__(self,
X_train=None,
y_train=None,
problem_type=None,
objective='auto',
max_iterations=None,
max_time=None,
patience=None,
tolerance=None,
data_splitter=None,
allowed_pipelines=None,
allowed_model_families=None,
start_iteration_callback=None,
add_result_callback=None,
error_callback=None,
additional_objectives=None,
random_state=None,
random_seed=0,
n_jobs=-1,
tuner_class=None,
optimize_thresholds=False,
ensembling=False,
max_batches=None,
problem_configuration=None,
train_best_pipeline=True,
pipeline_parameters=None,
_ensembling_split_size=0.2,
_pipelines_per_batch=5):
"""Automated pipeline search
Arguments:
X_train (pd.DataFrame, ww.DataTable): The input training data of shape [n_samples, n_features]. Required.
y_train (pd.Series, ww.DataColumn): 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.
max_iterations (int): Maximum number of iterations to search. If max_iterations and
max_time is not set, then max_iterations will default to max_iterations of 5.
max_time (int, str): Maximum time to search for pipelines.
This will not start a new pipeline search after the duration
has elapsed. If it is an integer, then the time will be in seconds.
For strings, time can be specified as seconds, minutes, or hours.
patience (int): Number of iterations without improvement to stop search early. Must be positive.
If None, early stopping is disabled. Defaults to None.
tolerance (float): Minimum percentage difference to qualify as score improvement for early stopping.
Only applicable if patience is not None. Defaults to None.
allowed_pipelines (list(class)): A list of PipelineBase subclasses indicating the pipelines allowed in the search.
The default of None indicates all pipelines for this problem type are allowed. Setting this field will cause
allowed_model_families to be ignored.
allowed_model_families (list(str, ModelFamily)): The model families to search. The default of None searches over all
model families. Run evalml.pipelines.components.utils.allowed_model_families("binary") to see options. Change `binary`
to `multiclass` or `regression` depending on the problem type. Note that if allowed_pipelines is provided,
this parameter will be ignored.
data_splitter (sklearn.model_selection.BaseCrossValidator): Data splitting method to use. Defaults to StratifiedKFold.
tuner_class: The tuner class to use. Defaults to SKOptTuner.
start_iteration_callback (callable): Function called before each pipeline training iteration.
Callback function takes three positional parameters: The pipeline class, the pipeline parameters, and the AutoMLSearch object.
add_result_callback (callable): Function called after each pipeline training iteration.
Callback function takes three positional parameters: A dictionary containing the training results for the new pipeline, an untrained_pipeline containing the parameters used during training, and the AutoMLSearch object.
error_callback (callable): Function called when `search()` errors and raises an Exception.
Callback function takes three positional parameters: the Exception raised, the traceback, and the AutoMLSearch object.
Must also accepts kwargs, so AutoMLSearch is able to pass along other appropriate parameters by default.
Defaults to None, which will call `log_error_callback`.
additional_objectives (list): Custom set of objectives to score on.
Will override default objectives for problem type if not empty.
random_state (int): Deprecated - use random_seed instead.
random_seed (int): Seed for the random number generator. Defaults to 0.
n_jobs (int or None): Non-negative integer describing level of parallelism used for pipelines.
None and 1 are equivalent. If set to -1, all CPUs are used. For n_jobs below -1, (n_cpus + 1 + n_jobs) are used.
ensembling (boolean): If True, runs ensembling in a separate batch after every allowed pipeline class has been iterated over.
If the number of unique pipelines to search over per batch is one, ensembling will not run. Defaults to False.
max_batches (int): The maximum number of batches of pipelines to search. Parameters max_time, and
max_iterations have precedence over stopping the search.
problem_configuration (dict, None): Additional parameters needed to configure the search. For example,
in time series problems, values should be passed in for the gap and max_delay variables.
train_best_pipeline (boolean): Whether or not to train the best pipeline before returning it. Defaults to True
_ensembling_split_size (float): The amount of the training data we'll set aside for training ensemble metalearners. Only used when ensembling is True.
Must be between 0 and 1, exclusive. Defaults to 0.2
_pipelines_per_batch (int): The number of pipelines to train for every batch after the first one.
The first batch will train a baseline pipline + one of each pipeline family allowed in the search.
"""
if X_train is None:
raise ValueError(
'Must specify training data as a 2d array using the X_train argument'
)
if y_train is None:
raise ValueError(
'Must specify training data target values as a 1d vector using the y_train argument'
)
try:
self.problem_type = handle_problem_types(problem_type)
except ValueError:
raise ValueError(
'choose one of (binary, multiclass, regression) as problem_type'
)
self.tuner_class = tuner_class or SKOptTuner
self.start_iteration_callback = start_iteration_callback
self.add_result_callback = add_result_callback
self.error_callback = error_callback or log_error_callback
self.data_splitter = data_splitter
self.optimize_thresholds = optimize_thresholds
self.ensembling = ensembling
if objective == 'auto':
objective = get_default_primary_search_objective(
self.problem_type.value)
objective = get_objective(objective, return_instance=False)
self.objective = self._validate_objective(objective)
if self.data_splitter is not None and not issubclass(
self.data_splitter.__class__, BaseCrossValidator):
raise ValueError("Not a valid data splitter")
if not objective.is_defined_for_problem_type(self.problem_type):
raise ValueError(
"Given objective {} is not compatible with a {} problem.".
format(self.objective.name, self.problem_type.value))
if additional_objectives is None:
additional_objectives = get_core_objectives(self.problem_type)
# if our main objective is part of default set of objectives for problem_type, remove it
existing_main_objective = next(
(obj for obj in additional_objectives
if obj.name == self.objective.name), None)
if existing_main_objective is not None:
additional_objectives.remove(existing_main_objective)
else:
additional_objectives = [
get_objective(o) for o in additional_objectives
]
additional_objectives = [
self._validate_objective(obj) for obj in additional_objectives
]
self.additional_objectives = additional_objectives
self.objective_name_to_class = {
o.name: o
for o in [self.objective] + self.additional_objectives
}
if not isinstance(max_time, (int, float, str, type(None))):
raise TypeError(
f"Parameter max_time must be a float, int, string or None. Received {type(max_time)} with value {str(max_time)}.."
)
if isinstance(max_time, (int, float)) and max_time < 0:
raise ValueError(
f"Parameter max_time must be None or non-negative. Received {max_time}."
)
if max_batches is not None and max_batches < 0:
raise ValueError(
f"Parameter max_batches must be None or non-negative. Received {max_batches}."
)
if max_iterations is not None and max_iterations < 0:
raise ValueError(
f"Parameter max_iterations must be None or non-negative. Received {max_iterations}."
)
self.max_time = convert_to_seconds(max_time) if isinstance(
max_time, str) else max_time
self.max_iterations = max_iterations
self.max_batches = max_batches
self._pipelines_per_batch = _pipelines_per_batch
if not self.max_iterations and not self.max_time and not self.max_batches:
self.max_batches = 1
logger.info("Using default limit of max_batches=1.\n")
if patience and (not isinstance(patience, int) or patience < 0):
raise ValueError(
"patience value must be a positive integer. Received {} instead"
.format(patience))
if tolerance and (tolerance > 1.0 or tolerance < 0.0):
raise ValueError(
"tolerance value must be a float between 0.0 and 1.0 inclusive. Received {} instead"
.format(tolerance))
self.patience = patience
self.tolerance = tolerance or 0.0
self._results = {
'pipeline_results': {},
'search_order': [],
'errors': []
}
self.random_seed = deprecate_arg("random_state", "random_seed",
random_state, random_seed)
self.n_jobs = n_jobs
self.plot = None
try:
self.plot = PipelineSearchPlots(self)
except ImportError:
logger.warning(
"Unable to import plotly; skipping pipeline search plotting\n")
self._data_check_results = None
self.allowed_pipelines = allowed_pipelines
self.allowed_model_families = allowed_model_families
self._automl_algorithm = None
self._start = 0.0
self._baseline_cv_scores = {}
self.show_batch_output = False
self._validate_problem_type()
self.problem_configuration = self._validate_problem_configuration(
problem_configuration)
self._train_best_pipeline = train_best_pipeline
self._best_pipeline = None
self._searched = False
self.X_train = infer_feature_types(X_train)
self.y_train = infer_feature_types(y_train)
self.ensembling_indices = None
default_data_splitter = make_data_splitter(
self.X_train,
self.y_train,
self.problem_type,
self.problem_configuration,
n_splits=3,
shuffle=True,
random_seed=self.random_seed)
self.data_splitter = self.data_splitter or default_data_splitter
self.pipeline_parameters = pipeline_parameters if pipeline_parameters is not None else {}
self.search_iteration_plot = None
self._interrupted = False
if self.allowed_pipelines is None:
logger.info("Generating pipelines to search over...")
allowed_estimators = get_estimators(self.problem_type,
self.allowed_model_families)
logger.debug(
f"allowed_estimators set to {[estimator.name for estimator in allowed_estimators]}"
)
self.allowed_pipelines = [
make_pipeline(self.X_train,
self.y_train,
estimator,
self.problem_type,
custom_hyperparameters=self.pipeline_parameters)
for estimator in allowed_estimators
]
if self.allowed_pipelines == []:
raise ValueError("No allowed pipelines to search")
check_all_pipeline_names_unique(self.allowed_pipelines)
run_ensembling = self.ensembling
if run_ensembling and len(self.allowed_pipelines) == 1:
logger.warning(
"Ensembling is set to True, but the number of unique pipelines is one, so ensembling will not run."
)
run_ensembling = False
if run_ensembling and self.max_iterations is not None:
# Baseline + first batch + each pipeline iteration + 1
first_ensembling_iteration = (
1 + len(self.allowed_pipelines) +
len(self.allowed_pipelines) * self._pipelines_per_batch + 1)
if self.max_iterations < first_ensembling_iteration:
run_ensembling = False
logger.warning(
f"Ensembling is set to True, but max_iterations is too small, so ensembling will not run. Set max_iterations >= {first_ensembling_iteration} to run ensembling."
)
else:
logger.info(
f"Ensembling will run at the {first_ensembling_iteration} iteration and every {len(self.allowed_pipelines) * self._pipelines_per_batch} iterations after that."
)
if self.max_batches and self.max_iterations is None:
self.show_batch_output = True
if run_ensembling:
ensemble_nth_batch = len(self.allowed_pipelines) + 1
num_ensemble_batches = (self.max_batches -
1) // ensemble_nth_batch
if num_ensemble_batches == 0:
run_ensembling = False
logger.warning(
f"Ensembling is set to True, but max_batches is too small, so ensembling will not run. Set max_batches >= {ensemble_nth_batch + 1} to run ensembling."
)
else:
logger.info(
f"Ensembling will run every {ensemble_nth_batch} batches."
)
self.max_iterations = (
1 + len(self.allowed_pipelines) +
self._pipelines_per_batch *
(self.max_batches - 1 - num_ensemble_batches) +
num_ensemble_batches)
else:
self.max_iterations = 1 + len(
self.allowed_pipelines) + (self._pipelines_per_batch *
(self.max_batches - 1))
if run_ensembling:
if not (0 < _ensembling_split_size < 1):
raise ValueError(
f"Ensembling split size must be between 0 and 1 exclusive, received {_ensembling_split_size}"
)
X_shape = ww.DataTable(np.arange(self.X_train.shape[0]))
_, ensembling_indices, _, _ = split_data(
X_shape,
self.y_train,
problem_type=self.problem_type,
test_size=_ensembling_split_size,
random_seed=self.random_seed)
self.ensembling_indices = ensembling_indices.to_dataframe(
)[0].tolist()
self._engine = SequentialEngine(
self.X_train,
self.y_train,
self.ensembling_indices,
self,
should_continue_callback=self._should_continue,
pre_evaluation_callback=self._pre_evaluation_callback,
post_evaluation_callback=self._post_evaluation_callback)
self.allowed_model_families = list(
set([p.model_family for p in (self.allowed_pipelines)]))
logger.debug(
f"allowed_pipelines set to {[pipeline.name for pipeline in self.allowed_pipelines]}"
)
logger.debug(
f"allowed_model_families set to {self.allowed_model_families}")
if len(self.problem_configuration):
pipeline_params = {
**{
'pipeline': self.problem_configuration
},
**self.pipeline_parameters
}
else:
pipeline_params = self.pipeline_parameters
self._automl_algorithm = IterativeAlgorithm(
max_iterations=self.max_iterations,
allowed_pipelines=self.allowed_pipelines,
tuner_class=self.tuner_class,
random_seed=self.random_seed,
n_jobs=self.n_jobs,
number_features=self.X_train.shape[1],
pipelines_per_batch=self._pipelines_per_batch,
ensembling=run_ensembling,
pipeline_params=pipeline_params)