scikit-learn-intelex icon indicating copy to clipboard operation
scikit-learn-intelex copied to clipboard

DOC: Add info about incremental algorithms and BS (#2103)

Open olegkkruglov opened this issue 4 months ago • 7 comments

  • Add 'Non-Scikit algorithms' part to the docs
  • Add info about IncrementalPCA
  • Add sphinx.napoleon extension to generate docs from docstrings.
  • Update docstrings for non-scikit algorithms

Description

Add a comprehensive description of proposed changes

List associated issue number(s) if exist(s): #6 (for example)

Documentation PR (if needed): #1340 (for example)

Benchmarks PR (if needed): https://github.com/IntelPython/scikit-learn_bench/pull/155 (for example)


Checklist to comply with before moving PR from draft:

PR completeness and readability

  • [x] I have reviewed my changes thoroughly before submitting this pull request.
  • [x] I have commented my code, particularly in hard-to-understand areas.
  • [x] 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.
  • [x] Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
  • [x] I have added a respective label(s) to PR if I have a permission for that.
  • [x] I have resolved any merge conflicts that might occur with the base branch.

Testing

  • [x] I have run it locally and tested the changes extensively.
  • [x] All CI jobs are green or I have provided justification why they aren't.
  • [x] I have extended testing suite if new functionality was introduced in this PR.

Performance

  • [x] I have measured performance for affected algorithms using scikit-learn_bench and provided at least summary table with measured data, if performance change is expected.
  • [x] I have provided justification why performance has changed or why changes are not expected.
  • [x] I have provided justification why quality metrics have changed or why changes are not expected.
  • [x] I have extended benchmarking suite and provided corresponding scikit-learn_bench PR if new measurable functionality was introduced in this PR.

olegkkruglov avatar Oct 15 '24 09:10 olegkkruglov