scikit-learn-intelex
scikit-learn-intelex copied to clipboard
Restructure the docs
Description
Restructure the docs and rewrite the onboarding docs. The approximate output is available at https://aepanchi.github.io/scikit-learn-intelex/index.html
Changes proposed in this pull request:
- Change the doc structure.
- Create README.md for the doc folder with instruction on how to build docs locally.
- Update conf.py with extensions required for a doc build.
- Update contribute.rst and support.rst
- Update index.rst: delete the unnecessary information, update acceleration image, add examples.
- Fix layout in several files to align with the rest.
- Create tutorials.rst
- Update quick-start: move there installation, system and memory requirements, releases, and patching.
- Delete mentions of macOS since this doc set is for 2024.x
Signed-off-by: Alexandra Epanchinzeva [email protected]
partially reviewed
one small observation is that we have docs/ in oneDAL and doc/ in sklearnex - would we want to align these?
Thanks for the review! We can align them, but it is not required.
Nice work, docs are easy to navigate and looks improved from previous docs. Mostly minor comments, once docbuild passes then looks good to me.
Thanks! Updated the requirements file, and the CI has passed :)
Messed up formatting in quick start
Messed up formatting in quick start
![]()
It will be fine in the repos build since we have max-width: 1200px;
@aepanchi any more to be done on this one?
@ethanglaser Hi, I addressed all of the comments. Are you okay with merging?