Skip to content

DOC - Improving getting started example#1627

Merged
rcap107 merged 8 commits into
skrub-data:mainfrom
rcap107:doc-update-getting-started
Sep 25, 2025
Merged

DOC - Improving getting started example#1627
rcap107 merged 8 commits into
skrub-data:mainfrom
rcap107:doc-update-getting-started

Conversation

@rcap107

@rcap107 rcap107 commented Sep 22, 2025

Copy link
Copy Markdown
Member
  • Removed section on datasets
  • Added replace directives
  • Split exploration and cleaning sections

@rcap107 rcap107 marked this pull request as ready for review September 22, 2025 15:41
Comment thread examples/00_getting_started.py
Comment thread examples/00_getting_started.py Outdated
@rcap107 rcap107 added this to the 0.6.2 milestone Sep 24, 2025
@glemaitre glemaitre self-requested a review September 25, 2025 08:13

@glemaitre glemaitre 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.

Here a couple of comments.

Comment thread examples/00_getting_started.py Outdated
Comment thread examples/00_getting_started.py Outdated
Comment thread examples/00_getting_started.py Outdated
Comment on lines +62 to +63
# From the Report above, we can see that there are datetime columns, so we use the
# |Cleaner| to parse them.

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.

Suggested change
# From the Report above, we can see that there are datetime columns, so we use the
# |Cleaner| to parse them.
# From the report above, we see that there are columns with date and time stored
# as `object` dtype (cf. "Stats" tab of the report). We therefore use the |Cleaner| to
# parse them and obtain a `datetime` dtype column. We see in the next section that this
# transformer does additional cleaning.

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.

Maybe, we could simplify this text here because it is redundant with the next section. I would propose a broader statement than focusing on the datetime. For instance, we could state that after reading a table, it is common that the dtype are not inferred properly or contains unnecessary columns and that we use the Cleaner for that purpose.

And in the next section, we point out specifically to the datetime column.

Comment thread examples/00_getting_started.py
Comment thread examples/00_getting_started.py
Comment thread examples/00_getting_started.py Outdated
rcap107 and others added 2 commits September 25, 2025 11:02
Co-authored-by: Guillaume Lemaitre <guillaume@probabl.ai>
@rcap107 rcap107 merged commit 8bcfd7e into skrub-data:main Sep 25, 2025
26 checks passed
@rcap107 rcap107 deleted the doc-update-getting-started branch September 25, 2025 12:53
rcap107 added a commit to rcap107/skrub that referenced this pull request Sep 25, 2025
Co-authored-by: Guillaume Lemaitre <guillaume@probabl.ai>
rcap107 added a commit that referenced this pull request Sep 25, 2025
Co-authored-by: Guillaume Lemaitre <guillaume@probabl.ai>
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.

3 participants