Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC|oneMKL]Enable programmatic versioning #561

Merged
merged 20 commits into from
Sep 30, 2024
Merged

[RFC|oneMKL]Enable programmatic versioning #561

Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
a1d0e36
Enable programmatic versioning
vmalia Aug 5, 2024
83eb6cf
fix version
vmalia Aug 6, 2024
1c70f7b
Add version macros
vmalia Aug 6, 2024
9ca86f0
fix typo
vmalia Aug 6, 2024
afa29d0
Use codeblock
vmalia Aug 6, 2024
c5193cd
multiline codeblock
vmalia Aug 6, 2024
08ed7c2
format RST
vmalia Aug 6, 2024
f3706aa
Limit raw text to 80col length
vmalia Aug 20, 2024
8916f19
Remove top-level version macro
vmalia Aug 21, 2024
cda1170
Revert changes from versioning.rst
vmalia Sep 3, 2024
78e4bd6
[oneMKL]Add numerical versioning
vmalia Sep 3, 2024
1bcb8a0
Fix formatting
vmalia Sep 3, 2024
1d62041
Update other_architecture.inc.rst
vmalia Sep 3, 2024
167758f
Use domain-specific macros instead
vmalia Sep 17, 2024
3cb06a8
Clarify lack of revision number
vmalia Sep 17, 2024
5c0d0d4
Use SPBLAS instead of SPARSE as the domain name
vmalia Sep 18, 2024
9311fb8
Add STAT domain macro
vmalia Sep 18, 2024
67db794
Add rules for incompliance
vmalia Sep 24, 2024
215d27d
Change STAT to STATS as the domain name
vmalia Sep 26, 2024
602c87d
Add link to versioning details
vmalia Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 34 additions & 2 deletions source/elements/oneMKL/source/architecture/other_architecture.inc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,43 @@ This section covers all other features in the design of oneMKL architecture.

.. _onemkl_spec_current_version:

Current Version of this oneMKL Specification
Specification Version and Compliance
+++++++++++++++++++++++++++++++++++++++++++++

This is the oneMKL specification which is part of the oneAPI specification version 1.0.0.
Each oneMKL domain must define a preprocessor macro to represent the version of the specification that the implementation is compliant with.
vmalia marked this conversation as resolved.
Show resolved Hide resolved
vmalia marked this conversation as resolved.
Show resolved Hide resolved

The macros for each domain are listed as follows:

| ONEMKL_BLAS_SPEC_VERSION
vmalia marked this conversation as resolved.
Show resolved Hide resolved
| ONEMKL_LAPACK_SPEC_VERSION
| ONEMKL_SPBLAS_SPEC_VERSION
| ONEMKL_DFT_SPEC_VERSION
| ONEMKL_RNG_SPEC_VERSION
vmalia marked this conversation as resolved.
Show resolved Hide resolved
| ONEMKL_STATS_SPEC_VERSION
| ONEMKL_VM_SPEC_VERSION

The specification version can be created by appending all digits of the specification version in the format of <MAJOR><MINOR>. MINOR version always uses two digits. This version can be used to check the compatibility of the implementation with the specification version. Note that the revision is not included here because it reflects changes only for the specification document without affecting the implementation. If the implementation is not compliant with any release of the specification, then the macro must have a numerical value of `000`.
vmalia marked this conversation as resolved.
Show resolved Hide resolved

Version Example

| oneAPI 1.1 rev 1 will be represented as a numerical value of 101
| oneAPI 1.2 rev 1 will be represented as a numerical value of 102
| oneAPI 1.2 rev 2 will be represented as a numerical value of 102

Macro Example

.. code-block:: c

// For oneAPI 1.2 rev 1
vmalia marked this conversation as resolved.
Show resolved Hide resolved
#define ONEMKL_BLAS_SPEC_VERSION 102

// For oneAPI 1.2 rev 2
mkrainiuk marked this conversation as resolved.
Show resolved Hide resolved
#define ONEMKL_DFT_SPEC_VERSION 102

// For oneAPI 1.3 rev 1
#define ONEMKL_VM_SPEC_VERSION 103

Versioning details are defined here: https://github.com/uxlfoundation/oneAPI-spec/blob/main/doc/versioning.rst#provisional-versions

.. _onemkl_pre_post_conditions:

Expand Down