Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Fix docs related to n_jobs #2130

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

david-cortes-intel
Copy link
Contributor

@david-cortes-intel david-cortes-intel commented Oct 24, 2024

Description

This PR fixes an issue in which the docs for classes that are not part of original scikit-learn were not setting the docs for n_jobs correctly and showing warnings about them, due to to three reasons:

  • Using internal "glossary" link, which is from original scikit-learn but not present in sklearnex.
  • Referencing objects from joblib without linking to them the way scikit-learn does.
  • The decorator adding the parameter more than once to the docstrings if the keyword "Attributes" appeared more than once.

Before:
image
(note that glossary and backend are not clickable)

After:
image


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.

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.

1 participant