Merge branch 'master' into fix/conda-packageing

Author: eunos-1128

.github/workflows/cpp_examples.yml

@@ -30,7 +30,7 @@ jobs:
         configure-options: -DKOMPUTE_OPT_USE_BUILT_IN_VULKAN_HEADER=ON -DKOMPUTE_OPT_FROM_SOURCE=ON
         build-options: --parallel # Given we don't build too many resources we can leverage parallel
     - name: Run tests
-      run: ./examples/array_multiplication/build/src/kompute_array_mult
+      run: ./examples/array_multiplication/build/kompute_array_mult
 
   logistc-regression-example:
     runs-on: ubuntu-latest
@@ -55,4 +55,4 @@ jobs:
         configure-options: -DKOMPUTE_OPT_USE_BUILT_IN_VULKAN_HEADER=ON -DKOMPUTE_OPT_FROM_SOURCE=ON
         build-options: --parallel # Given we don't build too many resources we can leverage parallel
     - name: Run tests
-      run: ./examples/logistic_regression/build/src/kompute_logistic_regression
+      run: ./examples/logistic_regression/build/kompute_logistic_regression

.github/workflows/cpp_tests.yml

@@ -7,6 +7,30 @@ on:
     branches: [ master ]
 
 jobs:
+  cpp-tests-1-4-debug-with-debug-layers:
+    runs-on: ubuntu-latest
+    container: axsauze/kompute-builder:0.4
+    env:
+      VK_ICD_FILENAMES: "/swiftshader/vk_swiftshader_icd.json"
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+      with:
+        submodules: false
+    - name: "[Release g++] Build & Test"
+      uses: KomputeProject/action-cmake-build@master
+      with:
+        build-dir: ${{github.workspace}}/build
+        source-dir: ${{github.workspace}}
+        cc: gcc
+        cxx: g++
+        build-type: Debug
+        run-test: false
+        ctest-options: -V
+        configure-options: -DKOMPUTE_OPT_BUILD_TESTS=ON -DKOMPUTE_OPT_DISABLE_VK_DEBUG_LAYERS=OFF -DKOMPUTE_OPT_USE_BUILT_IN_VULKAN_HEADER=ON -DKOMPUTE_OPT_BUILT_IN_VULKAN_HEADER_TAG=v1.4.304 -DKOMPUTE_OPT_DISABLE_VULKAN_VERSION_CHECK=ON
+    - name: Run tests
+      run: make mk_run_tests
+
   cpp-tests-debug-with-debug-layers:
     runs-on: ubuntu-latest
     container: axsauze/kompute-builder:0.4

.gitignore

@@ -192,6 +192,11 @@ vk_swiftshader_icd.json
 tmp_kp_shader.comp.spv
 tmp_kp_shader.comp
 
+# Shaders
+test/shaders/glsl/*.hpp
+compiled_shaders_include/
+
 # Docs
 _build/
 
+

CMakeLists.txt

@@ -88,6 +88,7 @@ message(STATUS "=======================================================")
 
 # Enable or disable targets
 kompute_option(KOMPUTE_OPT_BUILD_TESTS "Enable if you want to build tests." OFF)
+kompute_option(KOMPUTE_OPT_ENABLE_BENCHMARK "Enable if you want to build and enable benchmark." OFF)
 kompute_option(KOMPUTE_OPT_CODE_COVERAGE "Enable if you want code coverage." OFF)
 kompute_option(KOMPUTE_OPT_BUILD_DOCS "Enable if you want to build documentation." OFF)
 kompute_option(KOMPUTE_OPT_INSTALL "Enable if you want to enable installation." ${kompute_opt_install_default_val})
@@ -123,13 +124,20 @@ include(cmake/vulkan_shader_compiler.cmake)
 include(cmake/check_vulkan_version.cmake)
 include(FetchContent)
 
+# Set -fPIC so that ../lib/kp.cpython-310-x86_64-linux-gnu.so links correctly
+if(KOMPUTE_OPT_BUILD_PYTHON)
+    set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+endif()
+
 # Vulkan Header
 # We don't import Vulkan library if Android build as it is built dynamically
 # Otherwise it is expected that the Vulkan SDK and dependencies are installed
 # Has to happen AFTER using the build-in Vulkan headers to prevent multiple targets with the name Vulkan::Headers
 if(KOMPUTE_OPT_ANDROID_BUILD)
     add_library(vulkanAndroid INTERFACE)
-    set(VULKAN_INCLUDE_DIR ${ANDROID_NDK}/sources/third_party/vulkan/src/include)
+    if(NOT DEFINED VULKAN_INCLUDE_DIR)
+        message(FATAL_ERROR "VULKAN_INCLUDE_DIR is not set. Please set it to the Vulkan SDK include directory.")
+    endif()
     target_sources(vulkanAndroid INTERFACE ${VULKAN_INCLUDE_DIR}/vulkan/vulkan.hpp)
     target_include_directories(vulkanAndroid INTERFACE ${VULKAN_INCLUDE_DIR})
 
@@ -138,7 +146,8 @@ if(KOMPUTE_OPT_ANDROID_BUILD)
 else()
     if(KOMPUTE_OPT_USE_BUILT_IN_VULKAN_HEADER)
         FetchContent_Declare(vulkan_header GIT_REPOSITORY https://github.com/KhronosGroup/Vulkan-Headers.git
-            GIT_TAG ${KOMPUTE_OPT_BUILT_IN_VULKAN_HEADER_TAG}) # Source: https://github.com/KhronosGroup/Vulkan-Headers/tags
+            GIT_TAG ${KOMPUTE_OPT_BUILT_IN_VULKAN_HEADER_TAG}
+            GIT_SHALLOW 1) # Source: https://github.com/KhronosGroup/Vulkan-Headers/tags
         FetchContent_MakeAvailable(vulkan_header)
 
         if(NOT KOMPUTE_OPT_DISABLE_VULKAN_VERSION_CHECK)
@@ -162,38 +171,38 @@ else()
 endif()
 
 # Spdlog
-if(KOMPUTE_OPT_USE_SPDLOG)
+if(NOT KOMPUTE_OPT_LOG_LEVEL_DISABLED AND KOMPUTE_OPT_USE_SPDLOG)
     add_compile_definitions(KOMPUTE_OPT_USE_SPDLOG=1)
 
-    if(NOT KOMPUTE_OPT_LOG_LEVEL_DISABLED)
-        if(KOMPUTE_OPT_USE_BUILT_IN_SPDLOG)
-            set(SPDLOG_INSTALL ${KOMPUTE_OPT_INSTALL})
-            set(SPDLOG_BUILD_SHARED ${BUILD_SHARED_LIBS})
+    if(KOMPUTE_OPT_USE_BUILT_IN_SPDLOG)
+        set(SPDLOG_INSTALL ${KOMPUTE_OPT_INSTALL})
+        set(SPDLOG_BUILD_SHARED ${BUILD_SHARED_LIBS})
 
-            FetchContent_Declare(spdlog GIT_REPOSITORY https://github.com/gabime/spdlog.git
-                GIT_TAG v1.10.0) # Source: https://github.com/gabime/spdlog/releases
-            FetchContent_MakeAvailable(spdlog)
-        else()
-            find_package(spdlog REQUIRED)
-        endif()
+        FetchContent_Declare(spdlog GIT_REPOSITORY https://github.com/gabime/spdlog.git
+            GIT_TAG v1.10.0
+            GIT_SHALLOW 1) # Source: https://github.com/gabime/spdlog/releases
+        FetchContent_MakeAvailable(spdlog)
+    else()
+        find_package(spdlog REQUIRED)
     endif()
-endif()
-
-# fmt
-if(KOMPUTE_OPT_USE_BUILT_IN_FMT)
-    set(FMT_INSTALL ${KOMPUTE_OPT_INSTALL})
-    FetchContent_Declare(fmt GIT_REPOSITORY https://github.com/fmtlib/fmt.git
-        GIT_TAG 10.1.1) # Source: https://github.com/fmtlib/fmt/releases
-    FetchContent_MakeAvailable(fmt)
 else()
-    find_package(fmt REQUIRED)
+    # fmt
+    if(KOMPUTE_OPT_USE_BUILT_IN_FMT)
+        set(FMT_INSTALL ${KOMPUTE_OPT_INSTALL})
+        FetchContent_Declare(fmt GIT_REPOSITORY https://github.com/fmtlib/fmt.git
+            GIT_TAG 11.0.0
+            GIT_SHALLOW 1) # Source: https://github.com/fmtlib/fmt/releases
+        FetchContent_MakeAvailable(fmt)
+    else()
+        find_package(fmt REQUIRED)
+    endif()
 endif()
 
 # GoogleTest
-if(KOMPUTE_OPT_BUILD_TESTS)
+if(KOMPUTE_OPT_BUILD_TESTS OR KOMPUTE_OPT_ENABLE_BENCHMARK)
     if(KOMPUTE_OPT_USE_BUILT_IN_GOOGLE_TEST)
         FetchContent_Declare(googletest GIT_REPOSITORY https://github.com/google/googletest.git
-            GIT_TAG release-1.11.0) # Source: https://github.com/google/googletest/releases
+            GIT_TAG v1.17.0) # Source: https://github.com/google/googletest/releases
 
         # Use a shared C runtime in case we build shared
         set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
@@ -217,7 +226,8 @@ endif()
 if(KOMPUTE_OPT_BUILD_PYTHON)
     if(KOMPUTE_OPT_USE_BUILT_IN_PYBIND11)
         FetchContent_Declare(pybind GIT_REPOSITORY https://github.com/pybind/pybind11.git
-            GIT_TAG v2.9.2) # Source: https://github.com/pybind/pybind11/releases
+            GIT_TAG v3.0.0
+            GIT_SHALLOW 1) # Source: https://github.com/pybind/pybind11/releases
         FetchContent_MakeAvailable(pybind)
     else()
         find_package(pybind11 REQUIRED)
@@ -266,11 +276,18 @@ endfunction()
 
 add_subdirectory(src)
 
-if(KOMPUTE_OPT_BUILD_TESTS)
+if(KOMPUTE_OPT_BUILD_TESTS OR KOMPUTE_OPT_ENABLE_BENCHMARK)
     enable_testing()
+endif()
+
+if(KOMPUTE_OPT_BUILD_TESTS)
     add_subdirectory(test)
 endif()
 
+if(KOMPUTE_OPT_ENABLE_BENCHMARK)
+    add_subdirectory(benchmark)
+endif()
+
 if(KOMPUTE_OPT_CODE_COVERAGE)
     if(NOT UNIX)
         message(FATAL_ERROR "KOMPUTE_OPT_CODE_COVERAGE can only be enabled in unix based systems due to limitation on gcov.")
@@ -295,6 +312,13 @@ if(KOMPUTE_OPT_INSTALL)
         FILE komputeTargets.cmake
         NAMESPACE kompute::
         DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/kompute)
+
+    # Copy CMake files needed to `vulkan_compile_shader`
+    install(FILES
+        cmake/vulkan_shader_compiler.cmake
+        cmake/bin_file_to_header.cmake
+        cmake/bin2h.cmake
+        DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/kompute)
 endif()
 
 

Makefile

@@ -61,11 +61,15 @@ mk_cmake:
 		-DCMAKE_INSTALL_PREFIX=$(MK_INSTALL_PATH) \
 		-DKOMPUTE_OPT_INSTALL=ON \
 		-DKOMPUTE_OPT_BUILD_TESTS=ON \
+		-DKOMPUTE_OPT_ENABLE_BENCHMARK=ON \
+		-DKOMPUTE_OPT_BUILT_IN_VULKAN_HEADER_TAG="v1.3.275" \
 		-DKOMPUTE_OPT_BUILD_DOCS=ON \
-		-DKOMPUTE_OPT_BUILD_SHADERS=ON \
 		-DKOMPUTE_OPT_CODE_COVERAGE=ON \
-		-DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
+		-DKOMPUTE_OPT_USE_SPDLOG=1 \
 		-DKOMPUTE_OPT_LOG_LEVEL=Debug \
+		-DKOMPUTE_OPT_DISABLE_VK_DEBUG_LAYERS=ON \
+		-DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
+		-DKOMPUTE_OPT_DISABLE_VULKAN_VERSION_CHECK=ON \
 		$(MK_CMAKE_EXTRA_FLAGS) \
 		-G "Unix Makefiles"
 
@@ -81,6 +85,9 @@ mk_build_kompute:
 mk_build_tests:
 	cmake --build build/. --target kompute_tests --parallel
 
+mk_build_benchmark:
+	cmake --build build/. --target kompute_benchmark --parallel
+
 mk_run_docs: mk_build_docs mk_run_docs_only
 
 mk_run_docs_only:
@@ -92,6 +99,9 @@ mk_run_docs_only:
 mk_run_tests: mk_build_tests
 	./build/bin/kompute_tests --gtest_filter=$(FILTER_TESTS)
 
+mk_run_benchmark: mk_build_benchmark
+	./build/bin/kompute_benchmark --gtest_filter=$(FILTER_TESTS)
+
 mk_build_swiftshader_library:
 	git clone https://github.com/google/swiftshader || echo "Assuming already cloned"
 	# GCC 8 or above is required otherwise error on "filesystem" lib will appear

README.md

@@ -60,6 +60,13 @@
 
 ![](https://raw.githubusercontent.com/KomputeProject/kompute/master/docs/images/komputer-logos.gif)
 
+## Projects using Kompute ❤️  🤖
+
+* [GPT4ALL](https://github.com/nomic-ai/gpt4all) ![](https://img.shields.io/github/stars/nomic-ai/gpt4all.svg?style=social) - An ecosystem of open-source on-edge large language models that run locally on your CPU and nearly any GPU.
+* [llama.cpp](https://github.com/ggerganov/llama.cpp) ![](https://img.shields.io/github/stars/ggerganov/llama.cpp.svg?style=social) - Port of Facebook's LLaMA model in C/C++ (now decomissioned).
+* [tpoisonooo/how-to-optimize-gemm](https://github.com/tpoisonooo/how-to-optimize-gemm) ![](https://img.shields.io/github/stars/tpoisonooo/how-to-optimize-gemm.svg?style=social) - row-major matmul optimization.
+* [vkJAX](https://github.com/alexander-g/vkJAX) ![](https://img.shields.io/github/stars/alexander-g/vkJAX.svg?style=social) - JAX interpreter for Vulkan.
+
 ## Getting Started
 
 Below you can find a GPU multiplication example using the C++ and Python Kompute interfaces.
@@ -86,7 +93,7 @@ void kompute(const std::string& shader) {
     auto tensorOutA = mgr.tensorT<uint32_t>({ 0, 0, 0 });
     auto tensorOutB = mgr.tensorT<uint32_t>({ 0, 0, 0 });
 
-    std::vector<std::shared_ptr<kp::Tensor>> params = {tensorInA, tensorInB, tensorOutA, tensorOutB};
+    std::vector<std::shared_ptr<kp::Memory>> params = {tensorInA, tensorInB, tensorOutA, tensorOutB};
 
     // 3. Create algorithm based on shader (supports buffers & push/spec constants)
     kp::Workgroup workgroup({3, 1, 1});
@@ -103,15 +110,15 @@ void kompute(const std::string& shader) {
 
     // 4. Run operation synchronously using sequence
     mgr.sequence()
-        ->record<kp::OpTensorSyncDevice>(params)
+        ->record<kp::OpSyncDevice>(params)
         ->record<kp::OpAlgoDispatch>(algorithm) // Binds default push consts
         ->eval() // Evaluates the two recorded operations
         ->record<kp::OpAlgoDispatch>(algorithm, pushConstsB) // Overrides push consts
         ->eval(); // Evaluates only last recorded operation
 
     // 5. Sync results from the GPU asynchronously
     auto sq = mgr.sequence();
-    sq->evalAsync<kp::OpTensorSyncLocal>(params);
+    sq->evalAsync<kp::OpSyncLocal>(params);
 
     // ... Do other work asynchronously whilst GPU finishes
 
@@ -180,6 +187,7 @@ def kompute(shader):
     # Explicit type constructor supports uint32, int32, double, float and bool
     tensor_out_a = mgr.tensor_t(np.array([0, 0, 0], dtype=np.uint32))
     tensor_out_b = mgr.tensor_t(np.array([0, 0, 0], dtype=np.uint32))
+    assert(t_data.data_type() == kp.DataTypes.uint)
 
     params = [tensor_in_a, tensor_in_b, tensor_out_a, tensor_out_b]
 

benchmark/CMakeLists.txt

@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: Apache-2.0
+# ######################
+cmake_minimum_required(VERSION 3.20)
+
+# ####################################################
+# Shaders
+# ####################################################
+add_subdirectory(shaders)
+
+# ####################################################
+# Tests
+# ####################################################
+add_executable(kompute_benchmark
+    TestBenchmark.cpp)
+
+target_link_libraries(kompute_benchmark PRIVATE GTest::gtest_main
+    kompute::kompute
+    kp_logger
+    test_benchmark_shaders)
+add_test(NAME kompute_benchmark COMMAND kompute_benchmark)
+
+# Group under the "tests" project folder in IDEs such as Visual Studio.
+set_property(TARGET kompute_benchmark PROPERTY FOLDER "tests")
+
+if(WIN32 AND BUILD_SHARED_LIBS) # Install dlls in the same directory as the executable on Windows so one can simply double click them
+    add_custom_command(TARGET kompute_benchmark POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:test_shaders> $<TARGET_FILE_DIR:kompute_benchmark>)
+    add_custom_command(TARGET kompute_benchmark POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:kompute::kompute> $<TARGET_FILE_DIR:kompute_benchmark>)
+    add_custom_command(TARGET kompute_benchmark POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:spdlog> $<TARGET_FILE_DIR:kompute_benchmark>)
+    add_custom_command(TARGET kompute_benchmark POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:kp_logger> $<TARGET_FILE_DIR:kompute_benchmark>)
+endif()
+
+