Skip to content

Commit 01df2a5

Browse files
Update naming and dropping Intel specifics (backport #2355) (#2378)
* Update naming and dropping Intel specifics (#2355) * Dropping Intel specific naming * Fix conda related naming * updating doc config with naming * Renaming IntelEstomator to ExtensionEstimator * Replacing oneDAL with sustitution reference * Fixing linting on incremental_ridge * remplacing substitute name * removing reg * update copyright/author * adding onedal substitution * fix spacing (cherry picked from commit f89c9e2) # Conflicts: # doc/sources/oneapi-gpu.rst # doc/sources/quick-start.rst * Update oneapi-gpu.rst * Update quick-start.rst --------- Co-authored-by: Nikolay Petrov <[email protected]>
1 parent 91249c6 commit 01df2a5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+412
-412
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@
1717

1818
# How to Contribute
1919

20-
As an open source project, we welcome community contributions to Intel(R) Extension for Scikit-learn.
20+
As an open source project, we welcome community contributions to Extension for Scikit-learn.
2121
This document explains how to participate in project conversations, log bugs and enhancement requests, and submit code patches.
2222

2323
## Licensing
2424

25-
Intel(R) Extension for Scikit-learn uses the [Apache 2.0 License](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/LICENSE).
25+
Extension for Scikit-learn uses the [Apache 2.0 License](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/LICENSE).
2626
By contributing to the project, you agree to the license and copyright terms and release your own contributions under these terms.
2727

2828
## Pull Requests

INSTALL.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,23 @@
1818

1919
# Installation <!-- omit in toc -->
2020

21-
To install Intel(R) Extension for Scikit-learn*, use one of the following scenarios:
21+
To install Extension for Scikit-learn*, use one of the following scenarios:
2222

2323
- [Before You Begin](#before-you-begin)
2424
- [Install via PIP](#install-via-pip)
2525
- [Install from PyPI Channel (recommended by default)](#install-from-pypi-channel-recommended-by-default)
26-
- [Install from Anaconda Cloud](#install-from-anaconda-cloud)
27-
- [Install via Anaconda Cloud from Conda-Forge Channel](#install-via-anaconda-cloud-from-conda-forge-channel)
28-
- [Install via Anaconda Cloud from Intel Channel](#install-via-anaconda-cloud-from-intel-channel)
26+
- [Install via conda](#install-via-conda)
27+
- [Install from Conda-Forge Channel](#install-from-conda-forge-channel)
28+
- [Install from Intel conda Channel](#install-from-intel-conda-channel)
2929
- [Build from Sources](#build-from-sources)
3030
- [Prerequisites](#prerequisites)
3131
- [Configure the Build with Environment Variables](#configure-the-build-with-environment-variables)
32-
- [Build Intel(R) Extension for Scikit-learn](#build-intelr-extension-for-scikit-learn)
32+
- [Build Extension for Scikit-learn](#build-intelr-extension-for-scikit-learn)
3333
- [Build from Sources with `conda-build`](#build-from-sources-with-conda-build)
3434
- [Prerequisites for `conda-build`](#prerequisites-for-conda-build)
35-
- [Build Intel(R) Extension for Scikit-learn with `conda-build`](#build-intelr-extension-for-scikit-learn-with-conda-build)
35+
- [Build Extension for Scikit-learn with `conda-build`](#build-intelr-extension-for-scikit-learn-with-conda-build)
3636
- [Next Steps](#next-steps)
3737

38-
> **_NOTE:_** Intel(R) Extension for Scikit-learn* is also available as a part of [Intel® AI Tools](https://www.intel.com/content/www/us/en/developer/tools/oneapi/ai-analytics-toolkit.html). If you already have it installed, you do not need to separately install the extension.
39-
4038

4139
## Before You Begin
4240

@@ -49,8 +47,8 @@ Check [System](https://uxlfoundation.github.io/scikit-learn-intelex/latest/syste
4947
* Devices: CPU, GPU
5048
* Distribution channels:
5149
* PyPI
52-
* Anaconda Cloud from Conda-Forge Channel
53-
* Anaconda Cloud from Intel Channel (https://software.repos.intel.com/python/conda/)
50+
* Conda-Forge Channel
51+
* Intel conda Channel (https://software.repos.intel.com/python/conda/)
5452

5553
## Install via PIP
5654

@@ -78,11 +76,11 @@ Install `scikit-learn-intelex`:
7876
pip install scikit-learn-intelex
7977
```
8078

81-
## Install from Anaconda Cloud
79+
## Install via conda
8280

8381
To prevent version conflicts, we recommend to create and activate a new environment.
8482

85-
### Install via Anaconda Cloud from Conda-Forge Channel
83+
### Install from Conda-Forge Channel
8684

8785
- Install into a newly created environment (recommended):
8886

@@ -102,7 +100,7 @@ To prevent version conflicts, we recommend to create and activate a new environm
102100
conda install scikit-learn-intelex
103101
```
104102

105-
### Install via Anaconda Cloud from Intel Channel
103+
### Install Intel conda Channel
106104

107105
We recommend this installation for the users of Intel® Distribution for Python.
108106

@@ -133,7 +131,7 @@ We recommend this installation for the users of Intel® Distribution for Python.
133131
```
134132

135133
## Build from Sources
136-
Intel(R) Extension for Scikit-learn* is easily built from the sources with the majority of the necessary prerequisites available with conda or pip.
134+
Extension for Scikit-learn* is easily built from the sources with the majority of the necessary prerequisites available with conda or pip.
137135

138136
The package is available for Windows* OS, Linux* OS, and macOS*.
139137

@@ -153,7 +151,7 @@ The build-process (using setup.py) happens in 4 stages:
153151
* cmake and pybind11
154152
* A C++ compiler with C++11 support
155153
* Clang-Format version >=14
156-
* [Intel® oneAPI Data Analytics Library (oneDAL)](https://github.com/uxlfoundation/oneDAL) version 2021.1 or later, but be mindful that **the oneDAL version must be <= than that of scikit-learn-intelex** (it's backwards compatible but not forwards compatible).
154+
* [oneAPI Data Analytics Library (oneDAL)](https://github.com/uxlfoundation/oneDAL) version 2021.1 or later, but be mindful that **the oneDAL version must be <= than that of scikit-learn-intelex** (it's backwards compatible but not forwards compatible).
157155
* You can use the pre-built `dal-devel` conda package from conda-forge channel
158156
* MPI (optional, needed for distributed mode)
159157
* You can use the pre-built `impi_rt` and `impi-devel` conda packages from conda-forge channel
@@ -173,7 +171,7 @@ The build-process (using setup.py) happens in 4 stages:
173171
**Note:** The `-j` flag in the ``MAKEFLAGS`` environment variable is superseded in `setup.py` modes which support the ``--parallel`` and `-j` command line flags.
174172
175173
176-
### Build Intel(R) Extension for Scikit-learn
174+
### Build Extension for Scikit-learn
177175
178176
- To install the package:
179177
@@ -202,7 +200,7 @@ The build-process (using setup.py) happens in 4 stages:
202200
203201
Where:
204202
205-
* Keys `--single-version-externally-managed` and `--no-deps` are required to not download daal4py after the installation of Intel(R) Extension for Scikit-learn.
203+
* Keys `--single-version-externally-managed` and `--no-deps` are required to not download daal4py after the installation of Extension for Scikit-learn.
206204
* The `develop` mode does not install the package but creates a `.egg-link` in the deployment directory
207205
back to the project source-code directory. That way, you can edit the source code and see the changes
208206
without reinstalling the package after a small change.
@@ -227,7 +225,7 @@ python setup.py build --abs-rpath
227225

228226
## Build from Sources with `conda-build`
229227

230-
Intel(R) Extension for Scikit-learn* is easily built from the sources using only one command and `conda-build` utility.
228+
Extension for Scikit-learn* is easily built from the sources using only one command and `conda-build` utility.
231229

232230
### Prerequisites for `conda-build`
233231

@@ -241,7 +239,7 @@ Intel(R) Extension for Scikit-learn* is easily built from the sources using only
241239
In order to enable DPC++ interfaces support on Windows, you need to set `DPCPPROOT` environment variable pointing to DPC++/C++ Compiler distribution.
242240
Conda-forge distribution of DPC++ compiler is used by default on Linux, but you still can set your own distribution via `DPCPPROOT` variable.
243241

244-
### Build Intel(R) Extension for Scikit-learn with `conda-build`
242+
### Build Extension for Scikit-learn with `conda-build`
245243

246244
Create and verify `scikit-learn-intelex` conda package with next command executed from root of sklearnex repo:
247245

README.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
<div align="center">
1818

1919

20-
# Intel(R) Extension for Scikit-learn*
20+
# Extension for Scikit-learn*
2121

22-
<h3> Speed up your scikit-learn applications for Intel(R) CPUs and GPUs across single- and multi-node configurations
22+
<h3> Speed up your scikit-learn applications for CPUs and GPUs across single- and multi-node configurations
2323

2424
[Releases](https://github.com/uxlfoundation/scikit-learn-intelex/releases)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Documentation](https://uxlfoundation.github.io/scikit-learn-intelex/)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Examples](https://github.com/uxlfoundation/scikit-learn-intelex/tree/master/examples/notebooks)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Support]()&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;[License](https://github.com/uxlfoundation/scikit-learn-intelex/blob/master/LICENSE)&nbsp;&nbsp;&nbsp;
2525

@@ -39,29 +39,27 @@
3939

4040
## Overview
4141

42-
Intel(R) Extension for Scikit-learn is a **free software AI accelerator** designed to deliver over **10-100X** acceleration to your existing scikit-learn code.
43-
The software acceleration is achieved with vector instructions, AI hardware-specific memory optimizations, threading, and optimizations for all upcoming Intel(R) platforms at launch time.
42+
Extension for Scikit-learn is a **free software AI accelerator** designed to deliver over **10-100X** acceleration to your existing scikit-learn code.
43+
The software acceleration is achieved with vector instructions, AI hardware-specific memory optimizations, threading, and optimizations.
4444

4545

46-
With Intel(R) Extension for Scikit-learn, you can:
46+
With Extension for Scikit-learn, you can:
4747

4848
* Speed up training and inference by up to 100x with equivalent mathematical accuracy
49-
* Benefit from performance improvements across different Intel(R) hardware configurations, including GPUs and multi-GPU configurations
49+
* Benefit from performance improvements across different CPU hardware configurations, including GPUs and multi-GPU configurations
5050
* Integrate the extension into your existing Scikit-learn applications without code modifications
5151
* Continue to use the open-source scikit-learn API
5252
* Enable and disable the extension with a couple of lines of code or at the command line
5353

54-
Intel(R) Extension for Scikit-learn is also a part of [Intel(R) AI Tools](https://www.intel.com/content/www/us/en/developer/tools/oneapi/ai-analytics-toolkit.html).
55-
5654
## Acceleration
5755

5856
![](https://raw.githubusercontent.com/uxlfoundation/scikit-learn-intelex/master/doc/sources/_static/scikit-learn-acceleration.PNG)
5957

6058
[Benchmarks code](https://github.com/IntelPython/scikit-learn_bench)
6159

62-
## Intel(R) Optimizations
60+
## Optimizations
6361

64-
- **Enable Intel(R) CPU optimizations**
62+
- **Enable CPU optimizations**
6563

6664
```py
6765
import numpy as np
@@ -75,7 +73,7 @@ Intel(R) Extension for Scikit-learn is also a part of [Intel(R) AI Tools](https:
7573
clustering = DBSCAN(eps=3, min_samples=2).fit(X)
7674
```
7775

78-
- **Enable Intel(R) GPU optimizations**
76+
- **Enable GPU optimizations**
7977

8078
_Note: executing on GPU has [additional system software requirements](https://www.intel.com/content/www/us/en/developer/articles/system-requirements/intel-oneapi-dpcpp-system-requirements.html) - see [details](https://uxlfoundation.github.io/scikit-learn-intelex/latest/oneapi-gpu.html)._
8179

@@ -96,7 +94,7 @@ Intel(R) Extension for Scikit-learn is also a part of [Intel(R) AI Tools](https:
9694

9795
## Installation
9896

99-
To install Intel(R) Extension for Scikit-learn, run:
97+
To install Extension for Scikit-learn, run:
10098

10199
```
102100
pip install scikit-learn-intelex
@@ -136,8 +134,8 @@ To patch scikit-learn, you can:
136134
137135
### daal4py and oneDAL
138136
139-
The acceleration is achieved through the use of the Intel(R) oneAPI Data Analytics Library (oneDAL). Learn more:
140-
- [About Intel(R) oneAPI Data Analytics Library](https://github.com/uxlfoundation/oneDAL)
137+
The acceleration is achieved through the use of the oneAPI Data Analytics Library (oneDAL). Learn more:
138+
- [About oneAPI Data Analytics Library](https://github.com/uxlfoundation/oneDAL)
141139
- [About daal4py](https://github.com/uxlfoundation/scikit-learn-intelex/tree/main/daal4py)
142140
143141
## Samples & Examples

SECURITY.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@
1919

2020
As an open-source project, we understand the importance of and responsibility
2121
for security. This Security Policy outlines our guidelines and procedures to
22-
ensure the highest level of security and trust for Intel(R) Extension for Scikit-learn* users.
22+
ensure the highest level of security and trust for Extension for Scikit-learn* users.
2323

2424
## Supported Versions
2525

2626
Security vulnerabilities are fixed in the [latest version][1]
2727
and delivered as a patch release. We don't guarantee security fixes to be
28-
back-ported to older Intel(R) Extension for Scikit-learn* versions.
28+
back-ported to older Extension for Scikit-learn* versions.
2929

3030
## Report a Vulnerability
3131

@@ -52,24 +52,24 @@ Along with the report, provide the following info:
5252

5353
### When Should I Report a Vulnerability?
5454

55-
* You think you discovered a potential security vulnerability in Intel(R) Extension for Scikit-learn*.
56-
* You are unsure how the potential vulnerability affects Intel(R) Extension for Scikit-learn*.
55+
* You think you discovered a potential security vulnerability in Extension for Scikit-learn*.
56+
* You are unsure how the potential vulnerability affects Extension for Scikit-learn*.
5757
* You think you discovered a vulnerability in another project or 3rd party
58-
component on which Intel(R) Extension for Scikit-learn* depends. If the issue is not fixed in the 3rd party
58+
component on which Extension for Scikit-learn* depends. If the issue is not fixed in the 3rd party
5959
component, try to report directly there first.
6060

6161
### When Should I NOT Report a Vulnerability?
6262

6363
* You got an automated scan hit and are unable to provide details.
64-
* You need help using Intel(R) Extension for Scikit-learn* for security.
64+
* You need help using Extension for Scikit-learn* for security.
6565
* You need help applying security-related updates.
6666
* Your issue is not security-related.
6767

6868
## Security Reports Review Process
6969

7070
We aim to respond quickly to your inquiry and coordinate a fix and
7171
disclosure with you. All confirmed security vulnerabilities will be addressed
72-
according to severity level and impact on Intel(R) Extension for Scikit-learn*. Normally, security issues
72+
according to severity level and impact on Extension for Scikit-learn*. Normally, security issues
7373
are fixed in the next planned release.
7474

7575
## Disclosure Policy

SUPPORT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
* limitations under the License.
1616
*******************************************************************************/-->
1717

18-
# Intel(R) Extension for Scikit-learn Support
18+
# Extension for Scikit-learn Support
1919

20-
We are committed to providing support and assistance to help you make the most out of Intel(R) Extension for Scikit-learn.
20+
We are committed to providing support and assistance to help you make the most out of Extension for Scikit-learn.
2121
Use the following methods if you face any challenges.
2222

2323

@@ -34,7 +34,7 @@ Visit the [GitHub Discussions](https://github.com/uxlfoundation/scikit-learn-int
3434

3535
## Forum
3636

37-
Ask questions about Intel(R) Extension for Scikit-learn on our [Forum](https://community.intel.com/t5/Intel-Distribution-for-Python/bd-p/distribution-python).
37+
Ask questions about Extension for Scikit-learn on our [Forum](https://community.intel.com/t5/Intel-Distribution-for-Python/bd-p/distribution-python).
3838
Make sure to provide all relevant details, so we could help you as soon as possible.
3939

4040
## Email

conda-recipe/meta.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ about:
104104
license_file:
105105
- LICENSE
106106
- doc/third-party-programs-sklearnex.txt
107-
summary: Intel(R) Extension for Scikit-learn* is a seamless way to speed up your Scikit-learn application.
107+
summary: Extension for Scikit-learn* is a seamless way to speed up your Scikit-learn application.
108108
description: |
109109
<strong>LEGAL NOTICE: Use of this software package is subject to the
110110
software license agreement (as set forth above, in the license section of

daal4py/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
~ limitations under the License.
1515
-->
1616

17-
# daal4py - A Convenient Python API to the Intel(R) oneAPI Data Analytics Library
17+
# 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)
2020
[![Join the community on GitHub Discussions](https://badgen.net/badge/join%20the%20discussion/on%20github/black?icon=github)](https://github.com/IntelPython/daal4py/discussions)
@@ -23,9 +23,9 @@
2323

2424
**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.
2525

26-
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.
26+
A simplified API to 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 oneAPI Data Analytics Library for either direct usage or integration into one's own framework.
2727

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`.
28+
Note: For the most part, `daal4py` is used as an internal backend within the 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`.
2929

3030
## 👀 Follow us on Medium
3131

@@ -43,7 +43,7 @@ We publish blogs on Medium, so [follow us](https://medium.com/intel-analytics-so
4343
- [Documentation](https://intelpython.github.io/daal4py/)
4444
- [scikit-learn API and patching](https://intelpython.github.io/daal4py/sklearn.html#sklearn)
4545
- [Building from Sources](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/daal4py/INSTALL.md)
46-
- [About Intel(R) oneAPI Data Analytics Library](https://github.com/uxlfoundation/oneDAL)
46+
- [About oneAPI Data Analytics Library](https://github.com/uxlfoundation/oneDAL)
4747

4848
## 💬 Support
4949

@@ -78,12 +78,12 @@ pip install -U mpi4py impi_rt
7878
```
7979

8080
```shell
81-
# Anaconda Cloud for dpcpp
81+
# conda for dpcpp
8282
conda install dpcpp_cpp_rt dpctl -c https://software.repos.intel.com/python/conda/
8383
```
8484

8585
```shell
86-
# Anaconda Cloud for MPI
86+
# conda for MPI
8787
conda install mpi4py impi_rt -c https://software.repos.intel.com/python/conda/
8888
```
8989

@@ -92,4 +92,4 @@ conda install mpi4py impi_rt -c https://software.repos.intel.com/python/conda/
9292

9393
# ⚠️ Scikit-learn patching
9494

95-
Scikit-learn patching functionality in daal4py was deprecated and moved to a separate package - [Intel(R) Extension for Scikit-learn*](https://github.com/uxlfoundation/scikit-learn-intelex). All future updates for the patching will be available in Intel(R) Extension for Scikit-learn only. Please use the package instead of daal4py for the Scikit-learn acceleration.
95+
Scikit-learn patching functionality in daal4py was deprecated and moved to a separate package - [Extension for Scikit-learn*](https://github.com/uxlfoundation/scikit-learn-intelex). All future updates for the patching will be available in Extension for Scikit-learn only. Please use the package instead of daal4py for the Scikit-learn acceleration.

daal4py/__main__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def _main():
2727
description="""
2828
Run your Python script with Intel(R) Distribution for
2929
Python* patches of scikit-learn, optimizing solvers of
30-
scikit-learn with Intel(R) oneAPI Data Analytics Library.
30+
scikit-learn with oneAPI Data Analytics Library.
3131
""",
3232
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
3333
)

daal4py/sklearn/_n_jobs_support.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ def n_jobs_wrapper(self, *args, **kwargs):
8282
if not isinstance(threading.current_thread(), threading._MainThread):
8383
warn(
8484
"'Threading' parallel backend is not supported by "
85-
"Intel(R) Extension for Scikit-learn*. "
85+
"Extension for Scikit-learn*. "
8686
"Falling back to usage of all available threads."
8787
)
8888
result = method(self, *args, **kwargs)

0 commit comments

Comments
 (0)