.. ******************************************************************************
.. * Copyright 2019-2021 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.
.. *******************************************************************************/

.. daal_rst documentation master file, created by
   sphinx-quickstart on Mon May 20 15:10:10 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. |daal-docs| replace:: oneAPI Data Analytics Library
.. _daal-docs: https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/onedal.html

.. |github| replace:: |short_name| GitHub\* page
.. _github: https://github.com/oneapi-src/oneDAL

.. |spec| replace:: |short_name| specification
.. _spec: https://spec.oneapi.com/versions/latest/elements/oneDAL/source/index.html

|full_name|
------------------------------------------------------

|full_name| (|short_name|) is a library
that helps speed up big data analysis by providing highly optimized
algorithmic building blocks for all stages of data analytics
(preprocessing, transformation, analysis, modeling, validation, and
decision making) in batch, online, and distributed processing modes of
computation. The library provides two different sets of C++ interfaces: :ref:`oneAPI and DAAL <oneapi_vs_daal>`.

For general information, refer to |daal-docs|_ official page.

.. _oneapi_vs_daal:

oneAPI vs. DAAL Interfaces
==========================

- :ref:`oneapi_dal_guide` are based on open |spec|_ and are currently under an active development.
  They work on various hardware but only a limited set of algorithms is available at the moment.

- :ref:`daal_guide` are CPU-only interfaces that provide implementations for a wide range of algorithms.

.. toctree::
   :hidden:
   :caption: Introduction

   installation.rst

.. toctree::
   :maxdepth: 3
   :caption: Developer Guide

   data-analytics-pipeline.rst
   oneapi-interfaces.rst
   daal-interfaces.rst
   bibliography.rst

.. toctree::
   :maxdepth: 3
   :caption: API Reference

   api/index.rst

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Notes

   notes/known_issues.rst
   legal.rst

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Contributing Guide

   contribution/coding_guide.rst