From 78e7e2e2923c1489aaf86c4bf6aeb36519a702bd Mon Sep 17 00:00:00 2001 From: emmwalsh <148352712+emmwalsh@users.noreply.github.com> Date: Fri, 19 Apr 2024 12:11:11 +0100 Subject: [PATCH 1/7] Update data-analytics-pipeline.rst --- docs/source/data-analytics-pipeline.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/source/data-analytics-pipeline.rst b/docs/source/data-analytics-pipeline.rst index 107c2ff1ff0..4cd9f32845e 100644 --- a/docs/source/data-analytics-pipeline.rst +++ b/docs/source/data-analytics-pipeline.rst @@ -19,9 +19,6 @@ Introduction .. _onedal_data_analytics_pipeline: -Data Analytics Pipeline -*********************** - |full_name| (|short_name|) is a library that provides building blocks covering all stages of data analytics: data acquisition from a data source, preprocessing, transformation, data mining, modeling, From 08d7ce450f725f79e55abe06ad97b260e07868bf Mon Sep 17 00:00:00 2001 From: emmwalsh <148352712+emmwalsh@users.noreply.github.com> Date: Tue, 21 May 2024 14:19:05 +0100 Subject: [PATCH 2/7] Update build-application.rst --- docs/source/onedal/build_app/build-application.rst | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/docs/source/onedal/build_app/build-application.rst b/docs/source/onedal/build_app/build-application.rst index 7574d8b9cbf..5e7249b29bb 100644 --- a/docs/source/onedal/build_app/build-application.rst +++ b/docs/source/onedal/build_app/build-application.rst @@ -29,7 +29,7 @@ Applications on Linux* OS #. Install |short_name|. -#. Set environment variables by calling ``/setvars.sh``. +#. Set environment variables by calling ``/vars.sh``. #. Build the application using ``icpx`` (Linux* OS) and ``icx-cl`` (Windows* OS) commands: @@ -117,13 +117,11 @@ Applications on Windows* OS * - Static linking - - | onedal_core.lib, | onedal_core.lib, | onedal_thread.lib * - Dynamic linking - | onedal_core_dll.lib - | onedal_core_dll.lib You may also add debug versions of the libraries based on the threading mode and linking method: @@ -137,10 +135,6 @@ Applications on Windows* OS * - Static linking - - | onedal_cored.lib, - | onedald.lib, - | onedal_dpcd.lib, - | onedal_sycld.lib, | onedal_cored.lib, | onedald.lib, | onedal_dpcd.lib, @@ -148,12 +142,6 @@ Applications on Windows* OS | onedal_threadd.lib * - Dynamic linking - - | onedal_cored_dll.lib (onedal_cored_dll.2.lib), - | onedald_dll.lib (onedald_dll.2.lib), - | onedal_dpcd_dll.lib (onedal_dpcd_dll.2.lib), - | onedald.2.dll, - | onedal_cored.2.dll, - | onedal_dpcd.2.dll, | onedal_cored_dll.lib (onedal_cored_dll.2.lib), | onedald_dll.lib (onedald_dll.2.lib), | onedal_dpcd_dll.lib (onedal_dpcd_dll.2.lib), From 254c5a15aab49201fcfd3aaa73eb0556904dfce7 Mon Sep 17 00:00:00 2001 From: emmwalsh <148352712+emmwalsh@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:40:04 +0000 Subject: [PATCH 3/7] broken links cant find where the links have been moved --- docs/source/deprecation.rst | 2 +- docs/source/index.rst | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/source/deprecation.rst b/docs/source/deprecation.rst index 898a16e1e9e..41d99434db8 100644 --- a/docs/source/deprecation.rst +++ b/docs/source/deprecation.rst @@ -34,7 +34,7 @@ The project offers a comprehensive set of optimized libraries, including the OAP DAAL CPP SYCL Interfaces ************************ -**Deprecation:** The `DAAL CPP SYCL Interfaces `_ in the oneDAL library are deprecated. Starting with the 2024.0 release, oneDAL will not support the DAAL CPP SYCL Interfaces. +**Deprecation:** The `DAAL CPP SYCL Interfaces in the oneDAL library are deprecated. Starting with the 2024.0 release, oneDAL will not support the DAAL CPP SYCL Interfaces. **Reasons for deprecation:** Deprecating initial version of SYCL interfaces in favour of oneDAL SYCL interfaces. The ongoing efforts to optimize oneDAL resources and focus strongly on the most widely used features. diff --git a/docs/source/index.rst b/docs/source/index.rst index c46771e6556..6e6bd9ac0bf 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -20,7 +20,6 @@ contain the root `toctree` directive. .. |spec| replace:: |short_name| specification -.. _spec: https://spec.oneapi.com/versions/latest/elements/oneDAL/source/index.html |full_name| (|short_name|) ------------------------------------------------------ From 23882d47dfd71e0bb65457959712c5577b861d33 Mon Sep 17 00:00:00 2001 From: Emm Walsh <148352712+emmwalsh@users.noreply.github.com> Date: Tue, 29 Oct 2024 17:51:30 +0000 Subject: [PATCH 4/7] Update docs/source/deprecation.rst Co-authored-by: ethanglaser <42726565+ethanglaser@users.noreply.github.com> --- docs/source/deprecation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/deprecation.rst b/docs/source/deprecation.rst index 41d99434db8..1d43edfccd8 100644 --- a/docs/source/deprecation.rst +++ b/docs/source/deprecation.rst @@ -34,7 +34,7 @@ The project offers a comprehensive set of optimized libraries, including the OAP DAAL CPP SYCL Interfaces ************************ -**Deprecation:** The `DAAL CPP SYCL Interfaces in the oneDAL library are deprecated. Starting with the 2024.0 release, oneDAL will not support the DAAL CPP SYCL Interfaces. +**Deprecation:** The DAAL CPP SYCL Interfaces in the oneDAL library are deprecated. Starting with the 2024.0 release, oneDAL will not support the DAAL CPP SYCL Interfaces. **Reasons for deprecation:** Deprecating initial version of SYCL interfaces in favour of oneDAL SYCL interfaces. The ongoing efforts to optimize oneDAL resources and focus strongly on the most widely used features. From 01754aa780e52888c0d45ec466f55d57a0085b10 Mon Sep 17 00:00:00 2001 From: emmwalsh <148352712+emmwalsh@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:07:52 +0000 Subject: [PATCH 5/7] broken links edits --- docs/source/deprecation.rst | 11 ----------- docs/source/index.rst | 2 ++ 2 files changed, 2 insertions(+), 11 deletions(-) diff --git a/docs/source/deprecation.rst b/docs/source/deprecation.rst index 1d43edfccd8..50641ecbd88 100644 --- a/docs/source/deprecation.rst +++ b/docs/source/deprecation.rst @@ -30,17 +30,6 @@ Java* Interfaces **Alternatives:** Intel(R) Optimized Analytics Package* (OAP) project for the Spark* users. The project offers a comprehensive set of optimized libraries, including the OAP* MLlib* component. For more information, visit https://github.com/oap-project/oap-mllib. - -DAAL CPP SYCL Interfaces -************************ - -**Deprecation:** The DAAL CPP SYCL Interfaces in the oneDAL library are deprecated. Starting with the 2024.0 release, oneDAL will not support the DAAL CPP SYCL Interfaces. - -**Reasons for deprecation:** Deprecating initial version of SYCL interfaces in favour of oneDAL SYCL interfaces. The ongoing efforts to optimize oneDAL resources and focus strongly on the most widely used features. - -**Alternatives:** `oneDAL SYCL interfaces `_ - - Compression Functionality ************************* diff --git a/docs/source/index.rst b/docs/source/index.rst index 6e6bd9ac0bf..a1a6362f1ab 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -20,6 +20,8 @@ contain the root `toctree` directive. .. |spec| replace:: |short_name| specification +.. _spec: https://oneapi-spec.uxlfoundation.org/specifications/oneapi/v1.3-rev-1/elements/onedal/source/# + |full_name| (|short_name|) ------------------------------------------------------ From 34386e658b35e9158325857ec5b01986ff0b7512 Mon Sep 17 00:00:00 2001 From: emmwalsh <148352712+emmwalsh@users.noreply.github.com> Date: Wed, 30 Oct 2024 13:13:27 +0000 Subject: [PATCH 6/7] Trademark fixes --- docs/source/deprecation.rst | 2 +- docs/source/onedal/algorithms/clustering/kmeans.rst | 2 +- docs/source/onedal/algorithms/decomposition/pca.rst | 2 +- docs/source/onedal/gpu_support.rst | 2 +- docs/source/onedal/introduction.rst | 2 +- docs/source/onedal/spmd/index.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/deprecation.rst b/docs/source/deprecation.rst index 50641ecbd88..78e53b5211c 100644 --- a/docs/source/deprecation.rst +++ b/docs/source/deprecation.rst @@ -18,7 +18,7 @@ Deprecation Notice ================== -This page provides information about the deprecations of a specific oneDAL functionality. +This page provides information about the deprecations of a specific Intel(R) oneAPI Data Analytics Library (oneDAL) functionality. Java* Interfaces **************** diff --git a/docs/source/onedal/algorithms/clustering/kmeans.rst b/docs/source/onedal/algorithms/clustering/kmeans.rst index 899cdf9b988..bbee5da67e0 100644 --- a/docs/source/onedal/algorithms/clustering/kmeans.rst +++ b/docs/source/onedal/algorithms/clustering/kmeans.rst @@ -52,7 +52,7 @@ Expression :math:`\|\cdot\|` denotes :math:`L_2` `norm .. note:: In the general case, :math:`d` may be an arbitrary distance function. Current - version of the oneDAL spec defines only Euclidean distance case. + version of the Intel(R) oneAPI Data Analytics Library (oneDAL) specification defines only Euclidean distance case. .. _kmeans_t_math_lloyd: diff --git a/docs/source/onedal/algorithms/decomposition/pca.rst b/docs/source/onedal/algorithms/decomposition/pca.rst index 4c167538412..7c24d012b36 100644 --- a/docs/source/onedal/algorithms/decomposition/pca.rst +++ b/docs/source/onedal/algorithms/decomposition/pca.rst @@ -76,7 +76,7 @@ The PCA algorithm can be trained using either the covariance or the correlation The choice of covariance matrix or correlation matrix is application-dependent. More specifically, if scaling of the features is important for a problem, which is often the case, using the correlation matrix to compute principal components is more appropriate. -By default, oneDAL uses the correlation matrix to compute the principal components. It is possible +By default, Intel(R) oneAPI Data Analytics Library (oneDAL) uses the correlation matrix to compute the principal components. It is possible to use the covariance matrix by passing "precomputed" as method and feeding a covariance matrix as input to the PCA algorithm. To compute the covariance matrix, the :ref:`Covariance ` algorithm can be used. diff --git a/docs/source/onedal/gpu_support.rst b/docs/source/onedal/gpu_support.rst index 5a8d5f570b2..d985631506a 100644 --- a/docs/source/onedal/gpu_support.rst +++ b/docs/source/onedal/gpu_support.rst @@ -23,7 +23,7 @@ See the differences in CPU and GPU support below. GPU-Supported Targets ********************* -OneDAL is designed to work with Intel(R) GPUs specifically, but it could potentially +Intel(R) oneAPI Data Analytics Library (oneDAL) is designed to work with Intel(R) GPUs specifically, but it could potentially run on other hardware platforms if a SYCL runtime is available. .. tabularcolumns:: |\Y{0.5}|\Y{0.5}| diff --git a/docs/source/onedal/introduction.rst b/docs/source/onedal/introduction.rst index fc08072a8af..7fb3023e306 100644 --- a/docs/source/onedal/introduction.rst +++ b/docs/source/onedal/introduction.rst @@ -16,7 +16,7 @@ Introduction ************ -oneDAL provides redesigned versions of interfaces that account for multi-device targets. +Intel(R) oneAPI Data Analytics Library (oneDAL) provides redesigned versions of interfaces that account for multi-device targets. For example, CPU and GPU, distributed SPMD interfaces, and many more. Algorithms Support diff --git a/docs/source/onedal/spmd/index.rst b/docs/source/onedal/spmd/index.rst index 2e139d54ac5..0deaa961520 100644 --- a/docs/source/onedal/spmd/index.rst +++ b/docs/source/onedal/spmd/index.rst @@ -40,7 +40,7 @@ accordance with the input. :width: 800 :alt: Typical SPMD flow - Example of SPMD Flow in oneDAL + Example of SPMD Flow in Intel(R) oneAPI Data Analytics Library (oneDAL). .. _communicator_operations: From 6ea09d2961776cbd109826eb5c50929e7b73a0ea Mon Sep 17 00:00:00 2001 From: emmwalsh <148352712+emmwalsh@users.noreply.github.com> Date: Wed, 30 Oct 2024 15:49:23 +0000 Subject: [PATCH 7/7] removed Intel (R) branding removed Intel (R) branding --- docs/source/deprecation.rst | 2 +- docs/source/onedal/algorithms/clustering/kmeans.rst | 2 +- docs/source/onedal/algorithms/decomposition/pca.rst | 2 +- docs/source/onedal/gpu_support.rst | 2 +- docs/source/onedal/introduction.rst | 2 +- docs/source/onedal/spmd/index.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/deprecation.rst b/docs/source/deprecation.rst index 78e53b5211c..cfafc7fed69 100644 --- a/docs/source/deprecation.rst +++ b/docs/source/deprecation.rst @@ -18,7 +18,7 @@ Deprecation Notice ================== -This page provides information about the deprecations of a specific Intel(R) oneAPI Data Analytics Library (oneDAL) functionality. +This page provides information about the deprecations of a specific oneAPI Data Analytics Library (oneDAL) functionality. Java* Interfaces **************** diff --git a/docs/source/onedal/algorithms/clustering/kmeans.rst b/docs/source/onedal/algorithms/clustering/kmeans.rst index bbee5da67e0..5edf072ece5 100644 --- a/docs/source/onedal/algorithms/clustering/kmeans.rst +++ b/docs/source/onedal/algorithms/clustering/kmeans.rst @@ -52,7 +52,7 @@ Expression :math:`\|\cdot\|` denotes :math:`L_2` `norm .. note:: In the general case, :math:`d` may be an arbitrary distance function. Current - version of the Intel(R) oneAPI Data Analytics Library (oneDAL) specification defines only Euclidean distance case. + version of the oneAPI Data Analytics Library (oneDAL) specification defines only Euclidean distance case. .. _kmeans_t_math_lloyd: diff --git a/docs/source/onedal/algorithms/decomposition/pca.rst b/docs/source/onedal/algorithms/decomposition/pca.rst index 7c24d012b36..fe631273d56 100644 --- a/docs/source/onedal/algorithms/decomposition/pca.rst +++ b/docs/source/onedal/algorithms/decomposition/pca.rst @@ -76,7 +76,7 @@ The PCA algorithm can be trained using either the covariance or the correlation The choice of covariance matrix or correlation matrix is application-dependent. More specifically, if scaling of the features is important for a problem, which is often the case, using the correlation matrix to compute principal components is more appropriate. -By default, Intel(R) oneAPI Data Analytics Library (oneDAL) uses the correlation matrix to compute the principal components. It is possible +By default, oneAPI Data Analytics Library (oneDAL) uses the correlation matrix to compute the principal components. It is possible to use the covariance matrix by passing "precomputed" as method and feeding a covariance matrix as input to the PCA algorithm. To compute the covariance matrix, the :ref:`Covariance ` algorithm can be used. diff --git a/docs/source/onedal/gpu_support.rst b/docs/source/onedal/gpu_support.rst index d985631506a..61e9dab793d 100644 --- a/docs/source/onedal/gpu_support.rst +++ b/docs/source/onedal/gpu_support.rst @@ -23,7 +23,7 @@ See the differences in CPU and GPU support below. GPU-Supported Targets ********************* -Intel(R) oneAPI Data Analytics Library (oneDAL) is designed to work with Intel(R) GPUs specifically, but it could potentially +The oneAPI Data Analytics Library (oneDAL) is designed to work with Intel(R) GPUs specifically, but it could potentially run on other hardware platforms if a SYCL runtime is available. .. tabularcolumns:: |\Y{0.5}|\Y{0.5}| diff --git a/docs/source/onedal/introduction.rst b/docs/source/onedal/introduction.rst index 7fb3023e306..a63f8720539 100644 --- a/docs/source/onedal/introduction.rst +++ b/docs/source/onedal/introduction.rst @@ -16,7 +16,7 @@ Introduction ************ -Intel(R) oneAPI Data Analytics Library (oneDAL) provides redesigned versions of interfaces that account for multi-device targets. +The oneAPI Data Analytics Library (oneDAL) provides redesigned versions of interfaces that account for multi-device targets. For example, CPU and GPU, distributed SPMD interfaces, and many more. Algorithms Support diff --git a/docs/source/onedal/spmd/index.rst b/docs/source/onedal/spmd/index.rst index 0deaa961520..5a0575c95a8 100644 --- a/docs/source/onedal/spmd/index.rst +++ b/docs/source/onedal/spmd/index.rst @@ -40,7 +40,7 @@ accordance with the input. :width: 800 :alt: Typical SPMD flow - Example of SPMD Flow in Intel(R) oneAPI Data Analytics Library (oneDAL). + Example of SPMD Flow in the oneAPI Data Analytics Library (oneDAL). .. _communicator_operations: