o Z&ilX@sddlZddlZddlmZddlmZddlmZddl m Z ddl m Z ddl mZdd lmZmZmZmZmZd d ZGd d d ZdS)N) is_regressor) LabelEncoder)_safe_indexing)check_matplotlib_support)_get_response_values)_get_adapter_from_container)_is_arraylike_not_scalar _is_pandas_df _is_polars_df _num_featurescheck_is_fittedcCsTt|d}|rt|jdrd}t||dkr&t|r d}|Sgd}|S|}|S)aFValidate the response methods to be used with the fitted estimator. Parameters ---------- estimator : object Fitted estimator to check. response_method : {'auto', 'decision_function', 'predict_proba', 'predict'} Specifies whether to use :term:`decision_function`, :term:`predict_proba`, :term:`predict` as the target response. If set to 'auto', the response method is tried in the before mentioned order. class_of_interest : int, float, bool, str or None The class considered when plotting the decision. Cannot be None if multiclass and `response_method` is 'predict_proba' or 'decision_function'. .. versionadded:: 1.4 Returns ------- prediction_method : list of str or str The name or list of names of the response methods to use. classes_rzFMulti-label and multi-output multi-class classifiers are not supportedautopredict)decision_function predict_probar)hasattrr r ValueErrorr) estimatorresponse_methodclass_of_interestZ has_classesmsgprediction_methodrUC:\wamp64\www\opt\env\Lib\site-packages\sklearn/inspection/_plot/decision_boundary.py_check_boundary_response_methods rc @sNeZdZdZddddddZdddZed d dd dddddd d dZdS)DecisionBoundaryDisplayaDecisions boundary visualization. It is recommended to use :func:`~sklearn.inspection.DecisionBoundaryDisplay.from_estimator` to create a :class:`DecisionBoundaryDisplay`. All parameters are stored as attributes. Read more in the :ref:`User Guide `. For a detailed example comparing the decision boundaries of multinomial and one-vs-rest logistic regression, please see :ref:`sphx_glr_auto_examples_linear_model_plot_logistic_multinomial.py`. .. versionadded:: 1.1 Parameters ---------- xx0 : ndarray of shape (grid_resolution, grid_resolution) First output of :func:`meshgrid `. xx1 : ndarray of shape (grid_resolution, grid_resolution) Second output of :func:`meshgrid `. response : ndarray of shape (grid_resolution, grid_resolution) or (grid_resolution, grid_resolution, n_classes) Values of the response function. multiclass_colors : list of str or str, default=None Specifies how to color each class when plotting all classes of multiclass problem. Ignored for binary problems and multiclass problems when plotting a single prediction value per point. Possible inputs are: * list: list of Matplotlib `color `_ strings, of length `n_classes` * str: name of :class:`matplotlib.colors.Colormap` * None: 'viridis' colormap is used to sample colors Single color colormaps will be generated from the colors in the list or colors taken from the colormap and passed to the `cmap` parameter of the `plot_method`. .. versionadded:: 1.7 xlabel : str, default=None Default label to place on x axis. ylabel : str, default=None Default label to place on y axis. Attributes ---------- surface_ : matplotlib `QuadContourSet` or `QuadMesh` or list of such objects If `plot_method` is 'contour' or 'contourf', `surface_` is :class:`QuadContourSet `. If `plot_method` is 'pcolormesh', `surface_` is :class:`QuadMesh `. multiclass_colors_ : array of shape (n_classes, 4) Colors used to plot each class in multiclass problems. Only defined when `color_of_interest` is None. .. versionadded:: 1.7 ax_ : matplotlib Axes Axes with decision boundary. figure_ : matplotlib Figure Figure containing the decision boundary. See Also -------- DecisionBoundaryDisplay.from_estimator : Plot decision boundary given an estimator. Examples -------- >>> import matplotlib.pyplot as plt >>> import numpy as np >>> from sklearn.datasets import load_iris >>> from sklearn.inspection import DecisionBoundaryDisplay >>> from sklearn.tree import DecisionTreeClassifier >>> iris = load_iris() >>> feature_1, feature_2 = np.meshgrid( ... np.linspace(iris.data[:, 0].min(), iris.data[:, 0].max()), ... np.linspace(iris.data[:, 1].min(), iris.data[:, 1].max()) ... ) >>> grid = np.vstack([feature_1.ravel(), feature_2.ravel()]).T >>> tree = DecisionTreeClassifier().fit(iris.data[:, :2], iris.target) >>> y_pred = np.reshape(tree.predict(grid), feature_1.shape) >>> display = DecisionBoundaryDisplay( ... xx0=feature_1, xx1=feature_2, response=y_pred ... ) >>> display.plot() <...> >>> display.ax_.scatter( ... iris.data[:, 0], iris.data[:, 1], c=iris.target, edgecolor="black" ... ) <...> >>> plt.show() N)multiclass_colorsxlabelylabelcCs(||_||_||_||_||_||_dSNxx0xx1responserrr )selfr#r$r%rrr rrr__init__s  z DecisionBoundaryDisplay.__init__contourfc stdddlddlm}|dvrtd|d|dur$|\}}t||}|jjdkr>||j |j |jfi||_ n|jj d} d D]} | |vrXt d | d || =qF|jdusdt|jtr|jdurr| d krod nd} n|j} | d kr| d kr|d d jd| } nB| dkr| dkr|ddjd| } n.|| | } t| ds| tdd| } n| j} nt|jtrLJfdd|jD} ntd| |_|dkr|jjdd} ||j |j | fd| i||_ nCfddt| D}g|_ t|D]0\}} tjj|jdddd|f|jjdd|kd}|j ||j |j |fd| i|q|dus6|sE|dur>|jn|}| ||dusO|!s^|durW|j"n|}|#|||_$|j%|_&|S)aPlot visualization. Parameters ---------- plot_method : {'contourf', 'contour', 'pcolormesh'}, default='contourf' Plotting method to call when plotting the response. Please refer to the following matplotlib documentation for details: :func:`contourf `, :func:`contour `, :func:`pcolormesh `. ax : Matplotlib axes, default=None Axes object to plot on. If `None`, a new figure and axes is created. xlabel : str, default=None Overwrite the x-axis label. ylabel : str, default=None Overwrite the y-axis label. **kwargs : dict Additional keyword arguments to be passed to the `plot_method`. Returns ------- display: :class:`~sklearn.inspection.DecisionBoundaryDisplay` Object that stores computed values. DecisionBoundaryDisplay.plotrNr(contourZ pcolormeshz@plot_method must be 'contourf', 'contour', or 'pcolormesh'. Got instead.)cmapcolors'z' is ignored in favor of 'multiclass_colors' in the multiclass case when the response method is 'decision_function' or 'predict_proba'. Ztab10Z gist_rainbowZtab20r0csg|]}j|qSr)r0Zto_rgba).0colorZmplrr sz0DecisionBoundaryDisplay.plot..z,'multiclass_colors' must be a list or a str.r+Zaxisc s:g|]\}\}}}}jjd|d|||dfgqS)Z colormap_)?r:r:r:r:)r0ZLinearSegmentedColormap from_list)r5 class_idxrgb_r7rrr8 s )maskr/)'r matplotlibZmatplotlib.pyplotpyplotrZsubplotsgetattrr%ndimr#r$Zsurface_shapewarningswarnr isinstancestrZget_cmapr0rnplinspacelistZmulticlass_colors_Zargmax enumeratemaarrayappendZ get_xlabelrZ set_xlabelZ get_ylabelr Z set_ylabelZax_ZfigureZfigure_)r& plot_methodaxrr kwargsZpltr@Z plot_funcZ n_responseskwargr/r0Z class_mapZmulticlass_cmapsr<r%rr7rplots               r)dr:r) grid_resolutionepsrRrrrrr rSc # st|jdt|ddl|dkstd|d|dks(td|dd} || vr>d | }td |d |dt|}|d krNtd |d|dvr|durt|drt|j }d krt |t rt||kr|td|dt|dt fdd|Drtd|t |t r|jvrtd|t|dddt|ddd}}||||}}||||}}tt|||t|||\}}tj||f}t|st|rt|}|j|||jd}t|||}zt||||dd\}}}Wn!ty1}zdt |vr,td|d|j |d}~ww|dkrIt|drIt} |j | _ | |}|j!dkrV|j"|j#}n3t$|r_td|dur{t%|j |kd}!|dd|!fj"|j#}n|j"g|j#|j#d R}| durt|d!r|jdnd"} | durt|d!r|jdnd"} |||||| | d#}"|"j&d%| |d$| S)&aPlot decision boundary given an estimator. Read more in the :ref:`User Guide `. Parameters ---------- estimator : object Trained estimator used to plot the decision boundary. X : {array-like, sparse matrix, dataframe} of shape (n_samples, 2) Input data that should be only 2-dimensional. grid_resolution : int, default=100 Number of grid points to use for plotting decision boundary. Higher values will make the plot look nicer but be slower to render. eps : float, default=1.0 Extends the minimum and maximum values of X for evaluating the response function. plot_method : {'contourf', 'contour', 'pcolormesh'}, default='contourf' Plotting method to call when plotting the response. Please refer to the following matplotlib documentation for details: :func:`contourf `, :func:`contour `, :func:`pcolormesh `. response_method : {'auto', 'decision_function', 'predict_proba', 'predict'}, default='auto' Specifies whether to use :term:`decision_function`, :term:`predict_proba` or :term:`predict` as the target response. If set to 'auto', the response method is tried in the order as listed above. .. versionchanged:: 1.6 For multiclass problems, 'auto' no longer defaults to 'predict'. class_of_interest : int, float, bool or str, default=None The class to be plotted when `response_method` is 'predict_proba' or 'decision_function'. If None, `estimator.classes_[1]` is considered the positive class for binary classifiers. For multiclass classifiers, if None, all classes will be represented in the decision boundary plot; the class with the highest response value at each point is plotted. The color of each class can be set via `multiclass_colors`. .. versionadded:: 1.4 multiclass_colors : list of str, or str, default=None Specifies how to color each class when plotting multiclass 'predict_proba' or 'decision_function' and `class_of_interest` is None. Ignored in all other cases. Possible inputs are: * list: list of Matplotlib `color `_ strings, of length `n_classes` * str: name of :class:`matplotlib.colors.Colormap` * None: 'tab10' colormap is used to sample colors if the number of classes is less than or equal to 10, otherwise 'gist_rainbow' colormap. Single color colormaps will be generated from the colors in the list or colors taken from the colormap, and passed to the `cmap` parameter of the `plot_method`. .. versionadded:: 1.7 xlabel : str, default=None The label used for the x-axis. If `None`, an attempt is made to extract a label from `X` if it is a dataframe, otherwise an empty string is used. ylabel : str, default=None The label used for the y-axis. If `None`, an attempt is made to extract a label from `X` if it is a dataframe, otherwise an empty string is used. ax : Matplotlib axes, default=None Axes object to plot on. If `None`, a new figure and axes is created. **kwargs : dict Additional keyword arguments to be passed to the `plot_method`. Returns ------- display : :class:`~sklearn.inspection.DecisionBoundaryDisplay` Object that stores the result. See Also -------- DecisionBoundaryDisplay : Decision boundary visualization. sklearn.metrics.ConfusionMatrixDisplay.from_estimator : Plot the confusion matrix given an estimator, the data, and the label. sklearn.metrics.ConfusionMatrixDisplay.from_predictions : Plot the confusion matrix given the true and predicted labels. Examples -------- >>> import matplotlib.pyplot as plt >>> from sklearn.datasets import load_iris >>> from sklearn.linear_model import LogisticRegression >>> from sklearn.inspection import DecisionBoundaryDisplay >>> iris = load_iris() >>> X = iris.data[:, :2] >>> classifier = LogisticRegression().fit(X, iris.target) >>> disp = DecisionBoundaryDisplay.from_estimator( ... classifier, X, response_method="predict", ... xlabel=iris.feature_names[0], ylabel=iris.feature_names[1], ... alpha=0.5, ... ) >>> disp.ax_.scatter(X[:, 0], X[:, 1], c=iris.target, edgecolor="k") <...> >>> plt.show() z.from_estimatorrNr4z,grid_resolution must be greater than 1. Got r,z,eps must be greater than or equal to 0. Got r*z, zplot_method must be one of z. Got r-z#n_features must be equal to 2. Got )rrrrz[When 'multiclass_colors' is a list, it must be of the same length as 'estimator.classes_' (z), got: .c3s|] }j| VqdSr!)r0Z is_color_like)r5colr7rr s z9DecisionBoundaryDisplay.from_estimator..z[When 'multiclass_colors' is a list, it can only contain valid Matplotlib color names. Got: zSWhen 'multiclass_colors' is a string, it must be a valid Matplotlib colormap. Got: r9)columnsT)rZ pos_labelZreturn_response_method_usedzis not a valid labelzclass_of_interest=z+ is not a valid label: It should be one of rz)Multi-output regressors are not supportedr.r]r")rSrRr)'r__name__r rBrjoinr rlenrrIrManyrJrCZ colormapsrminmaxrKZmeshgridrLZc_Zravelr r rZcreate_containerr]rrrZ transformrEZreshaperFrZ flatnonzerorV)#clsrXrXrYrRrrrrr rSrTZpossible_plot_methodsZavailable_methodsZ num_featuresZ n_classesZx0x1Zx0_minZx0_maxZx1_minZx1_maxr#r$ZX_gridadapterrr%r@Zresponse_method_usedexcencoderZcol_idxdisplayrr7rfrom_estimator(s                 z&DecisionBoundaryDisplay.from_estimator)r(NNN)r_ __module__ __qualname____doc__r'rV classmethodrlrrrrr?s g xr)rGnumpyrKbaserZ preprocessingrutilsrZutils._optional_dependenciesrZutils._responserZutils._set_outputrZutils.validationr r r r r rrrrrrs       (