Skip to content

Commit

Permalink
Rename SYCL-BLAS to portBLAS (oneapi-src#366)
Browse files Browse the repository at this point in the history
Renamed the SYCL based BLAS backend to portBLAS
  • Loading branch information
aacostadiaz authored and normallytangent committed Aug 6, 2024
1 parent b24d7ad commit feef442
Show file tree
Hide file tree
Showing 33 changed files with 1,211 additions and 1,211 deletions.
6 changes: 3 additions & 3 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ if(ENABLE_MKLCPU_BACKEND
OR ENABLE_CUBLAS_BACKEND
OR ENABLE_ROCBLAS_BACKEND
OR ENABLE_NETLIB_BACKEND
OR ENABLE_SYCLBLAS_BACKEND)
OR ENABLE_PORTBLAS_BACKEND)
list(APPEND DOMAINS_LIST "blas")
endif()
if(ENABLE_MKLCPU_BACKEND
Expand All @@ -106,13 +106,13 @@ if(ENABLE_MKLGPU_BACKEND
list(APPEND DOMAINS_LIST "dft")
endif()

if(ENABLE_SYCLBLAS_BACKEND AND
if(ENABLE_PORTBLAS_BACKEND AND
(ENABLE_MKLCPU_BACKEND OR
ENABLE_MKLGPU_BACKEND OR
ENABLE_CUBLAS_BACKEND OR
ENABLE_ROCBLAS_BACKEND OR
ENABLE_NETLIB_BACKEND))
message(FATAL_ERROR "SYCL-BLAS backend cannot be enabled with other backends")
message(FATAL_ERROR "portBLAS backend cannot be enabled with other backends")
endif()

# Define required CXX compilers before project
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ oneMKL is part of [oneAPI](https://oneapi.io).
<td align="center">AMD GPU</td>
</tr>
<tr>
<td align="center"><a href="https://github.com/codeplaysoftware/sycl-blas"> SYCL-BLAS </a></td>
<td align="center"><a href="https://github.com/codeplaysoftware/portBLAS"> portBLAS </a></td>
<td align="center">x86 CPU, Intel GPU, NVIDIA GPU, AMD GPU</td>
</tr>
</tbody>
Expand Down Expand Up @@ -189,7 +189,7 @@ Supported domains: BLAS, LAPACK, RNG, DFT
</tr>
<tr >
<td align="center">x86 CPU, Intel GPU, NVIDIA GPU, AMD GPU</td>
<td align="center">SYCL-BLAS</td>
<td align="center">portBLAS</td>
<td align="center">Dynamic, Static</td>
<td align="center">DPC++, LLVM*</td>
</tr>
Expand Down Expand Up @@ -477,7 +477,7 @@ Python | 3.6 or higher | No | *N/A* | *Pre-installed or Installed by user* | [PS
[AMD rocFFT](https://github.com/ROCmSoftwarePlatform/rocFFT) | rocm-5.4.3 | No | *N/A* | *Installed by user* |[AMD License](https://github.com/ROCmSoftwarePlatform/rocFFT/blob/rocm-5.4.3/LICENSE.md)
[NETLIB LAPACK](https://www.netlib.org/) | 3.7.1 | Yes | conan-community | ~/.conan/data or $CONAN_USER_HOME/.conan/data | [BSD like license](http://www.netlib.org/lapack/LICENSE.txt)
[Sphinx](https://www.sphinx-doc.org/en/master/) | 2.4.4 | Yes | pip | ~/.local/bin (or similar user local directory) | [BSD License](https://github.com/sphinx-doc/sphinx/blob/3.x/LICENSE)
[SYCL-BLAS](https://github.com/codeplaysoftware/sycl-blas) | 0.1 | No | *N/A* | *Installed by user* | [Apache License v2.0](https://github.com/codeplaysoftware/sycl-blas/blob/master/LICENSE)
[portBLAS](https://github.com/codeplaysoftware/portBLAS) | 0.1 | No | *N/A* | *Installed by user* | [Apache License v2.0](https://github.com/codeplaysoftware/portBLAS/blob/master/LICENSE)

*conan-center: https://api.bintray.com/conan/conan/conan-center*

Expand Down
28 changes: 14 additions & 14 deletions docs/building_the_project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -490,13 +490,13 @@ A few often-used architectures are listed below:
- | Radeon Instinct(TM) MI 25 Accelerator
| Radeon(TM) RX Vega 64/56 Graphics
Building for SYCL-BLAS
Building for portBLAS
^^^^^^^^^^^^^^^^^^^^^^

Note the SYCL-BLAS backend is experimental and currently only supports a
subset of the operations and features. The SYCL-BLAS backend cannot be enabled
Note the portBLAS backend is experimental and currently only supports a
subset of the operations and features. The portBLAS backend cannot be enabled
with other backends and can only be used with the compile time dispatch.
The SYCL-BLAS backend uses the `SYCL-BLAS <https://github.com/codeplaysoftware/sycl-blas>`_
The portBLAS backend uses the `portBLAS <https://github.com/codeplaysoftware/portBLAS>`_
project as a header-only library.

* On Linux*
Expand All @@ -505,31 +505,31 @@ project as a header-only library.
# Inside <path to onemkl>
mkdir build && cd build
cmake .. -DENABLE_SYCLBLAS_BACKEND=ON \
cmake .. -DENABLE_PORTBLAS_BACKEND=ON \
-DENABLE_MKLCPU_BACKEND=OFF \
-DENABLE_MKLGPU_BACKEND=OFF \
-DTARGET_DOMAINS=blas \
[-DREF_BLAS_ROOT=<reference_blas_install_prefix>] \ # required only for testing
[-Dsycl_blas_DIR=<path to SYCL-BLAS install directory>]
[-DPORTBLAS_DIR=<path to portBLAS install directory>]
cmake --build .
./bin/test_main_blas_ct
cmake --install . --prefix <path_to_install_dir>
SYCL-BLAS will be downloaded automatically if not found.
By default, the SYCL-BLAS backend is not tuned for any specific device which
portBLAS will be downloaded automatically if not found.
By default, the portBLAS backend is not tuned for any specific device which
will impact performance.
SYCL-BLAS can be tuned for a specific hardware target by adding compiler
portBLAS can be tuned for a specific hardware target by adding compiler
definitions in 2 ways:

#.
Manually specify a tuning target with ``-DSYCLBLAS_TUNING_TARGET=<target>``.
The list of SYCL-BLAS targets can be found
`here <https://github.com/codeplaysoftware/sycl-blas#cmake-options>`_.
Manually specify a tuning target with ``-DPORTBLAS_TUNING_TARGET=<target>``.
The list of portBLAS targets can be found
`here <https://github.com/codeplaysoftware/portBLAS#cmake-options>`_.
This will automatically set ``-fsycl-targets`` if needed.
#.
If one target is set via ``-fsycl-targets`` the configuration step will
try to automatically detect the SYCL-BLAS tuning target. One can manually
try to automatically detect the portBLAS tuning target. One can manually
specify ``-fsycl-targets`` via ``CMAKE_CXX_FLAGS``. See
`DPC++ User Manual <https://intel.github.io/llvm-docs/UsersManual.html>`_
for more information on ``-fsycl-targets``.
Expand Down Expand Up @@ -597,7 +597,7 @@ CMake.
- True, False
- True
* - *Not Supported*
- ENABLE_SYCLBLAS_BACKEND
- ENABLE_PORTBLAS_BACKEND
- True, False
- False
* - build_functional_tests
Expand Down
4 changes: 2 additions & 2 deletions include/oneapi/mkl/blas.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@
#ifdef ENABLE_NETLIB_BACKEND
#include "oneapi/mkl/blas/detail/netlib/blas_ct.hpp"
#endif
#ifdef ENABLE_SYCLBLAS_BACKEND
#include "oneapi/mkl/blas/detail/syclblas/blas_ct.hpp"
#ifdef ENABLE_PORTBLAS_BACKEND
#include "oneapi/mkl/blas/detail/portblas/blas_ct.hpp"
#endif

namespace oneapi {
Expand Down
4 changes: 2 additions & 2 deletions include/oneapi/mkl/blas/detail/blas_ct_backends.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ namespace column_major {
#define BACKEND netlib
#include "blas_ct_backends.hxx"
#undef BACKEND
#define BACKEND syclblas
#define BACKEND portblas
#include "blas_ct_backends.hxx"
#undef BACKEND

Expand All @@ -73,7 +73,7 @@ namespace row_major {
#define BACKEND netlib
#include "blas_ct_backends.hxx"
#undef BACKEND
#define BACKEND syclblas
#define BACKEND portblas
#include "blas_ct_backends.hxx"
#undef BACKEND

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
*
**************************************************************************/

#ifndef _DETAIL_SYCLBLAS_BLAS_CT_HPP_
#define _DETAIL_SYCLBLAS_BLAS_CT_HPP_
#ifndef _DETAIL_PORTBLAS_BLAS_CT_HPP_
#define _DETAIL_PORTBLAS_BLAS_CT_HPP_

#if __has_include(<sycl/sycl.hpp>)
#include <sycl/sycl.hpp>
Expand All @@ -30,7 +30,7 @@

#include "oneapi/mkl/types.hpp"
#include "oneapi/mkl/detail/backend_selector.hpp"
#include "oneapi/mkl/blas/detail/syclblas/onemkl_blas_syclblas.hpp"
#include "oneapi/mkl/blas/detail/portblas/onemkl_blas_portblas.hpp"
#include "oneapi/mkl/blas/detail/blas_ct_backends.hpp"

namespace oneapi {
Expand All @@ -54,4 +54,4 @@ namespace row_major {
} //namespace mkl
} //namespace oneapi

#endif //_DETAIL_SYCLBLAS_BLAS_CT_HPP_
#endif //_DETAIL_PORTBLAS_BLAS_CT_HPP_
Loading

0 comments on commit feef442

Please sign in to comment.