VIZ, ENH Adding True/False labels in arrows coming from root in `plot_tree` to match `export_tree` #28552

adam2392 · 2024-02-28T21:57:49Z

Reference Issues/PRs

Fixes: #16153
Fixes: #17184

What does this implement/fix? Explain your changes.

Adds True/False labels on top of the arrows that go from root node to left/right child
Updates unit-test

Any other comments?

The images from `plot_tree`

(default):

(figsize=(10,10)):

(20, 20):

(5, 10):

Signed-off-by: Adam Li <[email protected]>

adam2392 · 2024-02-28T21:58:49Z

import numpy as np
from matplotlib import pyplot as plt

from sklearn.datasets import load_iris
from sklearn.model_selection import train_test_split
from sklearn.tree import DecisionTreeClassifier
from sklearn import tree

iris = load_iris()
X = iris.data
y = iris.target
X_train, X_test, y_train, y_test = train_test_split(X, y, random_state=0)

clf = DecisionTreeClassifier(max_leaf_nodes=3, random_state=0)
clf.fit(X_train, y_train)

fig, ax = plt.subplots(figsize=(12, 12))
tree.plot_tree(
    clf,
    feature_names=iris.feature_names,
    class_names=iris.target_names,
    filled=True,
    ax=ax,
)
plt.show()

Signed-off-by: Adam Li <[email protected]>

github-actions · 2024-02-28T21:59:14Z

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

_{Generated for commit: 18876a7. Link to the linter CI: here}

Signed-off-by: Adam Li <[email protected]>

thomasjpfan · 2024-03-02T03:06:48Z

sklearn/tree/_export.py

+                            text_pos,
+                            ha="center",
+                            va="center",
+                            fontsize=10,


Does this have to be self.fontsize if it is not None?

How does this annotation scale when the figsize is large, (i.e. figsize=(20,20))

I did a refactoring of the kwargs, so that way it shouldn't be hardcoded here. I included in the PR description the image from various figure sizes.

Signed-off-by: Adam Li <[email protected]>

…to treeviz

Charlie-XIAO

The rendering looks nice 😊 Here are some minor comments that probably makes the code cleaner.

sklearn/tree/_export.py

Co-authored-by: Yao Xiao <[email protected]>

Signed-off-by: Adam Li <[email protected]>

adam2392 · 2024-03-02T17:49:02Z

Thanks for the review @thomasjpfan and @Charlie-XIAO !

I addressed your comments

Charlie-XIAO

Thanks! Here are some additional suggestions regarding the positions of the True/False labels when I read through the diff again. I'm not sure if my suggested solution would work, so you may need to try it out :)

Also it seems that Codecov is complaining because we do not have a test that uses the fontsize parameter. It is not originally caused by this PR but maybe you can add a test to cover that.

sklearn/tree/_export.py

Signed-off-by: Adam Li <[email protected]>

adam2392 · 2024-03-03T14:48:03Z

Also it seems that Codecov is complaining because we do not have a test that uses the fontsize parameter. It is not originally caused by this PR but maybe you can add a test to cover that.

Added a unit-test for fantasize

sklearn/tree/_export.py

Co-authored-by: Yao Xiao <[email protected]>

adam2392

Thanks for the review @Charlie-XIAO ! Now the figsize=(20,8) works well.

sklearn/tree/_export.py

Signed-off-by: Adam Li <[email protected]>

Charlie-XIAO

Thanks @adam2392! The plots look good to me now :)

Charlie-XIAO · 2024-03-04T03:25:27Z

sklearn/tree/_export.py

+                    if node.parent.left() == node:
+                        label_text, label_ha = ("True  ", "right")
+                    else:
+                        label_text, label_ha = ("  False", "left")


For other reviewers' reference, the spaces before and after the True/False label are to create some offset from the arrow on top of adjusting horizontal alignment. I'm not sure if there is a nicer way to do this; note that we are also creating padding by using spaces in annotation text e.g. this line so maybe this is fine?

@Charlie-XIAO Currently, it looks like displaying the labels in the tree is "hardcoded". What do you think about providing this feature of displaying the labels for the first split in a decision tree with a parameter for plot_tree() in case anyone does not like to display them? Maybe as a param called display_labels like in sklearn.metrics.ConfusionMatrixDisplay

That seems reasonable to me, but I'll wait to see what the dev team thinks if it's adding complexity to the API.

WDYT @thomasjpfan and @Charlie-XIAO ?

For now, I'm okay with the current implementation. Adding true and false labels is already improvement.

BTW resolves #17184

thomasjpfan · 2024-03-12T18:04:37Z

sklearn/tree/_export.py

-            xycoords="axes fraction",
+            bbox=self.bbox_args.copy(),
            arrowprops=self.arrow_args.copy(),
+            **non_box_kwargs,


If kwargs applies to annotations with a bounding box, then it's strange to have non_box_kwargs here.

If they share some kwargs, then I prefer this naming:

Suggested change

**non_box_kwargs,

**common_box_kwargs,

I renamed to common_kwargs since the annotations true/false technically don't have a bounding box.

b90bcfe

thomasjpfan · 2024-03-12T18:05:46Z

sklearn/tree/_export.py

+                    if node.parent.left() == node:
+                        label_text, label_ha = ("True  ", "right")
+                    else:
+                        label_text, label_ha = ("  False", "left")


For now, I'm okay with the current implementation. Adding true and false labels is already improvement.

…to treeviz

thomasjpfan

LGTM

Adding True/False on the first children from root

78c37a9

Signed-off-by: Adam Li <[email protected]>

github-actions bot added the module:tree label Feb 28, 2024

Cleanup

64fd90e

Signed-off-by: Adam Li <[email protected]>

Add changelog

d68d5ee

Signed-off-by: Adam Li <[email protected]>

adam2392 mentioned this pull request Feb 28, 2024

Add threshold comparison above arrow in plot_tree #16153

Closed

thomasjpfan reviewed Mar 2, 2024

View reviewed changes

adam2392 added 2 commits March 2, 2024 11:51

Address thomas comments

0493e0e

Signed-off-by: Adam Li <[email protected]>

Merge branch 'main' into treeviz

a56d499

adam2392 requested a review from thomasjpfan March 2, 2024 16:52

adam2392 added 2 commits March 2, 2024 11:54

Update inline comment' -s

a7ca99d

Signed-off-by: Adam Li <[email protected]>

Merge branch 'treeviz' of https://github.com/adam2392/scikit-learn in…

8a7988a

…to treeviz

Charlie-XIAO reviewed Mar 2, 2024

View reviewed changes

sklearn/tree/_export.py Show resolved Hide resolved

sklearn/tree/_export.py Show resolved Hide resolved

sklearn/tree/_export.py Outdated Show resolved Hide resolved

adam2392 and others added 2 commits March 2, 2024 12:47

Apply suggestions from code review

413088d

Co-authored-by: Yao Xiao <[email protected]>

Fix lint

029e8c8

Signed-off-by: Adam Li <[email protected]>

adam2392 requested a review from Charlie-XIAO March 2, 2024 17:52

Charlie-XIAO reviewed Mar 3, 2024

View reviewed changes

sklearn/tree/_export.py Show resolved Hide resolved

sklearn/tree/_export.py Outdated Show resolved Hide resolved

adam2392 added 2 commits March 3, 2024 09:47

Demonstrate fontsize test

c864179

Signed-off-by: Adam Li <[email protected]>

Remove diff

137c849

Signed-off-by: Adam Li <[email protected]>

Charlie-XIAO reviewed Mar 3, 2024

View reviewed changes

sklearn/tree/_export.py Outdated Show resolved Hide resolved

sklearn/tree/_export.py Show resolved Hide resolved

sklearn/tree/_export.py Outdated Show resolved Hide resolved

sklearn/tree/_export.py Outdated Show resolved Hide resolved

Apply suggestions from code review

cb54815

Co-authored-by: Yao Xiao <[email protected]>

adam2392 commented Mar 4, 2024

View reviewed changes

sklearn/tree/_export.py Outdated Show resolved Hide resolved

adam2392 added 2 commits March 3, 2024 22:17

Address comments

f1cc843

Signed-off-by: Adam Li <[email protected]>

Merge branch 'main' into treeviz

1d1a8a7

Charlie-XIAO approved these changes Mar 4, 2024

View reviewed changes

Charlie-XIAO added the Waiting for Second Reviewer First reviewer is done, need a second one! label Mar 5, 2024

Merge branch 'main' into treeviz

e9840e7

thomasjpfan reviewed Mar 12, 2024

View reviewed changes

adam2392 added 3 commits March 14, 2024 09:39

Chang eto common kwargs

b90bcfe

Merge branch 'treeviz' of https://github.com/adam2392/scikit-learn in…

32b215c

…to treeviz

Merge branch 'main' into treeviz

18876a7

adam2392 requested a review from thomasjpfan March 14, 2024 13:40

thomasjpfan approved these changes Mar 14, 2024

View reviewed changes

thomasjpfan merged commit 8c9d0b2 into scikit-learn:main Mar 14, 2024

Uh oh!

VIZ, ENH Adding True/False labels in arrows coming from root in plot_tree to match export_tree #28552

VIZ, ENH Adding True/False labels in arrows coming from root in plot_tree to match export_tree #28552

Conversation

adam2392 commented Feb 28, 2024 • edited by Charlie-XIAO Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Any other comments?

Uh oh!

adam2392 commented Feb 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✔️ Linting Passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Charlie-XIAO left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adam2392 commented Mar 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Charlie-XIAO left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

adam2392 commented Mar 3, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adam2392 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Charlie-XIAO left a comment

Choose a reason for hiding this comment

Uh oh!

Charlie-XIAO Mar 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

d-kleine Mar 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adam2392 Mar 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

VIZ, ENH Adding True/False labels in arrows coming from root in `plot_tree` to match `export_tree` #28552

VIZ, ENH Adding True/False labels in arrows coming from root in `plot_tree` to match `export_tree` #28552

adam2392 commented Feb 28, 2024 •

edited by Charlie-XIAO

Loading

adam2392 commented Feb 28, 2024 •

edited

Loading

github-actions bot commented Feb 28, 2024 •

edited

Loading

adam2392 commented Mar 2, 2024 •

edited

Loading

Charlie-XIAO left a comment •

edited

Loading

Charlie-XIAO Mar 4, 2024 •

edited

Loading

d-kleine Mar 8, 2024 •

edited

Loading

adam2392 Mar 14, 2024 •

edited

Loading