.. ******************************************************************************
.. * Copyright 2020 Intel Corporation
.. *
.. * Licensed under the Apache License, Version 2.0 (the "License");
.. * you may not use this file except in compliance with the License.
.. * You may obtain a copy of the License at
.. *
.. *     http://www.apache.org/licenses/LICENSE-2.0
.. *
.. * Unless required by applicable law or agreed to in writing, software
.. * distributed under the License is distributed on an "AS IS" BASIS,
.. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. * See the License for the specific language governing permissions and
.. * limitations under the License.
.. *******************************************************************************/

.. |intelex_repo| replace:: |intelex| repository
.. _intelex_repo: https://github.com/intel/scikit-learn-intelex

.. _index:

#########
|intelex|
#########

With |intelex| you can accelerate your Scikit-learn applications and
still have full conformance with all Scikit-Learn APIs and algorithms.
|intelex| is a free software AI accelerator that brings over 10-100X acceleration across a variety of applications.

|intelex| offers you a way to accelerate existing scikit-learn code.
The acceleration is achieved through :term:`patching`:
replacing the stock scikit-learn algorithms with their optimized versions provided by the extension.

.. rubric:: Designed for Data Scientists and Framework Designers

|intelex| was created to provide data scientists with a way to get a better performance
while using the familiar scikit-learn package and getting the same results.

Usage
------

.. include:: usage.rst

Important Links
--------------------
- |intelex_repo|_
- `Machine Learning Benchmarks <https://github.com/IntelPython/scikit-learn_bench>`_
- `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>`_

.. toctree::
   :caption: Get Started
   :titlesonly: 
   :hidden:
   :maxdepth: 1

   quick-start.rst
   what-is-patching.rst
   support.rst
   
.. toctree::
   :caption: Features
   :hidden:
   :maxdepth: 2

   algorithms.rst
   oneAPI and GPU support <oneapi-gpu.rst>
   distributed-mode.rst
   verbose.rst

.. toctree::
   :caption: Releases
   :hidden:
   :maxdepth: 2

   releases.rst
   deprecation.rst

.. toctree::
   :caption: Installation Guide
   :hidden:
   :maxdepth: 2

   installation.rst
   System Requirements <system-requirements.rst>
   memory-requirements.rst

.. toctree::
   :caption: Examples
   :hidden:
   :maxdepth: 2

   samples.rst
   kaggle.rst

.. toctree::
   :caption: Performance
   :hidden:
   :maxdepth: 2

   acceleration.rst
   guide/acceleration.rst

.. toctree::
   :caption: Blogs & Publications
   :hidden:
   :maxdepth: 2

   Medium Blogs <blogs.rst>

.. toctree::
   :caption: How to contribute
   :hidden:
   :maxdepth: 2

   contribute.rst

.. toctree::
   :caption: License
   :hidden:
   :maxdepth: 2

   license.rst