Skip to content

Commit e8f9aa7

Browse files
update .md instructions for daal4py (#2283)
1 parent b86d5fc commit e8f9aa7

File tree

1 file changed

+16
-55
lines changed

1 file changed

+16
-55
lines changed

daal4py/README.md

Lines changed: 16 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,12 @@
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

24+
**IMPORTANT NOTICE**: `daal4py` has been merged into `scikit-learn-intelex`. As of version 2025.0, it is distributed as an additional importable module within the package `scikit-learn-intelex` instead of being a separate package. The last standalone release of `daal4py` was version 2024.7, and this standalone package will not receive further updates.
2425

2526
A simplified API to Intel(R) oneAPI Data Analytics Library that allows for fast usage of the framework suited for Data Scientists or Machine Learning users. Built to help provide an abstraction to Intel(R) oneAPI Data Analytics Library for either direct usage or integration into one's own framework.
2627

28+
Note: For the most part, `daal4py` is used as an internal backend within the Intel(R) Scikit-Learn extension, and it is highly recommended to use `sklearnex` instead. Nevertheless, some functionalities from `daal4py` can still be of use, and the module can still be imported directly (`import daal4py`) after installing `scikit-learn-intelex`.
29+
2730
## 👀 Follow us on Medium
2831

2932
We publish blogs on Medium, so [follow us](https://medium.com/intel-analytics-software/tagged/machine-learning) to learn tips and tricks for more efficient data analysis the help of daal4py. Here are our latest blogs:
@@ -53,81 +56,39 @@ Report issues, ask questions, and provide suggestions using:
5356
You may reach out to project maintainers privately at [email protected]
5457

5558
# 🛠 Installation
56-
daal4py is available at the [Python Package Index](https://pypi.org/project/daal4py/),
57-
on Anaconda Cloud in [Conda-Forge channel](https://anaconda.org/conda-forge/daal4py)
58-
and in [Intel channel](https://anaconda.org/intel/daal4py).
5959

60-
```bash
61-
# PyPI (recommended by default)
62-
pip install daal4py
63-
```
60+
Daal4Py is distributed as part of scikit-learn-intelex, which itself is distributed under different channels.
6461

65-
```bash
66-
# Anaconda Cloud from Conda-Forge channel (recommended for conda users by default)
67-
conda install daal4py -c conda-forge
68-
```
69-
70-
```bash
71-
# Intel channel (recommended for Intel® Distribution for Python users)
72-
conda install daal4py -c https://software.repos.intel.com/python/conda/
73-
```
62+
See the [installation instructions for scikit-learn-intelex](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/INSTALL.md) for details.
7463

7564
⚠️ Note: *GPU and MPI support are optional dependencies.
7665
Required dependencies for GPU and MPI support will not be downloaded.
77-
You need to manually install ***dpcpp_cpp_rt*** package for GPU support and ***impi_rt*** package for MPI support.*
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.*
7867

7968
<details><summary>[Click to expand] ℹ️ How to install dpcpp_cpp_rt and impi_rt packages </summary>
8069

81-
```bash
70+
```shell
8271
# PyPi for dpcpp
83-
pip install --upgrade dpcpp_cpp_rt
72+
pip install -U dpcpp_cpp_rt dpctl
8473
```
8574

86-
```bash
75+
```shell
8776
# PyPi for MPI
88-
pip install --upgrade impi_rt
77+
pip install -U mpi4py impi_rt
8978
```
9079

91-
```bash
92-
# Anaconda Cloud for dpcpp
93-
conda install dpcpp_cpp_rt -c intel
80+
```shell
81+
# Anaconda Cloud for dpcpp
82+
conda install dpcpp_cpp_rt dpctl -c https://software.repos.intel.com/python/conda/
9483
```
9584

96-
```bash
97-
# Anaconda Cloud for MPI
98-
conda install impi_rt -c intel
85+
```shell
86+
# Anaconda Cloud for MPI
87+
conda install mpi4py impi_rt -c https://software.repos.intel.com/python/conda/
9988
```
10089

101-
<details><summary>[Click to expand] ℹ️ Supported configurations </summary>
102-
103-
#### 📦 PyPi channel
104-
105-
| OS / Python version | **Python 3.6** | **Python 3.7** | **Python 3.8**| **Python 3.9**|
106-
| :-----------------------| :------------: | :-------------:| :------------:| :------------:|
107-
| **Linux** | [CPU, GPU] | [CPU, GPU] | [CPU, GPU] | [CPU, GPU]| |
108-
| **Windows** | [CPU, GPU] | [CPU, GPU] | [CPU, GPU] | [CPU, GPU]| |
109-
| **OsX** | [CPU] | [CPU] | [CPU] | [CPU] |
110-
111-
#### 📦 Anaconda Cloud: Conda-Forge channel
112-
113-
| OS / Python version | **Python 3.6** | **Python 3.7** | **Python 3.8**| **Python 3.9**|
114-
| :-----------------------| :------------: | :------------: | :------------:| :------------:|
115-
| **Linux** | [CPU] | [CPU] | [CPU] | [CPU] |
116-
| **Windows** | [CPU] | [CPU] | [CPU] | [CPU] |
117-
| **OsX** |||||
118-
119-
#### 📦 Anaconda Cloud: Intel channel
120-
121-
| OS / Python version | **Python 3.6** | **Python 3.7** | **Python 3.8**| **Python 3.9**|
122-
| :-----------------------| :------------: | :-------------:| :------------:| :------------:|
123-
| **Linux** || [CPU, GPU] |||
124-
| **Windows** || [CPU, GPU] |||
125-
| **OsX** || [CPU] |||
126-
12790
</details>
12891

129-
You can [build daal4py from sources](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/INSTALL.md) as well.
130-
13192

13293
# ⚠️ Scikit-learn patching
13394

0 commit comments

Comments
 (0)