Skip to content

DOC: Include new notebooks in .rst docs#2357

Merged
david-cortes-intel merged 1 commit into
uxlfoundation:mainfrom
david-cortes-intel:include_new_notebooks
Mar 13, 2025
Merged

DOC: Include new notebooks in .rst docs#2357
david-cortes-intel merged 1 commit into
uxlfoundation:mainfrom
david-cortes-intel:include_new_notebooks

Conversation

@david-cortes-intel
Copy link
Copy Markdown
Contributor

Description

ref #2343

The PR above introduced new notebooks showcasing speedups of sklearnex.

All of these notebooks get copied automatically into the docs folder from where the .rst files include them. Since our docs build logic is to turn all warnings into errors, this currently leads to errors like these:

checking consistency... /home/vsts/work/1/s/doc/sources/samples/random_forest_rain.ipynb: WARNING: document isn't included in any toctree [toc.not_included]
/home/vsts/work/1/s/doc/sources/samples/ridge_regression_bike_sharing.ipynb: WARNING: document isn't included in any toctree [toc.not_included]
/home/vsts/work/1/s/doc/sources/samples/ridge_regression_fraud_detection.ipynb: WARNING: document isn't included in any toctree [toc.not_included]
/home/vsts/work/1/s/doc/sources/samples/ridge_regression_higgs.ipynb: WARNING: document isn't included in any toctree [toc.not_included]

This PR fixes them by including these new notebooks in the relevant .rst files.


PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
This approach ensures that reviewers don't spend extra time asking for regular requirements.

You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).

Checklist to comply with before moving PR from draft:

PR completeness and readability

  • I have reviewed my changes thoroughly before submitting this pull request.
  • I have updated the documentation to reflect the changes or created a separate PR with update and provided its number in the description, if necessary.
  • Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
  • I have added a respective label(s) to PR if I have a permission for that.
  • I have resolved any merge conflicts that might occur with the base branch.

Testing

  • I have run it locally and tested the changes extensively.
  • All CI jobs are green or I have provided justification why they aren't.

Performance

Not applicable.

@david-cortes-intel
Copy link
Copy Markdown
Contributor Author

Screenshot of new inclusions in generated artifact:
image

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
azure ?
github 70.74% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 54 files with indirect coverage changes

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@david-cortes-intel david-cortes-intel merged commit bccbd29 into uxlfoundation:main Mar 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants