Skip to content

Commit b1869bb

Browse files
MAINT: Remove separate daal4py docs (#2429)
* remove separate d4p docs * remove/update more references * update links
1 parent 1ea54fe commit b1869bb

26 files changed

+7
-3110
lines changed

.ci/pipeline/docs.yml

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -76,26 +76,13 @@ jobs:
7676
export LD_LIBRARY_PATH=$(dirname $(dirname $(which python)))/lib:$LD_LIBRARY_PATH
7777
./conda-recipe/build.sh
7878
displayName: 'Build daal4py/sklearnex'
79-
- script: |
80-
export LD_LIBRARY_PATH=$(dirname $(dirname $(which python)))/lib:$LD_LIBRARY_PATH
81-
cd doc/daal4py
82-
make html 2>&1 | tee build.log
83-
cat build.log
84-
# check for autodoc warnings
85-
if grep -i "autodoc" build.log; then
86-
echo "Autodoc Warnings detected, build failed!"
87-
exit 1
88-
fi
89-
displayName: 'Build daal4py documentation'
9079
- script: |
9180
export LD_LIBRARY_PATH=$(dirname $(dirname $(which python)))/lib:$LD_LIBRARY_PATH
9281
cd doc
9382
./build-doc.sh
9483
displayName: 'Build scikit-learn-intelex documentation'
9584
- script: |
96-
mkdir $(Build.ArtifactStagingDirectory)/html/daal4py
9785
mkdir $(Build.ArtifactStagingDirectory)/html/sklearnex
98-
cp -R doc/daal4py/_build $(Build.ArtifactStagingDirectory)/html_daal4py
9986
cp -R doc/_build $(Build.ArtifactStagingDirectory)/html_sklearnex
10087
displayName: 'Copy build'
10188
- task: PublishPipelineArtifact@0

daal4py/README.md

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
# daal4py - A Convenient Python API to the oneAPI Data Analytics Library
1818
[![Build Status](https://dev.azure.com/daal/daal4py/_apis/build/status/CI?branchName=main)](https://dev.azure.com/daal/daal4py/_build/latest?definitionId=9&branchName=main)
1919
[![Coverity Scan Build Status](https://scan.coverity.com/projects/21716/badge.svg)](https://scan.coverity.com/projects/daal4py)
20-
[![Join the community on GitHub Discussions](https://badgen.net/badge/join%20the%20discussion/on%20github/black?icon=github)](https://github.com/IntelPython/daal4py/discussions)
20+
[![Join the community on GitHub Discussions](https://badgen.net/badge/join%20the%20discussion/on%20github/black?icon=github)](https://github.com/uxlfoundation/scikit-learn-intelex/discussions)
2121
[![PyPI Version](https://img.shields.io/pypi/v/daal4py)](https://pypi.org/project/daal4py/)
2222
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/daal4py)](https://anaconda.org/conda-forge/daal4py)
2323

@@ -40,8 +40,7 @@ We publish blogs on Medium, so [follow us](https://medium.com/intel-analytics-so
4040
- [Accelerate K-Means Clustering](https://medium.com/intel-analytics-software/accelerate-k-means-clustering-6385088788a1)
4141

4242
## 🔗 Important links
43-
- [Documentation](https://intelpython.github.io/daal4py/)
44-
- [scikit-learn API and patching](https://intelpython.github.io/daal4py/sklearn.html#sklearn)
43+
- [Documentation](https://uxlfoundation.github.io/scikit-learn-intelex/latest/about_daal4py.html)
4544
- [Building from Sources](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/daal4py/INSTALL.md)
4645
- [About oneAPI Data Analytics Library](https://github.com/uxlfoundation/oneDAL)
4746

@@ -61,34 +60,6 @@ Daal4Py is distributed as part of scikit-learn-intelex, which itself is distribu
6160

6261
See the [installation instructions for scikit-learn-intelex](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/INSTALL.md) for details.
6362

64-
⚠️ Note: *GPU and MPI support are optional dependencies.
65-
Required dependencies for GPU and MPI support will not be downloaded.
66-
You need to manually install `dpcpp_cpp_rt` and `dpctl` packages for GPU support, and `mpi4py` with `impi_rt` as backend package for MPI support.*
67-
68-
<details><summary>[Click to expand] ℹ️ How to install dpcpp_cpp_rt and impi_rt packages </summary>
69-
70-
```shell
71-
# PyPi for dpcpp
72-
pip install -U dpcpp_cpp_rt dpctl
73-
```
74-
75-
```shell
76-
# PyPi for MPI
77-
pip install -U mpi4py impi_rt
78-
```
79-
80-
```shell
81-
# conda for dpcpp
82-
conda install dpcpp_cpp_rt dpctl -c https://software.repos.intel.com/python/conda/
83-
```
84-
85-
```shell
86-
# conda for MPI
87-
conda install mpi4py impi_rt -c https://software.repos.intel.com/python/conda/
88-
```
89-
90-
</details>
91-
9263

9364
# ⚠️ Scikit-learn patching
9465

daal4py/sklearn/monkeypatch/dispatcher.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ def enable(name=None, verbose=True, deprecation=True, get_map=_get_map_of_algori
188188
if verbose and deprecation and sys.stderr is not None:
189189
sys.stderr.write(
190190
"oneAPI Data Analytics Library solvers for sklearn enabled: "
191-
"https://intelpython.github.io/daal4py/sklearn.html\n"
191+
"https://uxlfoundation.github.io/scikit-learn-intelex/\n"
192192
)
193193

194194

deselected_tests.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ deselected_tests:
157157
- svm/tests/test_svm.py::test_custom_kernel_not_array_input[SVR]
158158

159159
# test_non_uniform_strategies fails due to differences in handling of vacuous clusters after update
160-
# See https://github.com/IntelPython/daal4py/issues/69
160+
# See https://github.com/uxlfoundation/scikit-learn-intelex/issues/69
161161
- cluster/tests/test_k_means.py::test_kmeans_relocated_clusters >=0.24
162162

163163
# oneAPI Data Analytics Library (oneDAL) does not check convergence for tol == 0.0 for ease of benchmarking

doc/README.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,3 @@ To build Extension for Scikit-Learn documentation locally:
4040
5. Run the ``build-doc.sh`` script.
4141

4242
You will then find documentation under the `_build/html` folder.
43-
44-
Additional documentation for the `daal4py` module can be built with the following steps (after having installed the `scikit-learn-intelex` packages and doc dependencies):
45-
46-
1. Go to the `doc/daal4py` folder:
47-
48-
cd scikit-learn-intelex/doc/daal4py
49-
50-
2. Run the makefile (assuming linux):
51-
52-
make html
53-
54-
Documentation will similarly be built under `_build/html`.

doc/daal4py/Makefile

Lines changed: 0 additions & 23 deletions
This file was deleted.

doc/daal4py/_static/style.css

Lines changed: 0 additions & 120 deletions
This file was deleted.

doc/daal4py/_templates/layout.html

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)