Evalml ================ .. py:module:: evalml .. autoapi-nested-parse:: EvalML. Subpackages ----------- .. toctree:: :titlesonly: :maxdepth: 3 automl/index.rst data_checks/index.rst demos/index.rst exceptions/index.rst model_family/index.rst model_understanding/index.rst objectives/index.rst pipelines/index.rst preprocessing/index.rst problem_types/index.rst tuners/index.rst utils/index.rst Package Contents ---------------- Classes Summary ~~~~~~~~~~~~~~~ .. autoapisummary:: evalml.AutoMLSearch Functions ~~~~~~~~~ .. autoapisummary:: :nosignatures: evalml.search evalml.search_iterative Contents ~~~~~~~~~~~~~~~~~~~ .. py:class:: AutoMLSearch(X_train=None, y_train=None, X_holdout=None, y_holdout=None, problem_type=None, objective='auto', max_iterations=None, max_time=None, patience=None, tolerance=None, data_splitter=None, allowed_component_graphs=None, allowed_model_families=None, features=None, start_iteration_callback=None, add_result_callback=None, error_callback=None, additional_objectives=None, alternate_thresholding_objective='F1', random_seed=0, n_jobs=-1, tuner_class=None, optimize_thresholds=True, ensembling=False, max_batches=None, problem_configuration=None, train_best_pipeline=True, search_parameters=None, sampler_method='auto', sampler_balanced_ratio=0.25, allow_long_running_models=False, _pipelines_per_batch=5, automl_algorithm='default', engine='sequential', verbose=False, timing=False, exclude_featurizers=None, holdout_set_size=0, use_recommendation=False, include_recommendation=None, exclude_recommendation=None) Automated Pipeline search. :param X_train: The input training data of shape [n_samples, n_features]. Required. :type X_train: pd.DataFrame :param y_train: The target training data of length [n_samples]. Required for supervised learning tasks. :type y_train: pd.Series :param X_holdout: The input holdout data of shape [n_samples, n_features]. :type X_holdout: pd.DataFrame :param y_holdout: The target holdout data of length [n_samples]. :type y_holdout: pd.Series :param problem_type: Type of supervised learning problem. See evalml.problem_types.ProblemType.all_problem_types for a full list. :type problem_type: str or ProblemTypes :param objective: 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. :type objective: str, ObjectiveBase :param max_iterations: 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. :type max_iterations: int :param max_time: 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. :type max_time: int, str :param patience: Number of iterations without improvement to stop search early. Must be positive. If None, early stopping is disabled. Defaults to None. :type patience: int :param tolerance: Minimum percentage difference to qualify as score improvement for early stopping. Only applicable if patience is not None. Defaults to None. :type tolerance: float :param allowed_component_graphs: A dictionary of lists or ComponentGraphs indicating the component graphs allowed in the search. The format should follow { "Name_0": [list_of_components], "Name_1": ComponentGraph(...) } The default of None indicates all pipeline component graphs for this problem type are allowed. Setting this field will cause allowed_model_families to be ignored. e.g. allowed_component_graphs = { "My_Graph": ["Imputer", "One Hot Encoder", "Random Forest Classifier"] } :type allowed_component_graphs: dict :param allowed_model_families: 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. :type allowed_model_families: list(str, ModelFamily) :param features: List of features to run DFS on AutoML pipelines. Defaults to None. Features will only be computed if the columns used by the feature exist in the search input and if the feature itself is not in search input. If features is an empty list, the DFS Transformer will not be included in pipelines. :type features: list :param data_splitter: Data splitting method to use. Defaults to StratifiedKFold. :type data_splitter: sklearn.model_selection.BaseCrossValidator :param tuner_class: The tuner class to use. Defaults to SKOptTuner. :param optimize_thresholds: Whether or not to optimize the binary pipeline threshold. Defaults to True. :type optimize_thresholds: bool :param start_iteration_callback: Function called before each pipeline training iteration. Callback function takes three positional parameters: The pipeline instance and the AutoMLSearch object. :type start_iteration_callback: callable :param add_result_callback: 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. :type add_result_callback: callable :param error_callback: 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`. :type error_callback: callable :param additional_objectives: Custom set of objectives to score on. Will override default objectives for problem type if not empty. :type additional_objectives: list :param alternate_thresholding_objective: The objective to use for thresholding binary classification pipelines if the main objective provided isn't tuneable. Defaults to F1. :type alternate_thresholding_objective: str :param random_seed: Seed for the random number generator. Defaults to 0. :type random_seed: int :param n_jobs: 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. :type n_jobs: int or None :param ensembling: 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. :type ensembling: boolean :param max_batches: The maximum number of batches of pipelines to search. Parameters max_time, and max_iterations have precedence over stopping the search. :type max_batches: int :param problem_configuration: Additional parameters needed to configure the search. For example, in time series problems, values should be passed in for the time_index, gap, forecast_horizon, and max_delay variables. :type problem_configuration: dict, None :param train_best_pipeline: Whether or not to train the best pipeline before returning it. Defaults to True. :type train_best_pipeline: boolean :param search_parameters: A dict of the hyperparameter ranges or pipeline parameters used to iterate over during search. Keys should consist of the component names and values should specify a singular value/list for pipeline parameters, or skopt.Space for hyperparameter ranges. In the example below, the Imputer parameters would be passed to the hyperparameter ranges, and the Label Encoder parameters would be used as the component parameter. e.g. search_parameters = { 'Imputer' : { 'numeric_impute_strategy': Categorical(['most_frequent', 'median']) }, 'Label Encoder': {'positive_label': True} } :type search_parameters: dict :param sampler_method: The data sampling component to use in the pipelines if the problem type is classification and the target balance is smaller than the sampler_balanced_ratio. Either 'auto', which will use our preferred sampler for the data, 'Undersampler', 'Oversampler', or None. Defaults to 'auto'. :type sampler_method: str :param sampler_balanced_ratio: The minority:majority class ratio that we consider balanced, so a 1:4 ratio would be equal to 0.25. If the class balance is larger than this provided value, then we will not add a sampler since the data is then considered balanced. Overrides the `sampler_ratio` of the samplers. Defaults to 0.25. :type sampler_balanced_ratio: float :param allow_long_running_models: Whether or not to allow longer-running models for large multiclass problems. If False and no pipelines, component graphs, or model families are provided, AutoMLSearch will not use Elastic Net or XGBoost when there are more than 75 multiclass targets and will not use CatBoost when there are more than 150 multiclass targets. Defaults to False. :type allow_long_running_models: bool :param _ensembling_split_size: 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 :type _ensembling_split_size: float :param _pipelines_per_batch: 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. :type _pipelines_per_batch: int :param automl_algorithm: The automl algorithm to use. Currently the two choices are 'iterative' and 'default'. Defaults to `default`. :type automl_algorithm: str :param engine: The engine instance used to evaluate pipelines. Dask or concurrent.futures engines can also be chosen by providing a string from the list ["sequential", "cf_threaded", "cf_process", "dask_threaded", "dask_process"]. If a parallel engine is selected this way, the maximum amount of parallelism, as determined by the engine, will be used. Defaults to "sequential". :type engine: EngineBase or str :param verbose: Whether or not to display semi-real-time updates to stdout while search is running. Defaults to False. :type verbose: boolean :param timing: Whether or not to write pipeline search times to the logger. Defaults to False. :type timing: boolean :param exclude_featurizers: A list of featurizer components to exclude from the pipelines built by search. Valid options are "DatetimeFeaturizer", "EmailFeaturizer", "URLFeaturizer", "NaturalLanguageFeaturizer", "TimeSeriesFeaturizer" :type exclude_featurizers: list[str] :param holdout_set_size: The size of the holdout set that AutoML search will take for datasets larger than 500 rows. If set to 0, holdout set will not be taken regardless of number of rows. Must be between 0 and 1, exclusive. Defaults to 0.1. :type holdout_set_size: float :param use_recommendation: Whether or not to use a recommendation score to rank pipelines instead of optimization objective. Defaults to False. :type use_recommendation: bool :param include_recommendation: A list of objectives to include beyond the defaults in the recommendation score. Defaults to None. :type include_recommendation: list[str] :param exclude_recommendation: A list of objectives to exclude from the defaults in the recommendation score. Defaults to None. :type exclude_recommendation: list[str] **Methods** .. autoapisummary:: :nosignatures: evalml.AutoMLSearch.add_to_rankings evalml.AutoMLSearch.best_pipeline evalml.AutoMLSearch.close_engine evalml.AutoMLSearch.describe_pipeline evalml.AutoMLSearch.full_rankings evalml.AutoMLSearch.get_ensembler_input_pipelines evalml.AutoMLSearch.get_pipeline evalml.AutoMLSearch.get_recommendation_scores evalml.AutoMLSearch.load evalml.AutoMLSearch.plot evalml.AutoMLSearch.rankings evalml.AutoMLSearch.results evalml.AutoMLSearch.save evalml.AutoMLSearch.score_pipelines evalml.AutoMLSearch.search evalml.AutoMLSearch.train_pipelines .. py:method:: add_to_rankings(self, pipeline) Fits and evaluates a given pipeline then adds the results to the automl rankings with the requirement that automl search has been run. :param pipeline: pipeline to train and evaluate. :type pipeline: PipelineBase .. py:method:: best_pipeline(self) :property: Returns a trained instance of the best pipeline and parameters found during automl search. If `train_best_pipeline` is set to False, returns an untrained pipeline instance. :returns: A trained instance of the best pipeline and parameters found during automl search. If `train_best_pipeline` is set to False, returns an untrained pipeline instance. :rtype: PipelineBase :raises PipelineNotFoundError: If this is called before .search() is called. .. py:method:: close_engine(self) Function to explicitly close the engine, client, parallel resources. .. py:method:: describe_pipeline(self, pipeline_id, return_dict=False) Describe a pipeline. :param pipeline_id: pipeline to describe :type pipeline_id: int :param return_dict: If True, return dictionary of information about pipeline. Defaults to False. :type return_dict: bool :returns: Description of specified pipeline. Includes information such as type of pipeline components, problem, training time, cross validation, etc. :raises PipelineNotFoundError: If pipeline_id is not a valid ID. .. py:method:: full_rankings(self) :property: Returns a pandas.DataFrame with scoring results from all pipelines searched. .. py:method:: get_ensembler_input_pipelines(self, ensemble_pipeline_id) Returns a list of input pipeline IDs given an ensembler pipeline ID. :param ensemble_pipeline_id: Ensemble pipeline ID to get input pipeline IDs from. :type ensemble_pipeline_id: id :returns: A list of ensemble input pipeline IDs. :rtype: list[int] :raises ValueError: If `ensemble_pipeline_id` does not correspond to a valid ensemble pipeline ID. .. py:method:: get_pipeline(self, pipeline_id) Given the ID of a pipeline training result, returns an untrained instance of the specified pipeline initialized with the parameters used to train that pipeline during automl search. :param pipeline_id: Pipeline to retrieve. :type pipeline_id: int :returns: Untrained pipeline instance associated with the provided ID. :rtype: PipelineBase :raises PipelineNotFoundError: if pipeline_id is not a valid ID. .. py:method:: get_recommendation_scores(self, priority=None, custom_weights=None, use_pipeline_names=False) Calculates recommendation scores for all pipelines in the search results. :param priority: An optional name of a priority objective that should be given heavier weight (of 0.5) than the other objectives contributing to the score. Defaults to None, where all objectives are weighted equally. :type priority: str :param custom_weights: A dictionary mapping objective names to corresponding weights between 0 and 1. Should not be used at the same time as prioritized_objective. Defaults to None. :type custom_weights: dict[str,float] :param use_pipeline_names: Whether or not to return the pipeline names instead of ids as the keys to the recommendation score dictionary. Defaults to False. :type use_pipeline_names: bool :returns: A dictionary mapping pipeline IDs to recommendation scores .. py:method:: load(file_path, pickle_type='cloudpickle') :staticmethod: Loads AutoML object at file path. :param file_path: Location to find file to load :type file_path: str :param pickle_type: The pickling library to use. Currently not used since the standard pickle library can handle cloudpickles. :type pickle_type: {"pickle", "cloudpickle"} :returns: AutoSearchBase object .. py:method:: plot(self) :property: Return an instance of the plot with the latest scores. .. py:method:: rankings(self) :property: Returns a pandas.DataFrame with scoring results from the highest-scoring set of parameters used with each pipeline. .. py:method:: results(self) :property: Class that allows access to a copy of the results from `automl_search`. :returns: Dictionary containing `pipeline_results`, a dict with results from each pipeline, and `search_order`, a list describing the order the pipelines were searched. :rtype: dict .. py:method:: save(self, file_path, pickle_type='cloudpickle', pickle_protocol=cloudpickle.DEFAULT_PROTOCOL) Saves AutoML object at file path. :param file_path: Location to save file. :type file_path: str :param pickle_type: The pickling library to use. :type pickle_type: {"pickle", "cloudpickle"} :param pickle_protocol: The pickle data stream format. :type pickle_protocol: int :raises ValueError: If pickle_type is not "pickle" or "cloudpickle". .. py:method:: score_pipelines(self, pipelines, X_holdout, y_holdout, objectives) Score a list of pipelines on the given holdout data. :param pipelines: List of pipelines to train. :type pipelines: list[PipelineBase] :param X_holdout: Holdout features. :type X_holdout: pd.DataFrame :param y_holdout: Holdout targets for scoring. :type y_holdout: pd.Series :param objectives: Objectives used for scoring. :type objectives: list[str], list[ObjectiveBase] :returns: 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. :rtype: dict[str, Dict[str, float]] .. py:method:: search(self, interactive_plot=True) Find the best pipeline for the data set. :param interactive_plot: Shows an iteration vs. score plot in Jupyter notebook. Disabled by default in non-Jupyter enviroments. :type interactive_plot: boolean, True :raises AutoMLSearchException: If all pipelines in the current AutoML batch produced a score of np.nan on the primary objective. :returns: Dictionary keyed by batch number that maps to the timings for pipelines run in that batch, as well as the total time for each batch. Pipelines within a batch are labeled by pipeline name. :rtype: Dict[int, Dict[str, Timestamp]] .. py:method:: 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. :param pipelines: List of pipelines to train. :type pipelines: list[PipelineBase] :returns: 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. :rtype: Dict[str, PipelineBase] .. py:function:: search(X_train=None, y_train=None, problem_type=None, objective='auto', mode='fast', max_time=None, patience=None, tolerance=None, problem_configuration=None, n_splits=3, verbose=False, timing=False) 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. :param X_train: The input training data of shape [n_samples, n_features]. Required. :type X_train: pd.DataFrame :param y_train: The target training data of length [n_samples]. Required for supervised learning tasks. :type y_train: pd.Series :param problem_type: Type of supervised learning problem. See evalml.problem_types.ProblemType.all_problem_types for a full list. :type problem_type: str or ProblemTypes :param objective: 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. :type objective: str, ObjectiveBase :param mode: mode for DefaultAlgorithm. There are two modes: fast and long, where fast is a subset of long. Please look at DefaultAlgorithm for more details. :type mode: str :param max_time: 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. :type max_time: int, str :param patience: Number of iterations without improvement to stop search early. Must be positive. If None, early stopping is disabled. Defaults to None. :type patience: int :param tolerance: Minimum percentage difference to qualify as score improvement for early stopping. Only applicable if patience is not None. Defaults to None. :type tolerance: float :param problem_configuration: Additional parameters needed to configure the search. For example, in time series problems, values should be passed in for the time_index, gap, forecast_horizon, and max_delay variables. :type problem_configuration: dict :param n_splits: Number of splits to use with the default data splitter. :type n_splits: int :param verbose: Whether or not to display semi-real-time updates to stdout while search is running. Defaults to False. :type verbose: boolean :param timing: Whether or not to write pipeline search times to the logger. Defaults to False. :type timing: boolean :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. :rtype: (AutoMLSearch, dict) :raises ValueError: If search configuration is not valid. .. py:function:: search_iterative(X_train=None, y_train=None, problem_type=None, objective='auto', problem_configuration=None, n_splits=3, timing=False, **kwargs) 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. :param X_train: The input training data of shape [n_samples, n_features]. Required. :type X_train: pd.DataFrame :param y_train: The target training data of length [n_samples]. Required for supervised learning tasks. :type y_train: pd.Series :param problem_type: Type of supervised learning problem. See evalml.problem_types.ProblemType.all_problem_types for a full list. :type problem_type: str or ProblemTypes :param objective: 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. :type objective: str, ObjectiveBase :param problem_configuration: Additional parameters needed to configure the search. For example, in time series problems, values should be passed in for the time_index, gap, forecast_horizon, and max_delay variables. :type problem_configuration: dict :param n_splits: Number of splits to use with the default data splitter. :type n_splits: int :param timing: Whether or not to write pipeline search times to the logger. Defaults to False. :type timing: boolean :param \*\*kwargs: 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. :rtype: (AutoMLSearch, dict) :raises ValueError: If the search configuration is invalid.