Skip to content

Commit 07f6e70

Browse files
committed
merge from master
2 parents c15e9e1 + fc7a4ca commit 07f6e70

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

source/elements/oneDAL/source/common_interface/header_files_and_namespaces.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,21 @@ oneDAL public identifiers are represented in the following header files:
1010

1111
* - Header file
1212
- Description
13-
* - ``onedal/onedal.hpp``
13+
* - ``oneapi/dal.hpp``
1414
- The main header file of oneDAL library.
15-
* - ``onedal/algo/%ALGO%/%ALGO%.hpp``
15+
* - ``oneapi/dal/algo/%ALGO%.hpp``
1616
- A header file for a particular algorithm.
17+
The folder for the algorithm itself is ``oneapi/dal/algo/%ALGO%/``.
1718

1819
The string %ALGO% should be substituted with the name of the algorithm, for example, ``kmeans`` or ``knn``.
1920

20-
* - ``onedal/algo/misc/%FUNC%/%FUNC%.hpp``
21+
* - ``oneapi/dal/algo/misc/%FUNC%.hpp``
2122
- A header file for miscellaneous data types and functionality that is intended to be used by oneDAL algorithms and applications
2223
of the analytical pipeline.
2324

2425
The string %FUNC% should be substituted with the functionality name, for example, ``mt19937`` or ``cross_enthropy_loss``.
2526

26-
* - ``onedal/util/%UTIL%.hpp```
27+
* - ``oneapi/dal/util/%UTIL%.hpp```
2728
- A header file for auxiliary functionality, such as memory allocators or type traits, that is intended to be used for the design of classes and implementation of various methods.
2829

2930
The string %UTIL% should be substituted with the auxiliary functionality name, for example, ``usm_allocator`` or ``type_traits``.
@@ -43,23 +44,24 @@ oneDAL functionality is represented with a system of C++ namespaces described be
4344

4445
* - Namespace
4546
- oneDAL content
46-
* - ``onedal``
47-
- The namespace of the library that contains externally exposed data types, processing and service functionality of oneDAL.
48-
* - ``onedal::%ALGORITHM%``
47+
* - ``oneapi::dal``
48+
- The namespace of the library that contains externally exposable data types, processing and service functionality of oneDAL.
49+
* - ``oneapi::dal::%ALGORITHM%``
50+
4951
- The namespace of the algorithm.
5052
All classes and structures related to that algorithm shall be defined within a particular namespace.
5153

5254
To define a specific algorithm, the string %ALGORITHM% should be substituted with its name,
53-
for example, ``onedal::kmeans`` or ``onedal::knn``.
55+
for example, ``oneapi::dal::kmeans`` or ``oneapi::dal::knn``.
5456

55-
* - ``onedal::misc``
57+
* - ``oneapi::dal::misc``
5658
- The namespace that contains miscellaneous data types and functionality intended to be used by oneDAL algorithms
5759
and applications for algorithm customization and optimization on various stages of the analytical pipeline.
5860
* - ``%PARENT%::detail``
5961
- The namespace that contains implementation details of the data types and functionality for the parent namespace.
6062
The namespace can be on any level in the namespace hierarchy.
6163

6264
To define a specific namespace, the string %PARENT% should be substituted with the namespace for which the details are provided,
63-
for example, ``onedal::detail`` or ``onedal::kmeans::detail``.
65+
for example, ``oneapi::dal::detail`` or ``oneapi::dal::kmeans::detail``.
6466

6567
The application shall not use any data types nor call any functionality located in the ``detail`` namespaces.

source/elements/oneMKL/source/architecture/other_architecture.inc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ oneMKL Specification Versioning Strategy
1313

1414
This oneMKL specification uses a ``MAJOR.MINOR.PATCH`` approach for its versioning strategy.
1515
The ``MAJOR`` count is updated when a significant new feature or domain is added or backward compatibility is broken.
16-
The ``MINOR`` count is updated when new APIs are changed or added or deleted, or language updated with relatively significant change to the meaning but without breaking backwards compatibility.
16+
The ``MINOR`` count is updated when new APIs are changed or added, or language updated with relatively significant change to the meaning but without breaking backwards compatibility.
1717
The ``PATCH`` count is updated when wording, language or structure is updated without significant change to the meaning or interpretation.
1818

1919

0 commit comments

Comments
 (0)