885 lines
28 KiB
Python
885 lines
28 KiB
Python
import numpy as np
|
|
from scipy.stats.mstats import mquantiles
|
|
|
|
import pytest
|
|
from numpy.testing import assert_allclose
|
|
|
|
from sklearn.datasets import load_diabetes
|
|
from sklearn.datasets import load_iris
|
|
from sklearn.datasets import make_classification, make_regression
|
|
from sklearn.ensemble import GradientBoostingRegressor
|
|
from sklearn.ensemble import GradientBoostingClassifier
|
|
from sklearn.linear_model import LinearRegression
|
|
from sklearn.utils._testing import _convert_container
|
|
|
|
from sklearn.inspection import plot_partial_dependence as plot_partial_dependence_func
|
|
from sklearn.inspection import PartialDependenceDisplay
|
|
|
|
|
|
# TODO: Remove when https://github.com/numpy/numpy/issues/14397 is resolved
|
|
pytestmark = pytest.mark.filterwarnings(
|
|
"ignore:In future, it will be an error for 'np.bool_':DeprecationWarning:"
|
|
"matplotlib.*",
|
|
# TODO: Remove in 1.2 and convert test to only use
|
|
# PartialDependenceDisplay.from_estimator
|
|
"ignore:Function plot_partial_dependence is deprecated",
|
|
)
|
|
|
|
|
|
# TODO: Remove in 1.2 and convert test to only use
|
|
# PartialDependenceDisplay.from_estimator
|
|
@pytest.fixture(
|
|
params=[PartialDependenceDisplay.from_estimator, plot_partial_dependence_func],
|
|
ids=["from_estimator", "function"],
|
|
)
|
|
def plot_partial_dependence(request):
|
|
return request.param
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def diabetes():
|
|
return load_diabetes()
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def clf_diabetes(diabetes):
|
|
clf = GradientBoostingRegressor(n_estimators=10, random_state=1)
|
|
clf.fit(diabetes.data, diabetes.target)
|
|
return clf
|
|
|
|
|
|
def test_plot_partial_dependence_deprecation(pyplot, clf_diabetes, diabetes):
|
|
"""Check that plot_partial_dependence is deprecated"""
|
|
with pytest.warns(FutureWarning):
|
|
plot_partial_dependence_func(clf_diabetes, diabetes.data, [0])
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
@pytest.mark.parametrize("grid_resolution", [10, 20])
|
|
def test_plot_partial_dependence(
|
|
plot_partial_dependence, grid_resolution, pyplot, clf_diabetes, diabetes
|
|
):
|
|
# Test partial dependence plot function.
|
|
# Use columns 0 & 2 as 1 is not quantitative (sex)
|
|
feature_names = diabetes.feature_names
|
|
disp = plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
[0, 2, (0, 2)],
|
|
grid_resolution=grid_resolution,
|
|
feature_names=feature_names,
|
|
contour_kw={"cmap": "jet"},
|
|
)
|
|
fig = pyplot.gcf()
|
|
axs = fig.get_axes()
|
|
assert disp.figure_ is fig
|
|
assert len(axs) == 4
|
|
|
|
assert disp.bounding_ax_ is not None
|
|
assert disp.axes_.shape == (1, 3)
|
|
assert disp.lines_.shape == (1, 3)
|
|
assert disp.contours_.shape == (1, 3)
|
|
assert disp.deciles_vlines_.shape == (1, 3)
|
|
assert disp.deciles_hlines_.shape == (1, 3)
|
|
|
|
assert disp.lines_[0, 2] is None
|
|
assert disp.contours_[0, 0] is None
|
|
assert disp.contours_[0, 1] is None
|
|
|
|
# deciles lines: always show on xaxis, only show on yaxis if 2-way PDP
|
|
for i in range(3):
|
|
assert disp.deciles_vlines_[0, i] is not None
|
|
assert disp.deciles_hlines_[0, 0] is None
|
|
assert disp.deciles_hlines_[0, 1] is None
|
|
assert disp.deciles_hlines_[0, 2] is not None
|
|
|
|
assert disp.features == [(0,), (2,), (0, 2)]
|
|
assert np.all(disp.feature_names == feature_names)
|
|
assert len(disp.deciles) == 2
|
|
for i in [0, 2]:
|
|
assert_allclose(
|
|
disp.deciles[i],
|
|
mquantiles(diabetes.data[:, i], prob=np.arange(0.1, 1.0, 0.1)),
|
|
)
|
|
|
|
single_feature_positions = [(0, (0, 0)), (2, (0, 1))]
|
|
expected_ylabels = ["Partial dependence", ""]
|
|
|
|
for i, (feat_col, pos) in enumerate(single_feature_positions):
|
|
ax = disp.axes_[pos]
|
|
assert ax.get_ylabel() == expected_ylabels[i]
|
|
assert ax.get_xlabel() == diabetes.feature_names[feat_col]
|
|
assert_allclose(ax.get_ylim(), disp.pdp_lim[1])
|
|
|
|
line = disp.lines_[pos]
|
|
|
|
avg_preds = disp.pd_results[i]
|
|
assert avg_preds.average.shape == (1, grid_resolution)
|
|
target_idx = disp.target_idx
|
|
|
|
line_data = line.get_data()
|
|
assert_allclose(line_data[0], avg_preds["values"][0])
|
|
assert_allclose(line_data[1], avg_preds.average[target_idx].ravel())
|
|
|
|
# two feature position
|
|
ax = disp.axes_[0, 2]
|
|
coutour = disp.contours_[0, 2]
|
|
expected_levels = np.linspace(*disp.pdp_lim[2], num=8)
|
|
assert_allclose(coutour.levels, expected_levels)
|
|
assert coutour.get_cmap().name == "jet"
|
|
assert ax.get_xlabel() == diabetes.feature_names[0]
|
|
assert ax.get_ylabel() == diabetes.feature_names[2]
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
@pytest.mark.parametrize(
|
|
"kind, subsample, shape",
|
|
[
|
|
("average", None, (1, 3)),
|
|
("individual", None, (1, 3, 442)),
|
|
("both", None, (1, 3, 443)),
|
|
("individual", 50, (1, 3, 50)),
|
|
("both", 50, (1, 3, 51)),
|
|
("individual", 0.5, (1, 3, 221)),
|
|
("both", 0.5, (1, 3, 222)),
|
|
],
|
|
)
|
|
def test_plot_partial_dependence_kind(
|
|
plot_partial_dependence, pyplot, kind, subsample, shape, clf_diabetes, diabetes
|
|
):
|
|
disp = plot_partial_dependence(
|
|
clf_diabetes, diabetes.data, [0, 1, 2], kind=kind, subsample=subsample
|
|
)
|
|
|
|
assert disp.axes_.shape == (1, 3)
|
|
assert disp.lines_.shape == shape
|
|
assert disp.contours_.shape == (1, 3)
|
|
|
|
assert disp.contours_[0, 0] is None
|
|
assert disp.contours_[0, 1] is None
|
|
assert disp.contours_[0, 2] is None
|
|
|
|
assert disp.kind == kind
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
@pytest.mark.parametrize(
|
|
"input_type, feature_names_type",
|
|
[
|
|
("dataframe", None),
|
|
("dataframe", "list"),
|
|
("list", "list"),
|
|
("array", "list"),
|
|
("dataframe", "array"),
|
|
("list", "array"),
|
|
("array", "array"),
|
|
("dataframe", "series"),
|
|
("list", "series"),
|
|
("array", "series"),
|
|
("dataframe", "index"),
|
|
("list", "index"),
|
|
("array", "index"),
|
|
],
|
|
)
|
|
def test_plot_partial_dependence_str_features(
|
|
plot_partial_dependence,
|
|
pyplot,
|
|
clf_diabetes,
|
|
diabetes,
|
|
input_type,
|
|
feature_names_type,
|
|
):
|
|
if input_type == "dataframe":
|
|
pd = pytest.importorskip("pandas")
|
|
X = pd.DataFrame(diabetes.data, columns=diabetes.feature_names)
|
|
elif input_type == "list":
|
|
X = diabetes.data.tolist()
|
|
else:
|
|
X = diabetes.data
|
|
|
|
if feature_names_type is None:
|
|
feature_names = None
|
|
else:
|
|
feature_names = _convert_container(diabetes.feature_names, feature_names_type)
|
|
|
|
grid_resolution = 25
|
|
# check with str features and array feature names and single column
|
|
disp = plot_partial_dependence(
|
|
clf_diabetes,
|
|
X,
|
|
[("age", "bmi"), "bmi"],
|
|
grid_resolution=grid_resolution,
|
|
feature_names=feature_names,
|
|
n_cols=1,
|
|
line_kw={"alpha": 0.8},
|
|
)
|
|
fig = pyplot.gcf()
|
|
axs = fig.get_axes()
|
|
assert len(axs) == 3
|
|
|
|
assert disp.figure_ is fig
|
|
assert disp.axes_.shape == (2, 1)
|
|
assert disp.lines_.shape == (2, 1)
|
|
assert disp.contours_.shape == (2, 1)
|
|
assert disp.deciles_vlines_.shape == (2, 1)
|
|
assert disp.deciles_hlines_.shape == (2, 1)
|
|
|
|
assert disp.lines_[0, 0] is None
|
|
assert disp.deciles_vlines_[0, 0] is not None
|
|
assert disp.deciles_hlines_[0, 0] is not None
|
|
assert disp.contours_[1, 0] is None
|
|
assert disp.deciles_hlines_[1, 0] is None
|
|
assert disp.deciles_vlines_[1, 0] is not None
|
|
|
|
# line
|
|
ax = disp.axes_[1, 0]
|
|
assert ax.get_xlabel() == "bmi"
|
|
assert ax.get_ylabel() == "Partial dependence"
|
|
|
|
line = disp.lines_[1, 0]
|
|
avg_preds = disp.pd_results[1]
|
|
target_idx = disp.target_idx
|
|
assert line.get_alpha() == 0.8
|
|
|
|
line_data = line.get_data()
|
|
assert_allclose(line_data[0], avg_preds["values"][0])
|
|
assert_allclose(line_data[1], avg_preds.average[target_idx].ravel())
|
|
|
|
# contour
|
|
ax = disp.axes_[0, 0]
|
|
coutour = disp.contours_[0, 0]
|
|
expect_levels = np.linspace(*disp.pdp_lim[2], num=8)
|
|
assert_allclose(coutour.levels, expect_levels)
|
|
assert ax.get_xlabel() == "age"
|
|
assert ax.get_ylabel() == "bmi"
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
def test_plot_partial_dependence_custom_axes(
|
|
plot_partial_dependence, pyplot, clf_diabetes, diabetes
|
|
):
|
|
grid_resolution = 25
|
|
fig, (ax1, ax2) = pyplot.subplots(1, 2)
|
|
disp = plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
["age", ("age", "bmi")],
|
|
grid_resolution=grid_resolution,
|
|
feature_names=diabetes.feature_names,
|
|
ax=[ax1, ax2],
|
|
)
|
|
assert fig is disp.figure_
|
|
assert disp.bounding_ax_ is None
|
|
assert disp.axes_.shape == (2,)
|
|
assert disp.axes_[0] is ax1
|
|
assert disp.axes_[1] is ax2
|
|
|
|
ax = disp.axes_[0]
|
|
assert ax.get_xlabel() == "age"
|
|
assert ax.get_ylabel() == "Partial dependence"
|
|
|
|
line = disp.lines_[0]
|
|
avg_preds = disp.pd_results[0]
|
|
target_idx = disp.target_idx
|
|
|
|
line_data = line.get_data()
|
|
assert_allclose(line_data[0], avg_preds["values"][0])
|
|
assert_allclose(line_data[1], avg_preds.average[target_idx].ravel())
|
|
|
|
# contour
|
|
ax = disp.axes_[1]
|
|
coutour = disp.contours_[1]
|
|
expect_levels = np.linspace(*disp.pdp_lim[2], num=8)
|
|
assert_allclose(coutour.levels, expect_levels)
|
|
assert ax.get_xlabel() == "age"
|
|
assert ax.get_ylabel() == "bmi"
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
@pytest.mark.parametrize(
|
|
"kind, lines", [("average", 1), ("individual", 442), ("both", 443)]
|
|
)
|
|
def test_plot_partial_dependence_passing_numpy_axes(
|
|
plot_partial_dependence, pyplot, clf_diabetes, diabetes, kind, lines
|
|
):
|
|
grid_resolution = 25
|
|
feature_names = diabetes.feature_names
|
|
disp1 = plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
["age", "bmi"],
|
|
kind=kind,
|
|
grid_resolution=grid_resolution,
|
|
feature_names=feature_names,
|
|
)
|
|
assert disp1.axes_.shape == (1, 2)
|
|
assert disp1.axes_[0, 0].get_ylabel() == "Partial dependence"
|
|
assert disp1.axes_[0, 1].get_ylabel() == ""
|
|
assert len(disp1.axes_[0, 0].get_lines()) == lines
|
|
assert len(disp1.axes_[0, 1].get_lines()) == lines
|
|
|
|
lr = LinearRegression()
|
|
lr.fit(diabetes.data, diabetes.target)
|
|
|
|
disp2 = plot_partial_dependence(
|
|
lr,
|
|
diabetes.data,
|
|
["age", "bmi"],
|
|
kind=kind,
|
|
grid_resolution=grid_resolution,
|
|
feature_names=feature_names,
|
|
ax=disp1.axes_,
|
|
)
|
|
|
|
assert np.all(disp1.axes_ == disp2.axes_)
|
|
assert len(disp2.axes_[0, 0].get_lines()) == 2 * lines
|
|
assert len(disp2.axes_[0, 1].get_lines()) == 2 * lines
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
@pytest.mark.parametrize("nrows, ncols", [(2, 2), (3, 1)])
|
|
def test_plot_partial_dependence_incorrent_num_axes(
|
|
plot_partial_dependence, pyplot, clf_diabetes, diabetes, nrows, ncols
|
|
):
|
|
grid_resolution = 5
|
|
fig, axes = pyplot.subplots(nrows, ncols)
|
|
axes_formats = [list(axes.ravel()), tuple(axes.ravel()), axes]
|
|
|
|
msg = "Expected ax to have 2 axes, got {}".format(nrows * ncols)
|
|
|
|
disp = plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
["age", "bmi"],
|
|
grid_resolution=grid_resolution,
|
|
feature_names=diabetes.feature_names,
|
|
)
|
|
|
|
for ax_format in axes_formats:
|
|
with pytest.raises(ValueError, match=msg):
|
|
plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
["age", "bmi"],
|
|
grid_resolution=grid_resolution,
|
|
feature_names=diabetes.feature_names,
|
|
ax=ax_format,
|
|
)
|
|
|
|
# with axes object
|
|
with pytest.raises(ValueError, match=msg):
|
|
disp.plot(ax=ax_format)
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
def test_plot_partial_dependence_with_same_axes(
|
|
plot_partial_dependence, pyplot, clf_diabetes, diabetes
|
|
):
|
|
# The first call to plot_partial_dependence will create two new axes to
|
|
# place in the space of the passed in axes, which results in a total of
|
|
# three axes in the figure.
|
|
# Currently the API does not allow for the second call to
|
|
# plot_partial_dependence to use the same axes again, because it will
|
|
# create two new axes in the space resulting in five axes. To get the
|
|
# expected behavior one needs to pass the generated axes into the second
|
|
# call:
|
|
# disp1 = plot_partial_dependence(...)
|
|
# disp2 = plot_partial_dependence(..., ax=disp1.axes_)
|
|
|
|
grid_resolution = 25
|
|
fig, ax = pyplot.subplots()
|
|
plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
["age", "bmi"],
|
|
grid_resolution=grid_resolution,
|
|
feature_names=diabetes.feature_names,
|
|
ax=ax,
|
|
)
|
|
|
|
msg = (
|
|
"The ax was already used in another plot function, please set "
|
|
"ax=display.axes_ instead"
|
|
)
|
|
|
|
with pytest.raises(ValueError, match=msg):
|
|
plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
["age", "bmi"],
|
|
grid_resolution=grid_resolution,
|
|
feature_names=diabetes.feature_names,
|
|
ax=ax,
|
|
)
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
def test_plot_partial_dependence_feature_name_reuse(
|
|
plot_partial_dependence, pyplot, clf_diabetes, diabetes
|
|
):
|
|
# second call to plot does not change the feature names from the first
|
|
# call
|
|
|
|
feature_names = diabetes.feature_names
|
|
disp = plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
[0, 1],
|
|
grid_resolution=10,
|
|
feature_names=feature_names,
|
|
)
|
|
|
|
plot_partial_dependence(
|
|
clf_diabetes, diabetes.data, [0, 1], grid_resolution=10, ax=disp.axes_
|
|
)
|
|
|
|
for i, ax in enumerate(disp.axes_.ravel()):
|
|
assert ax.get_xlabel() == feature_names[i]
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
def test_plot_partial_dependence_multiclass(plot_partial_dependence, pyplot):
|
|
grid_resolution = 25
|
|
clf_int = GradientBoostingClassifier(n_estimators=10, random_state=1)
|
|
iris = load_iris()
|
|
|
|
# Test partial dependence plot function on multi-class input.
|
|
clf_int.fit(iris.data, iris.target)
|
|
disp_target_0 = plot_partial_dependence(
|
|
clf_int, iris.data, [0, 1], target=0, grid_resolution=grid_resolution
|
|
)
|
|
assert disp_target_0.figure_ is pyplot.gcf()
|
|
assert disp_target_0.axes_.shape == (1, 2)
|
|
assert disp_target_0.lines_.shape == (1, 2)
|
|
assert disp_target_0.contours_.shape == (1, 2)
|
|
assert disp_target_0.deciles_vlines_.shape == (1, 2)
|
|
assert disp_target_0.deciles_hlines_.shape == (1, 2)
|
|
assert all(c is None for c in disp_target_0.contours_.flat)
|
|
assert disp_target_0.target_idx == 0
|
|
|
|
# now with symbol labels
|
|
target = iris.target_names[iris.target]
|
|
clf_symbol = GradientBoostingClassifier(n_estimators=10, random_state=1)
|
|
clf_symbol.fit(iris.data, target)
|
|
disp_symbol = plot_partial_dependence(
|
|
clf_symbol, iris.data, [0, 1], target="setosa", grid_resolution=grid_resolution
|
|
)
|
|
assert disp_symbol.figure_ is pyplot.gcf()
|
|
assert disp_symbol.axes_.shape == (1, 2)
|
|
assert disp_symbol.lines_.shape == (1, 2)
|
|
assert disp_symbol.contours_.shape == (1, 2)
|
|
assert disp_symbol.deciles_vlines_.shape == (1, 2)
|
|
assert disp_symbol.deciles_hlines_.shape == (1, 2)
|
|
assert all(c is None for c in disp_symbol.contours_.flat)
|
|
assert disp_symbol.target_idx == 0
|
|
|
|
for int_result, symbol_result in zip(
|
|
disp_target_0.pd_results, disp_symbol.pd_results
|
|
):
|
|
assert_allclose(int_result.average, symbol_result.average)
|
|
assert_allclose(int_result["values"], symbol_result["values"])
|
|
|
|
# check that the pd plots are different for another target
|
|
disp_target_1 = plot_partial_dependence(
|
|
clf_int, iris.data, [0, 1], target=1, grid_resolution=grid_resolution
|
|
)
|
|
target_0_data_y = disp_target_0.lines_[0, 0].get_data()[1]
|
|
target_1_data_y = disp_target_1.lines_[0, 0].get_data()[1]
|
|
assert any(target_0_data_y != target_1_data_y)
|
|
|
|
|
|
multioutput_regression_data = make_regression(n_samples=50, n_targets=2, random_state=0)
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
@pytest.mark.parametrize("target", [0, 1])
|
|
def test_plot_partial_dependence_multioutput(plot_partial_dependence, pyplot, target):
|
|
# Test partial dependence plot function on multi-output input.
|
|
X, y = multioutput_regression_data
|
|
clf = LinearRegression().fit(X, y)
|
|
|
|
grid_resolution = 25
|
|
disp = plot_partial_dependence(
|
|
clf, X, [0, 1], target=target, grid_resolution=grid_resolution
|
|
)
|
|
fig = pyplot.gcf()
|
|
axs = fig.get_axes()
|
|
assert len(axs) == 3
|
|
assert disp.target_idx == target
|
|
assert disp.bounding_ax_ is not None
|
|
|
|
positions = [(0, 0), (0, 1)]
|
|
expected_label = ["Partial dependence", ""]
|
|
|
|
for i, pos in enumerate(positions):
|
|
ax = disp.axes_[pos]
|
|
assert ax.get_ylabel() == expected_label[i]
|
|
assert ax.get_xlabel() == "{}".format(i)
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
def test_plot_partial_dependence_dataframe(
|
|
plot_partial_dependence, pyplot, clf_diabetes, diabetes
|
|
):
|
|
pd = pytest.importorskip("pandas")
|
|
df = pd.DataFrame(diabetes.data, columns=diabetes.feature_names)
|
|
|
|
grid_resolution = 25
|
|
|
|
plot_partial_dependence(
|
|
clf_diabetes,
|
|
df,
|
|
["bp", "s1"],
|
|
grid_resolution=grid_resolution,
|
|
feature_names=df.columns.tolist(),
|
|
)
|
|
|
|
|
|
dummy_classification_data = make_classification(random_state=0)
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
@pytest.mark.parametrize(
|
|
"data, params, err_msg",
|
|
[
|
|
(
|
|
multioutput_regression_data,
|
|
{"target": None, "features": [0]},
|
|
"target must be specified for multi-output",
|
|
),
|
|
(
|
|
multioutput_regression_data,
|
|
{"target": -1, "features": [0]},
|
|
r"target must be in \[0, n_tasks\]",
|
|
),
|
|
(
|
|
multioutput_regression_data,
|
|
{"target": 100, "features": [0]},
|
|
r"target must be in \[0, n_tasks\]",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": ["foobar"], "feature_names": None},
|
|
"Feature foobar not in feature_names",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": ["foobar"], "feature_names": ["abcd", "def"]},
|
|
"Feature foobar not in feature_names",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": [(1, 2, 3)]},
|
|
"Each entry in features must be either an int, ",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": [1, {}]},
|
|
"Each entry in features must be either an int, ",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": [tuple()]},
|
|
"Each entry in features must be either an int, ",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": [123], "feature_names": ["blahblah"]},
|
|
"All entries of features must be less than ",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": [0, 1, 2], "feature_names": ["a", "b", "a"]},
|
|
"feature_names should not contain duplicates",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": [1, 2], "kind": ["both"]},
|
|
"When `kind` is provided as a list of strings, it should contain",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": [1], "subsample": -1},
|
|
"When an integer, subsample=-1 should be positive.",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": [1], "subsample": 1.2},
|
|
r"When a floating-point, subsample=1.2 should be in the \(0, 1\) range",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": [1], "kind": "foo"},
|
|
"Values provided to `kind` must be one of",
|
|
),
|
|
(
|
|
dummy_classification_data,
|
|
{"features": [0, 1], "kind": ["foo", "individual"]},
|
|
"Values provided to `kind` must be one of",
|
|
),
|
|
],
|
|
)
|
|
def test_plot_partial_dependence_error(
|
|
plot_partial_dependence, pyplot, data, params, err_msg
|
|
):
|
|
X, y = data
|
|
estimator = LinearRegression().fit(X, y)
|
|
|
|
with pytest.raises(ValueError, match=err_msg):
|
|
plot_partial_dependence(estimator, X, **params)
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
@pytest.mark.parametrize(
|
|
"params, err_msg",
|
|
[
|
|
({"target": 4, "features": [0]}, "target not in est.classes_, got 4"),
|
|
({"target": None, "features": [0]}, "target must be specified for multi-class"),
|
|
(
|
|
{"target": 1, "features": [4.5]},
|
|
"Each entry in features must be either an int,",
|
|
),
|
|
],
|
|
)
|
|
def test_plot_partial_dependence_multiclass_error(
|
|
plot_partial_dependence, pyplot, params, err_msg
|
|
):
|
|
iris = load_iris()
|
|
clf = GradientBoostingClassifier(n_estimators=10, random_state=1)
|
|
clf.fit(iris.data, iris.target)
|
|
|
|
with pytest.raises(ValueError, match=err_msg):
|
|
plot_partial_dependence(clf, iris.data, **params)
|
|
|
|
|
|
def test_plot_partial_dependence_does_not_override_ylabel(
|
|
plot_partial_dependence, pyplot, clf_diabetes, diabetes
|
|
):
|
|
# Non-regression test to be sure to not override the ylabel if it has been
|
|
# See https://github.com/scikit-learn/scikit-learn/issues/15772
|
|
_, axes = pyplot.subplots(1, 2)
|
|
axes[0].set_ylabel("Hello world")
|
|
plot_partial_dependence(clf_diabetes, diabetes.data, [0, 1], ax=axes)
|
|
|
|
assert axes[0].get_ylabel() == "Hello world"
|
|
assert axes[1].get_ylabel() == "Partial dependence"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"kind, expected_shape",
|
|
[("average", (1, 2)), ("individual", (1, 2, 50)), ("both", (1, 2, 51))],
|
|
)
|
|
def test_plot_partial_dependence_subsampling(
|
|
plot_partial_dependence, pyplot, clf_diabetes, diabetes, kind, expected_shape
|
|
):
|
|
# check that the subsampling is properly working
|
|
# non-regression test for:
|
|
# https://github.com/scikit-learn/scikit-learn/pull/18359
|
|
matplotlib = pytest.importorskip("matplotlib")
|
|
grid_resolution = 25
|
|
feature_names = diabetes.feature_names
|
|
|
|
disp1 = plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
["age", "bmi"],
|
|
kind=kind,
|
|
grid_resolution=grid_resolution,
|
|
feature_names=feature_names,
|
|
subsample=50,
|
|
random_state=0,
|
|
)
|
|
|
|
assert disp1.lines_.shape == expected_shape
|
|
assert all(
|
|
[isinstance(line, matplotlib.lines.Line2D) for line in disp1.lines_.ravel()]
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"kind, line_kw, label",
|
|
[
|
|
("individual", {}, None),
|
|
("individual", {"label": "xxx"}, None),
|
|
("average", {}, None),
|
|
("average", {"label": "xxx"}, "xxx"),
|
|
("both", {}, "average"),
|
|
("both", {"label": "xxx"}, "xxx"),
|
|
],
|
|
)
|
|
def test_partial_dependence_overwrite_labels(
|
|
plot_partial_dependence,
|
|
pyplot,
|
|
clf_diabetes,
|
|
diabetes,
|
|
kind,
|
|
line_kw,
|
|
label,
|
|
):
|
|
"""Test that make sure that we can overwrite the label of the PDP plot"""
|
|
disp = plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
[0, 2],
|
|
grid_resolution=25,
|
|
feature_names=diabetes.feature_names,
|
|
kind=kind,
|
|
line_kw=line_kw,
|
|
)
|
|
|
|
for ax in disp.axes_.ravel():
|
|
if label is None:
|
|
assert ax.get_legend() is None
|
|
else:
|
|
legend_text = ax.get_legend().get_texts()
|
|
assert len(legend_text) == 1
|
|
assert legend_text[0].get_text() == label
|
|
|
|
|
|
def test_partial_dependence_kind_list(
|
|
plot_partial_dependence,
|
|
pyplot,
|
|
clf_diabetes,
|
|
diabetes,
|
|
):
|
|
"""Check that we can provide a list of strings to kind parameter."""
|
|
matplotlib = pytest.importorskip("matplotlib")
|
|
|
|
disp = plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
features=[0, 2, (1, 2)],
|
|
grid_resolution=20,
|
|
kind=["both", "both", "average"],
|
|
)
|
|
|
|
for idx in [0, 1]:
|
|
assert all(
|
|
[
|
|
isinstance(line, matplotlib.lines.Line2D)
|
|
for line in disp.lines_[0, idx].ravel()
|
|
]
|
|
)
|
|
assert disp.contours_[0, idx] is None
|
|
|
|
assert disp.contours_[0, 2] is not None
|
|
assert all([line is None for line in disp.lines_[0, 2].ravel()])
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"features, kind",
|
|
[
|
|
([0, 2, (1, 2)], "individual"),
|
|
([0, 2, (1, 2)], "both"),
|
|
([(0, 1), (0, 2), (1, 2)], "individual"),
|
|
([(0, 1), (0, 2), (1, 2)], "both"),
|
|
([0, 2, (1, 2)], ["individual", "individual", "individual"]),
|
|
([0, 2, (1, 2)], ["both", "both", "both"]),
|
|
],
|
|
)
|
|
def test_partial_dependence_kind_error(
|
|
plot_partial_dependence,
|
|
pyplot,
|
|
clf_diabetes,
|
|
diabetes,
|
|
features,
|
|
kind,
|
|
):
|
|
"""Check that we raise an informative error when 2-way PD is requested
|
|
together with 1-way PD/ICE"""
|
|
warn_msg = (
|
|
"ICE plot cannot be rendered for 2-way feature interactions. 2-way "
|
|
"feature interactions mandates PD plots using the 'average' kind"
|
|
)
|
|
with pytest.raises(ValueError, match=warn_msg):
|
|
plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
features=features,
|
|
grid_resolution=20,
|
|
kind=kind,
|
|
)
|
|
|
|
|
|
@pytest.mark.filterwarnings("ignore:A Bunch will be returned")
|
|
@pytest.mark.parametrize(
|
|
"line_kw, pd_line_kw, ice_lines_kw, expected_colors",
|
|
[
|
|
({"color": "r"}, {"color": "g"}, {"color": "b"}, ("g", "b")),
|
|
(None, {"color": "g"}, {"color": "b"}, ("g", "b")),
|
|
({"color": "r"}, None, {"color": "b"}, ("r", "b")),
|
|
({"color": "r"}, {"color": "g"}, None, ("g", "r")),
|
|
({"color": "r"}, None, None, ("r", "r")),
|
|
({"color": "r"}, {"linestyle": "--"}, {"linestyle": "-."}, ("r", "r")),
|
|
],
|
|
)
|
|
def test_plot_partial_dependence_lines_kw(
|
|
plot_partial_dependence,
|
|
pyplot,
|
|
clf_diabetes,
|
|
diabetes,
|
|
line_kw,
|
|
pd_line_kw,
|
|
ice_lines_kw,
|
|
expected_colors,
|
|
):
|
|
"""Check that passing `pd_line_kw` and `ice_lines_kw` will act on the
|
|
specific lines in the plot.
|
|
"""
|
|
|
|
disp = plot_partial_dependence(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
[0, 2],
|
|
grid_resolution=20,
|
|
feature_names=diabetes.feature_names,
|
|
n_cols=2,
|
|
kind="both",
|
|
line_kw=line_kw,
|
|
pd_line_kw=pd_line_kw,
|
|
ice_lines_kw=ice_lines_kw,
|
|
)
|
|
|
|
line = disp.lines_[0, 0, -1]
|
|
assert line.get_color() == expected_colors[0]
|
|
if pd_line_kw is not None and "linestyle" in pd_line_kw:
|
|
assert line.get_linestyle() == pd_line_kw["linestyle"]
|
|
else:
|
|
assert line.get_linestyle() == "--"
|
|
|
|
line = disp.lines_[0, 0, 0]
|
|
assert line.get_color() == expected_colors[1]
|
|
if ice_lines_kw is not None and "linestyle" in ice_lines_kw:
|
|
assert line.get_linestyle() == ice_lines_kw["linestyle"]
|
|
else:
|
|
assert line.get_linestyle() == "-"
|
|
|
|
|
|
def test_partial_dependence_display_wrong_len_kind(
|
|
pyplot,
|
|
clf_diabetes,
|
|
diabetes,
|
|
):
|
|
"""Check that we raise an error when `kind` is a list with a wrong length.
|
|
|
|
This case can only be triggered using the `PartialDependenceDisplay.from_estimator`
|
|
method.
|
|
"""
|
|
disp = PartialDependenceDisplay.from_estimator(
|
|
clf_diabetes,
|
|
diabetes.data,
|
|
features=[0, 2],
|
|
grid_resolution=20,
|
|
kind="average", # len(kind) != len(features)
|
|
)
|
|
|
|
# alter `kind` to be a list with a length different from length of `features`
|
|
disp.kind = ["average"]
|
|
err_msg = (
|
|
r"When `kind` is provided as a list of strings, it should contain as many"
|
|
r" elements as `features`. `kind` contains 1 element\(s\) and `features`"
|
|
r" contains 2 element\(s\)."
|
|
)
|
|
with pytest.raises(ValueError, match=err_msg):
|
|
disp.plot()
|