Skip to content

Commit

Permalink
chore: rename master branch to main (#1614)
Browse files Browse the repository at this point in the history
  • Loading branch information
homksei authored Dec 13, 2023
1 parent 21d58a3 commit 61f27db
Show file tree
Hide file tree
Showing 22 changed files with 197 additions and 199 deletions.
4 changes: 2 additions & 2 deletions .ci/pipeline/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
trigger:
branches:
include:
- master
- main
- rls/*
paths:
exclude:
Expand All @@ -28,7 +28,7 @@ trigger:
pr:
branches:
include:
- master
- main
- rls/*
paths:
exclude:
Expand Down
4 changes: 2 additions & 2 deletions .ci/pipeline/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
trigger:
branches:
include:
- master
- main
- rls/*
paths:
include:
Expand All @@ -28,7 +28,7 @@ trigger:
pr:
branches:
include:
- master
- main
- rls/*
paths:
include:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/renovate-validation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ name: renovate-validation
on:
pull_request:
branches:
- master
- main
paths:
- .github/workflows/renovate-validation.yml
- .github/renovate.json
push:
branches:
- master
- main
paths:
- .github/workflows/renovate-validation.yml
- .github/renovate.json
Expand Down
6 changes: 3 additions & 3 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/master/LICENSE).
Intel(R) Extension for Scikit-learn uses the [Apache 2.0 License](https://github.com/intel/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 @@ -41,13 +41,13 @@ Make sure your ``.gitconfig`` is set up correctly so you can use `git commit -s`
* For a larger feature, provide a relevant test.
* Document your code. Our project uses reStructuredText for documentation.
* For new file(s), specify the appropriate copyright year in the first line.
* Submit a pull request into the master branch.
* Submit a pull request into the main branch.

Continuous Integration (CI) testing is enabled for the repository. Your pull request must pass all checks before it can be merged. We will review your contribution and may provide feedback to guide you if any additional fixes or modifications are necessary. When reviewed and accepted, your pull request will be merged into our GitHub repository.

## Code Style

We use [black](https://black.readthedocs.io/en/stable/) and [isort](https://pycqa.github.io/isort/) 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/master/pyproject.toml).
We use [black](https://black.readthedocs.io/en/stable/) and [isort](https://pycqa.github.io/isort/) 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).

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

Expand Down
2 changes: 1 addition & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Intel(R) Extension for Scikit-learn is easily built from sources with the majori
* Python version >= 3.8, <= 3.11
* daal4py >= 2024.0

**NOTE:** You can [build daal4py from sources](https://github.com/intel/scikit-learn-intelex/blob/master/daal4py/INSTALL.md) or get it from [distribution channels](https://intelpython.github.io/daal4py/#getting-daal4py).
**NOTE:** You can [build daal4py from sources](https://github.com/intel/scikit-learn-intelex/blob/main/daal4py/INSTALL.md) or get it from [distribution channels](https://intelpython.github.io/daal4py/#getting-daal4py).

### Configure the build with environment variables
* SKLEARNEX_VERSION: sets package version
Expand Down
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Intel(R) Extension for Scikit-learn* <a href="#oneapi"> <img align="right" width="100" height="100" src="https://spec.oneapi.io/oneapi-logo-white-scaled.jpg"></a>

[Installation](INSTALL.md)&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](#-support)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[FAQ](#-faq)&nbsp;&nbsp;&nbsp;
[Installation](INSTALL.md)&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/main/examples/notebooks)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Support](#-support)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[FAQ](#-faq)&nbsp;&nbsp;&nbsp;

[![Build Status](https://dev.azure.com/daal/daal4py/_apis/build/status/CI?branchName=master)](https://dev.azure.com/daal/daal4py/_build/latest?definitionId=9&branchName=master)
[![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)
[![PyPI Version](https://img.shields.io/pypi/v/scikit-learn-intelex)](https://pypi.org/project/scikit-learn-intelex/)
Expand Down Expand Up @@ -50,7 +50,7 @@ One of the ways to patch scikit-learn is by modifying the code. First, you impor
```

👀 Read about [other ways to patch scikit-learn](https://intel.github.io/scikit-learn-intelex/index.html#usage) and [other methods for offloading to GPU devices](https://intel.github.io/scikit-learn-intelex/latest/oneapi-gpu.html).
Check out available [notebooks](https://github.com/intel/scikit-learn-intelex/tree/master/examples/notebooks) for more examples.
Check out available [notebooks](https://github.com/intel/scikit-learn-intelex/tree/main/examples/notebooks) for more examples.

This software acceleration is achieved through the use of vector instructions, IA hardware-specific memory optimizations, threading, and optimizations for all upcoming Intel platforms at launch time.

Expand All @@ -62,7 +62,7 @@ You may still use algorithms and parameters not supported by Intel(R) Extension

## 🚀 Acceleration

![](https://raw.githubusercontent.com/intel/scikit-learn-intelex/master/doc/sources/_static/scikit-learn-acceleration-2021.2.3.PNG)
![](https://raw.githubusercontent.com/intel/scikit-learn-intelex/main/doc/sources/_static/scikit-learn-acceleration-2021.2.3.PNG)
Configurations:
- HW: c5.24xlarge AWS EC2 Instance using an Intel Xeon Platinum 8275CL with 2 sockets and 24 cores per socket
- SW: scikit-learn version 0.24.2, scikit-learn-intelex version 2021.2.3, Python 3.8
Expand All @@ -71,7 +71,7 @@ Configurations:

## 🛠 Installation

[System Requirements](https://intel.github.io/scikit-learn-intelex/latest/system-requirements.html)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp; [Install via pip or conda](https://github.com/intel/scikit-learn-intelex/blob/master/INSTALL.md)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Build from sources](INSTALL.md#build-from-sources)
[System Requirements](https://intel.github.io/scikit-learn-intelex/latest/system-requirements.html)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp; [Install via pip or conda](https://github.com/intel/scikit-learn-intelex/blob/main/INSTALL.md)&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;[Build from sources](INSTALL.md#build-from-sources)

Intel(R) Extension for Scikit-learn is available at the [Python Package Index](https://pypi.org/project/scikit-learn-intelex/),
on Anaconda Cloud in [Conda-Forge channel](https://anaconda.org/conda-forge/scikit-learn-intelex) and in [Intel channel](https://anaconda.org/intel/scikit-learn-intelex). You can also build the extension from [sources](INSTALL.md#build-from-sources).
Expand All @@ -85,7 +85,7 @@ pip install scikit-learn-intelex
```

## 🔗 Important Links
- [Notebook examples](https://github.com/intel/scikit-learn-intelex/tree/master/examples/notebooks)
- [Notebook examples](https://github.com/intel/scikit-learn-intelex/tree/main/examples/notebooks)
- [Documentation](https://intel.github.io/scikit-learn-intelex/)
- [Supported algorithms and parameters](https://intel.github.io/scikit-learn-intelex/latest/algorithms.html)
- [Machine Learning Benchmarks](https://github.com/IntelPython/scikit-learn_bench)
Expand Down Expand Up @@ -154,11 +154,10 @@ Intel(R) Extension for Scikit-learn is part of [oneAPI](https://oneapi.io) and [

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/master/daal4py)
- [About daal4py](https://github.com/intel/scikit-learn-intelex/tree/main/daal4py)

---
⚠️Intel(R) Extension for Scikit-learn contains scikit-learn patching functionality that was originally available in [**daal4py**](https://github.com/intel/scikit-learn-intelex/tree/master/daal4py) package. All future updates for the patches will be available only in Intel(R) Extension for Scikit-learn. We recommend you to use scikit-learn-intelex package instead of daal4py.
⚠️Intel(R) Extension for Scikit-learn contains scikit-learn patching functionality that was originally available in [**daal4py**](https://github.com/intel/scikit-learn-intelex/tree/main/daal4py) package. All future updates for the patches will be available only in Intel(R) Extension for Scikit-learn. We recommend you to use scikit-learn-intelex package instead of daal4py.
You can learn more about daal4py in [daal4py documentation](https://intelpython.github.io/daal4py).

---

6 changes: 3 additions & 3 deletions daal4py/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# daal4py - A Convenient Python API to the Intel(R) oneAPI Data Analytics Library
[![Build Status](https://dev.azure.com/daal/daal4py/_apis/build/status/CI?branchName=master)](https://dev.azure.com/daal/daal4py/_build/latest?definitionId=9&branchName=master)
[![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/IntelPython/daal4py/discussions)
[![PyPI Version](https://img.shields.io/pypi/v/daal4py)](https://pypi.org/project/daal4py/)
Expand All @@ -23,7 +23,7 @@ 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/master/daal4py/INSTALL.md)
- [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)

## 💬 Support
Expand Down Expand Up @@ -110,7 +110,7 @@ conda install impi_rt -c intel

</details>

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


# ⚠️ Scikit-learn patching
Expand Down
Loading

0 comments on commit 61f27db

Please sign in to comment.