Skip to content

deprecate sample_data module#1725

Merged
maximlt merged 19 commits into
mainfrom
deprecate-sample_data
Jun 19, 2026
Merged

deprecate sample_data module#1725
maximlt merged 19 commits into
mainfrom
deprecate-sample_data

Conversation

@Azaya89

@Azaya89 Azaya89 commented May 12, 2026

Copy link
Copy Markdown
Collaborator

Fixes #1723

Description

This PR deprecates the sample_data module and recommends sampledata instead.

AI Disclosure

  • This PR contains AI-generated content.
    • I have tested all AI-generated content in my PR.
    • I take responsibility for all AI-generated content in my PR.

Tools and Models: Copilot Claude Sonnet 4.6

Checklist

  • Tests added and are passing

@Azaya89

This comment was marked as resolved.

@Azaya89 Azaya89 marked this pull request as ready for review May 13, 2026 17:17
@Azaya89 Azaya89 requested a review from Copilot May 13, 2026 17:23

This comment was marked as resolved.

@Azaya89 Azaya89 self-assigned this May 13, 2026
@Azaya89 Azaya89 requested a review from maximlt May 13, 2026 18:24
@hoxbro hoxbro mentioned this pull request Jun 3, 2026
3 tasks

@maximlt maximlt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My main comment is that the original change to the sample_data module wasn't a deprecation. It was direct code removal. Removing a feature has to go through a well-defined process (see HEP2) with discussion, deprecation, and finally removal. I added the sample_data code back. In a future release, we will be able to remove the module and datasets.yaml (that was forgotten here) entirely.

My second comment is that I find some of the replaced plots not always meaningful. I feel like that when we use datasets based on real data (e.g. stocks, penguins), we need to make realistic plots. Otherwise, we risk losing a bit of credibility with our users. I've listed these plots below. Soon (hopefully) these user guides should go away, so I'm ok merging these changes as they are meant to be temporary. Let's keep in mind though for the future that we have to make sure we generate realistic plots.

Plotting with Bokeh

That's not a very pretty plot.
Image

I don't think that it makes so much sense.
Image

Not the most common kind of bar plot.
Image

hexbin plots are better displayed imo with an equal aspect ratio.
Image

Can't really see much on this one.
Image

Same.
Image

Plotting Extensions

The first plot isn't great.

Image

Subplots

Lots of empty cells in this subplot, might look a bit off for visitors.
Image

I think there's a missing GIF for the landing page.

Comment thread doc/user_guide/Plotting.ipynb Outdated
Comment thread doc/index.md Outdated
Comment thread scripts/download_data.py
@maximlt

maximlt commented Jun 12, 2026

Copy link
Copy Markdown
Member

Just to clarify @Azaya89, the only change that I would like is a new GIF for the landing page. Everything else is good to be merged.

@Azaya89 Azaya89 requested a review from maximlt June 15, 2026 13:32
@maximlt maximlt merged commit 68a67d9 into main Jun 19, 2026
13 checks passed
@maximlt maximlt deleted the deprecate-sample_data branch June 19, 2026 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecate the sample_data module

3 participants