uxlfoundation / scikit-learn-intelex

Extension for Scikit-learn is a seamless way to speed up your Scikit-learn application
https://intel.github.io/scikit-learn-intelex/
Apache License 2.0
1.23k stars 176 forks source link

DOC: Clear some warnings for daal4py doc builds #2205

Open david-cortes-intel opened 1 day ago

david-cortes-intel commented 1 day ago

Description

This PR resolves many warnings that pop out when building the daal4py docs and which prevent the CI jobs from building those docs correctly.

Note that it doesn't solve all of the warnings - after this PR, one would still see many of these cases:

scikit-learn-intelex/doc/daal4py/docstring of daal4py._daal4py.classifier_prediction_result:1: WARNING: duplicate object description of daal4py.classifier_prediction_result, other instance in algorithms, use :noindex: for one of them

(I'm not sure what to do about those)


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

Testing

Performance

Not applicable.

david-cortes-intel commented 1 day ago

This worked for a local build, but it seems it was not enough for the CI job named "Docs": https://dev.azure.com/daal/daal4py/_build/results?buildId=40827&view=logs&j=7e620c85-24a8-5ffa-8b1f-642bc9b1fc36&t=dadee17e-671e-5fd8-4599-c783ec4d74d0

It still fails to import daal4py during the doc build step. Wonder if the issue might be that it is not building it.