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.

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

[README][Docs] Update LLVM compiler name in README and related documentation #458

Merged
merged 5 commits into from
Mar 19, 2024

Conversation

dnhsieh-intel
Copy link
Contributor

Description

This PR replaces the usage of "Intel project for LLVM* technology" with the approved one "oneAPI DPC++ Compiler". In addition, the tables of "Supported Configurations" in README are reorganized for better readability.

Note that the current format of the tables is "library-centric":

Domain Backend Library Supported Link Type Supported Compiler
BLAS x86 CPU Intel(R) oneAPI Math Kernel Library Dynamic, Static DPC++, LLVM*, hipSYCL
Intel GPU Dynamic, Static DPC++
... ... ... ...
x86 CPU, Intel GPU, NVIDIA GPU, AMD GPU portBLAS Dynamic, Static DPC++, LLVM*
The underlying message of this table format is what a library can support. The table at the top of README already roughly covers this aspect.

The proposed table format is "application-centric":

Domain Backend Library Supported Compiler Supported Link Type
BLAS x86 CPU Intel(R) oneMKL Intel DPC++
Open DPC++
hipSYCL
Dynamic, Static
NETLIB LAPACK Intel DPC++
Open DPC++
hipSYCL
Dynamic, Static
portBLAS Intel DPC++
Open DPC++
Dynamic, Static
Intel GPU Intel(R) oneMKL Intel DPC++ Dynamic, Static
portBLAS Intel DPC++
Open DPC++
Dynamic, Static
... ... ... ...
For example, if an application requires BLAS on Intel GPUs, this format would make it easier to find out what configurations are available for the given application.

Checklist

All Submissions

  • Do all unit tests pass locally? N/A, only documentation changes.
  • Have you formatted the code using clang-format? N/A, only documentation changes.

@dnhsieh-intel
Copy link
Contributor Author

@Rbiessy Please help checking the supported compilers for portBLAS and portFFT in the tables. I suspect that some slots might need to be changed.

Copy link
Contributor

@hjabird hjabird left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the tables look less cluttered with your changes. Thanks!

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/selecting_a_compiler.rst Show resolved Hide resolved
@dnhsieh-intel
Copy link
Contributor Author

The update of the supported commit of oneAPI DPC++ Compiler and OS will be done in a separate PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants