Skip to content

docs: Add SKD010 slower-than-baseline pitfall example - #3160

Open
moujanrastgoo wants to merge 2 commits into
probabl-ai:mainfrom
moujanrastgoo:docs/add-skd010-pitfall-example
Open

docs: Add SKD010 slower-than-baseline pitfall example#3160
moujanrastgoo wants to merge 2 commits into
probabl-ai:mainfrom
moujanrastgoo:docs/add-skd010-pitfall-example

Conversation

@moujanrastgoo

@moujanrastgoo moujanrastgoo commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Change description

Related to #2622 and #3134

  • Adds new sphinx-gallery subsection Pitfalls and solutions
  • Registers subsection in sphinx/conf.py
  • Adds SKD010 check example and links from automated checks user guide

Contribution checklist

  • Unit tests were added or updated (if necessary)
  • Documentation was added or updated (if necessary)
  • The code passes our style conventions (you can check this by running pre-commit on your code
    with pre-commit run --all-files)
  • All the tests pass (please test locally before pushing)
  • The documentation builds and renders properly (if it does, our bot will add a comment linking
    to a preview of the documentation to review it visually)
  • All the commits in the PR are signed (more information
    here)
  • The pull request title respects the Conventional Commits convention (more information
    here)

AI usage disclosure

AI tools were involved for:

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Documentation preview @ a5147af

Comment thread examples/pitfalls_and_solutions/plot_skd010_slower_than_baseline.py
report

# %%
# Find ``SKD010`` in the Tips tab below: a large fit-time ratio without a

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# Find ``SKD010`` in the Tips tab below: a large fit-time ratio without a
# Find ``SKD010`` in the Issues tab below: a large fit-time ratio without a

report_lighter

# %%
# With a lighter forest, SKD010 should typically be gone.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# With a lighter forest, SKD010 should typically be gone.
# With a lighter forest, SKD010 should no longer fire.

Comment on lines +101 to +102
# %%
report.metrics.summarize(data_source="both").frame()

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

this line doesn't seem useful (same in the rest of the example)

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.

2 participants