DOC explicitely add 3D axis to figure to be compatible with future matplotlib #21916
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes deprecation warnings in plot_cluster_iris.py. https://scikit-learn.org/stable/auto_examples/cluster/plot 8000 _cluster_iris.html currently displays the following deprecation warning: `plot_cluster_iris.py:48: MatplotlibDeprecationWarning: Axes3D(fig) adding itself to the figure is deprecated since 3.4. Pass the keyword argument auto_add_to_figure=False and use fig.add_axes(ax) to suppress this warning. The default value of auto_add_to_figure will change to False in mpl3.5 and True values will no longer work in 3.6. This is consistent with other Axes classes.`
|
Unfortunately this breaks the Traceback (most recent call last):
File "/home/circleci/miniconda/envs/testenv/lib/python3.7/site-packages/sphinx_gallery/gen_gallery.py", line 159, in call_memory
return 0., func()
File "/home/circleci/miniconda/envs/testenv/lib/python3.7/site-packages/sphinx_gallery/gen_rst.py", line 466, in __call__
exec(self.code, self.fake_main.__dict__)
File "/home/circleci/project/examples/cluster/plot_cluster_iris.py", line 48, in <module>
ax = Axes3D(fig, rect=[0, 0, 0.95, 1], elev=48, azim=134, auto_add_to_figure=False)
File "/home/circleci/miniconda/envs/testenv/lib/python3.7/site-packages/mpl_toolkits/mplot3d/axes3d.py", line 104, in __init__
*args, **kwargs)
File "/home/circleci/miniconda/envs/testenv/lib/python3.7/site-packages/matplotlib/axes/_base.py", line 541, in __init__
self.update(kwargs)
File "/home/circleci/miniconda/envs/testenv/lib/python3.7/site-packages/matplotlib/artist.py", line 888, in update
for k, v in props.items()]
File "/home/circleci/miniconda/envs/testenv/lib/python3.7/site-packages/matplotlib/artist.py", line 888, in <listcomp>
for k, v in props.items()]
File "/home/circleci/miniconda/envs/testenv/lib/python3.7/site-packages/matplotlib/artist.py", line 881, in _update_property
raise AttributeError('Unknown property %s' % k)
AttributeError: Unknown property auto_add_to_figureI am not sure how to best deal with the fact that we want our doc to also build on older scipy versions... Maybe it would be possible to write a small helper function in the example to deal with backward compat depending on the scipy version? This will render the example a bit verbose but it's probably better than a warning. |
glemaitre
reviewed
Jan 28, 2022
| @@ -45,7 +45,8 @@ | |||
| titles = ["8 clusters", "3 clusters", "3 clusters, bad initialization"] | |||
| for name, est in estimators: | |||
| fig = plt.figure(fignum, figsize=(4, 3)) | |||
| ax = Axes3D(fig, rect=[0, 0, 0.95, 1], elev=48, azim=134) | |||
| ax = Axes3D(fig, rect=[0, 0, 0.95, 1], elev=48, azim=134, auto_add_to_figure=False) | |||
There was a problem hiding this comment.
Suggested change
| ax = Axes3D(fig, rect=[0, 0, 0.95, 1], elev=48, azim=134, auto_add_to_figure=False) | |
| ax = Axes3D(fig, rect=[0, 0, 0.95, 1], elev=48, azim=134) |
| @@ -63,7 +64,8 @@ | |||
|
|
|||
| # Plot the ground truth | |||
| fig = plt.figure(fignum, figsize=(4, 3)) | |||
| ax = Axes3D(fig, rect=[0, 0, 0.95, 1], elev=48, azim=134) | |||
| ax = Axes3D(fig, rect=[0, 0, 0.95, 1], elev=48, azim=134, auto_add_to_figure=False) | |||
There was a problem hiding this comment.
Suggested change
| ax = Axes3D(fig, rect=[0, 0, 0.95, 1], elev=48, azim=134, auto_add_to_figure=False) | |
| ax = Axes3D(fig, rect=[0, 0, 0.95, 1], elev=48, azim=134) |
|
The |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
N/A
What does this implement/fix? Explain your changes.
Fixes deprecation warnings in plot_cluster_iris.py.
https://scikit-learn.org/stable/auto_examples/cluster/plot_cluster_iris.html currently displays the following deprecation warning:
plot_cluster_iris.py:48: MatplotlibDeprecationWarning: Axes3D(fig) adding itself to the figure is deprecated since 3.4. Pass the keyword argument auto_add_to_figure=False and use fig.add_axes(ax) to suppress this warning. The default value of auto_add_to_figure will change to False in mpl3.5 and True values will no longer work in 3.6. This is consistent with other Axes classes.Any other comments?
It may be worth reviewing other pages to see where else this issue is present.