Skip to content

Commit

Permalink
DOC: Update doc and internal links after uxl transfer (#2203)
Browse files Browse the repository at this point in the history
* update doc links after uxl transfer

* update also non-docs github URLs

* missing file

* missing link

* replace links also for oneDAL

* revert incorrect link for oneAPI-samples

* missing revertion
  • Loading branch information
david-cortes-intel authored Dec 9, 2024
1 parent 3dc01f3 commit 54aa18b
Show file tree
Hide file tree
Showing 46 changed files with 327 additions and 327 deletions.
2 changes: 1 addition & 1 deletion .github/Pull_Request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Checklist to comply with **before moving PR from draft**:
- [ ] I have reviewed my changes thoroughly before submitting this pull request.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have updated the documentation to reflect the changes or created a separate PR with update and provided its number in the description, if necessary.
- [ ] Git commit message contains an appropriate signed-off-by string _(see [CONTRIBUTING.md](https://github.com/intel/scikit-learn-intelex/blob/main/CONTRIBUTING.md#pull-requests) for details)_.
- [ ] Git commit message contains an appropriate signed-off-by string _(see [CONTRIBUTING.md](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/CONTRIBUTING.md#pull-requests) for details)_.
- [ ] I have added a respective label(s) to PR if I have a permission for that.
- [ ] I have resolved any merge conflicts that might occur with the base branch.

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This document explains how to participate in project conversations, log bugs and

## Licensing

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

## Pull Requests
Expand All @@ -47,7 +47,7 @@ Continuous Integration (CI) testing is enabled for the repository. Your pull req

## Code Style

We use [black](https://black.readthedocs.io/en/stable/) version 24.1.1 and [isort](https://pycqa.github.io/isort/) version 5.13.2 formatters for Python* code. The line length is 90 characters; use default options otherwise. You can find the linter configuration in [.pyproject.toml](https://github.com/intel/scikit-learn-intelex/blob/main/pyproject.toml).
We use [black](https://black.readthedocs.io/en/stable/) version 24.1.1 and [isort](https://pycqa.github.io/isort/) version 5.13.2 formatters for Python* code. The line length is 90 characters; use default options otherwise. You can find the linter configuration in [.pyproject.toml](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/pyproject.toml).

A GitHub* Action verifies if your changes comply with the output of the auto-formatting tools.

Expand Down
8 changes: 4 additions & 4 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To install Intel(R) Extension for Scikit-learn*, use one of the following scenar

## Before You Begin

Check [System](https://intel.github.io/scikit-learn-intelex/latest/system-requirements.html) and [Memory](https://intel.github.io/scikit-learn-intelex/latest/memory-requirements.html) Requirements.
Check [System](https://uxlfoundation.github.io/scikit-learn-intelex/latest/system-requirements.html) and [Memory](https://uxlfoundation.github.io/scikit-learn-intelex/latest/memory-requirements.html) Requirements.

## Supported Configurations

Expand Down Expand Up @@ -158,7 +158,7 @@ The build-process (using setup.py) happens in 4 stages:
* cmake and pybind11
* A C++ compiler with C++11 support
* Clang-Format
* [Intel® oneAPI Data Analytics Library (oneDAL)](https://github.com/oneapi-src/oneDAL) version 2021.1 or later
* [Intel® oneAPI Data Analytics Library (oneDAL)](https://github.com/uxlfoundation/oneDAL) version 2021.1 or later
* You can use the pre-built `dal-devel` conda package from conda-forge channel
* MPI (optional, needed for distributed mode)
* You can use the pre-built `impi_rt` and `impi-devel` conda packages from conda-forge channel
Expand Down Expand Up @@ -253,5 +253,5 @@ conda build .
## Next Steps
- [Learn what patching is and how to patch scikit-learn](https://intel.github.io/scikit-learn-intelex/latest/what-is-patching.html)
- [Start using scikit-learn-intelex](https://intel.github.io/scikit-learn-intelex/latest/quick-start.html)
- [Learn what patching is and how to patch scikit-learn](https://uxlfoundation.github.io/scikit-learn-intelex/latest/what-is-patching.html)
- [Start using scikit-learn-intelex](https://uxlfoundation.github.io/scikit-learn-intelex/latest/quick-start.html)
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

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

[Releases](https://github.com/intel/scikit-learn-intelex/releases)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Documentation](https://intel.github.io/scikit-learn-intelex/)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Examples](https://github.com/intel/scikit-learn-intelex/tree/master/examples/notebooks)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Support]()&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;[License](https://github.com/intel/scikit-learn-intelex/blob/master/LICENSE)&nbsp;&nbsp;&nbsp;
[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;


[![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)
[![Coverity Scan Build Status](https://scan.coverity.com/projects/21716/badge.svg)](https://scan.coverity.com/projects/daal4py)
[![Join the community on GitHub Discussions](https://badgen.net/badge/join%20the%20discussion/on%20github/black?icon=github)](https://github.com/intel/scikit-learn-intelex/discussions)
[![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)
[![PyPI Version](https://img.shields.io/pypi/v/scikit-learn-intelex)](https://pypi.org/project/scikit-learn-intelex/)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/scikit-learn-intelex)](https://anaconda.org/conda-forge/scikit-learn-intelex)
[![python version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)
Expand Down Expand Up @@ -39,7 +39,7 @@ Intel(R) Extension for Scikit-learn is also a part of [Intel(R) AI Tools](https:

## Acceleration

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

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

Expand Down Expand Up @@ -74,7 +74,7 @@ Intel(R) Extension for Scikit-learn is also a part of [Intel(R) AI Tools](https:
with config_context(target_offload="gpu:0"):
clustering = DBSCAN(eps=3, min_samples=2).fit(X)
```
:eyes: Check out available [notebooks](https://github.com/intel/scikit-learn-intelex/tree/master/examples/notebooks) for more examples.
:eyes: Check out available [notebooks](https://github.com/uxlfoundation/scikit-learn-intelex/tree/master/examples/notebooks) for more examples.

## Installation

Expand All @@ -84,16 +84,16 @@ To install Intel(R) Extension for Scikit-learn, run:
pip install scikit-learn-intelex
```

See all installation instructions in the [Installation Guide](https://intel.github.io/scikit-learn-intelex/latest/installation.html).
See all installation instructions in the [Installation Guide](https://uxlfoundation.github.io/scikit-learn-intelex/latest/installation.html).

## Integration

The software acceleration is achieved through patching. It means, replacing the stock scikit-learn algorithms with their optimized versions provided by the extension.

The patching only affects [supported algorithms and their parameters](https://intel.github.io/scikit-learn-intelex/latest/algorithms.html).
The patching only affects [supported algorithms and their parameters](https://uxlfoundation.github.io/scikit-learn-intelex/latest/algorithms.html).
You can still use not supported ones in your code, the package simply fallbacks into the stock version of scikit-learn.

> **_TIP:_** Enable [verbose mode](https://intel.github.io/scikit-learn-intelex/latest/verbose.html) to see which implementation of the algorithm is currently used.
> **_TIP:_** Enable [verbose mode](https://uxlfoundation.github.io/scikit-learn-intelex/latest/verbose.html) to see which implementation of the algorithm is currently used.

To patch scikit-learn, you can:
* Use the following command-line flag:
Expand All @@ -106,32 +106,32 @@ To patch scikit-learn, you can:
patch_sklearn()
```
:eyes: Read about [other ways to patch scikit-learn](https://intel.github.io/scikit-learn-intelex/index.html#usage).
:eyes: Read about [other ways to patch scikit-learn](https://uxlfoundation.github.io/scikit-learn-intelex/index.html#usage).
## Documentation
* [Quick Start](https://intel.github.io/scikit-learn-intelex/latest/quick-start.html)
* [Documentation and Tutorials](https://intel.github.io/scikit-learn-intelex/latest/index.html)
* [Release Notes](https://github.com/intel/scikit-learn-intelex/releases)
* [Medium Blogs](https://intel.github.io/scikit-learn-intelex/latest/blogs.html)
* [Code of Conduct](https://github.com/intel/scikit-learn-intelex/blob/master/CODE_OF_CONDUCT.md)
* [Quick Start](https://uxlfoundation.github.io/scikit-learn-intelex/latest/quick-start.html)
* [Documentation and Tutorials](https://uxlfoundation.github.io/scikit-learn-intelex/latest/index.html)
* [Release Notes](https://github.com/uxlfoundation/scikit-learn-intelex/releases)
* [Medium Blogs](https://uxlfoundation.github.io/scikit-learn-intelex/latest/blogs.html)
* [Code of Conduct](https://github.com/uxlfoundation/scikit-learn-intelex/blob/master/CODE_OF_CONDUCT.md)
### daal4py and oneDAL
The acceleration is achieved through the use of the Intel(R) oneAPI Data Analytics Library (oneDAL). Learn more:
- [About Intel(R) oneAPI Data Analytics Library](https://github.com/oneapi-src/oneDAL)
- [About daal4py](https://github.com/intel/scikit-learn-intelex/tree/main/daal4py)
- [About Intel(R) oneAPI Data Analytics Library](https://github.com/uxlfoundation/oneDAL)
- [About daal4py](https://github.com/uxlfoundation/scikit-learn-intelex/tree/main/daal4py)
## Samples & Examples
* [Examples](https://github.com/intel/scikit-learn-intelex/tree/master/examples/notebooks)
* [Samples](https://intel.github.io/scikit-learn-intelex/latest/samples.html)
* [Kaggle Kernels](https://intel.github.io/scikit-learn-intelex/latest/kaggle.html)
* [Examples](https://github.com/uxlfoundation/scikit-learn-intelex/tree/master/examples/notebooks)
* [Samples](https://uxlfoundation.github.io/scikit-learn-intelex/latest/samples.html)
* [Kaggle Kernels](https://uxlfoundation.github.io/scikit-learn-intelex/latest/kaggle.html)
## How to Contribute
We welcome community contributions, check our [Contributing Guidelines](https://github.com/intel/scikit-learn-intelex/blob/master/CONTRIBUTING.md) to learn more.
We welcome community contributions, check our [Contributing Guidelines](https://github.com/uxlfoundation/scikit-learn-intelex/blob/master/CONTRIBUTING.md) to learn more.
------------------------------------------------------------------------
\* The Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.
Expand Down
6 changes: 3 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,6 @@ If you have any suggestions on how this Policy could be improved, submit
an issue or a pull request to this repository. **Do not** report
potential vulnerabilities or security flaws via a pull request.

[1]: https://github.com/intel/scikit-learn-intelex/releases/latest
[2]: https://github.com/intel/scikit-learn-intelex/security/advisories/new
[3]: https://github.com/intel/scikit-learn-intelex/security/advisories
[1]: https://github.com/uxlfoundation/scikit-learn-intelex/releases/latest
[2]: https://github.com/uxlfoundation/scikit-learn-intelex/security/advisories/new
[3]: https://github.com/uxlfoundation/scikit-learn-intelex/security/advisories
4 changes: 2 additions & 2 deletions SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ Use the following methods if you face any challenges.

## Issues

If you have a problem, check out the [GitHub Issues](https://github.com/intel/scikit-learn-intelex/issues) to see if the issue you want to address is already reported.
If you have a problem, check out the [GitHub Issues](https://github.com/uxlfoundation/scikit-learn-intelex/issues) to see if the issue you want to address is already reported.
You may find users that have encountered the same bug or have similar ideas for changes or updates.

You can use issues to report a problem, make a feature request, or add comments on an existing issue.

## Discussions

Visit the [GitHub Discussions](https://github.com/intel/scikit-learn-intelex/discussions) to engage with the community, ask questions, or help others.
Visit the [GitHub Discussions](https://github.com/uxlfoundation/scikit-learn-intelex/discussions) to engage with the community, ask questions, or help others.

## Forum

Expand Down
8 changes: 4 additions & 4 deletions conda-recipe/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ package:

# Reminder: source should point to path for repo or github archive for feedstock
# source:
# url: https://github.com/intel/scikit-learn-intelex/archive/{{ version }}.tar.gz
# url: https://github.com/uxlfoundation/scikit-learn-intelex/archive/{{ version }}.tar.gz
# sha256: ...
source:
path: ..
Expand Down Expand Up @@ -99,7 +99,7 @@ test:
- tests

about:
home: https://intel.github.io/scikit-learn-intelex
home: https://uxlfoundation.github.io/scikit-learn-intelex
license: Apache-2.0
license_file:
- LICENSE
Expand All @@ -114,8 +114,8 @@ about:
<br/><br/>
EULA: <a href="https://opensource.org/licenses/Apache-2.0" target="_blank">Apache-2.0</a>
<br/><br/>
dev_url: https://github.com/intel/scikit-learn-intelex
doc_url: https://intel.github.io/scikit-learn-intelex
dev_url: https://github.com/uxlfoundation/scikit-learn-intelex
doc_url: https://uxlfoundation.github.io/scikit-learn-intelex

extra:
recipe-maintainers:
Expand Down
12 changes: 6 additions & 6 deletions daal4py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ We publish blogs on Medium, so [follow us](https://medium.com/intel-analytics-so
## 🔗 Important links
- [Documentation](https://intelpython.github.io/daal4py/)
- [scikit-learn API and patching](https://intelpython.github.io/daal4py/sklearn.html#sklearn)
- [Building from Sources](https://github.com/intel/scikit-learn-intelex/blob/main/daal4py/INSTALL.md)
- [About Intel(R) oneAPI Data Analytics Library](https://github.com/oneapi-src/oneDAL)
- [Building from Sources](https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/daal4py/INSTALL.md)
- [About Intel(R) oneAPI Data Analytics Library](https://github.com/uxlfoundation/oneDAL)

## 💬 Support

Report issues, ask questions, and provide suggestions using:

- [GitHub Issues](https://github.com/intel/scikit-learn-intelex/issues)
- [GitHub Discussions](https://github.com/intel/scikit-learn-intelex/discussions)
- [GitHub Issues](https://github.com/uxlfoundation/scikit-learn-intelex/issues)
- [GitHub Discussions](https://github.com/uxlfoundation/scikit-learn-intelex/discussions)
- [Forum](https://community.intel.com/t5/Intel-Distribution-for-Python/bd-p/distribution-python)

You may reach out to project maintainers privately at [email protected]
Expand Down Expand Up @@ -110,9 +110,9 @@ conda install impi_rt -c intel

</details>

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


# ⚠️ Scikit-learn patching

Scikit-learn patching functionality in daal4py was deprecated and moved to a separate package - [Intel(R) Extension for Scikit-learn*](https://github.com/intel/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.
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.
2 changes: 1 addition & 1 deletion deselected_tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ deselected_tests:
- ensemble/tests/test_stacking.py::test_stacking_with_sample_weight[StackingClassifier]

# Insufficient accuracy of "coefs" and "intercept" in Elastic Net for multi-target problems
# https://github.com/oneapi-src/oneDAL/issues/494
# https://github.com/uxlfoundation/oneDAL/issues/494
- linear_model/tests/test_coordinate_descent.py::test_enet_multitarget

# oneAPI Data Analytics Library (oneDAL) doesn't support sample_weight (back to scikit-learn),
Expand Down
2 changes: 1 addition & 1 deletion doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To build Intel(R) Extension for Scikit-Learn documentation locally:

1. Clone the repository:

git clone https://github.com/intel/scikit-learn-intelex.git
git clone https://github.com/uxlfoundation/scikit-learn-intelex.git

2. Install required Python packages using `pip`:

Expand Down
2 changes: 1 addition & 1 deletion doc/daal4py/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
var wapLocalCode = 'us-en'; // Dynamically set per localized site, see mapping table for values
var wapSection = "scikit-learn"; // WAP team will give you a unique section for your site
// Load TMS
if(document.location.href.contains("intel.github.io/scikit-learn-intelex")){
if(document.location.href.contains("uxlfoundation.github.io/scikit-learn-intelex")){
(function () {
var url = 'https://www.intel.com/content/dam/www/global/wap/tms-loader.js'; // WAP file URL
var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true; po.src = url;
Expand Down
Loading

0 comments on commit 54aa18b

Please sign in to comment.