kcpp-build-release-win.yaml

name: Koboldcpp Windows

on:
  workflow_dispatch:
    inputs:
      commit_hash:
        description: 'Optional commit hash to build from'
        required: false
        default: ''

env:
  BRANCH_NAME: ${{ github.head_ref || github.ref_name }}

jobs:
  windows:
    runs-on: windows-2022
    permissions: write-all
    steps:
      - name: Show runner hardware
        shell: pwsh
        run: |
          Write-Host "::group::GitHub runner"
          Write-Host "Name: $env:RUNNER_NAME"
          Write-Host "OS/architecture: $env:RUNNER_OS / $env:RUNNER_ARCH"
          Write-Host "Image: $env:ImageOS $env:ImageVersion"
          Write-Host "::endgroup::"
          Write-Host "::group::Machine and operating system"
          $system = Get-CimInstance Win32_ComputerSystem
          $os = Get-CimInstance Win32_OperatingSystem
          $system | Select-Object Manufacturer, Model, SystemType, HypervisorPresent, TotalPhysicalMemory | Format-List
          Write-Host ("Installed RAM: {0} bytes ({1:N2} GiB)" -f $system.TotalPhysicalMemory, ($system.TotalPhysicalMemory / 1GB))
          $os | Select-Object Caption, Version, BuildNumber, OSArchitecture | Format-List
          Write-Host "::endgroup::"
          Write-Host "::group::CPU"
          Get-CimInstance Win32_Processor | Select-Object Name, Manufacturer, Description, SocketDesignation, NumberOfCores, NumberOfLogicalProcessors, MaxClockSpeed | Format-List
          Write-Host "::endgroup::"
          Write-Host "::group::Memory modules"
          Get-CimInstance Win32_PhysicalMemory | Select-Object Manufacturer, PartNumber, Capacity, Speed, ConfiguredClockSpeed | Format-List
          Write-Host "::endgroup::"

      - name: Clone
        id: checkout
        uses: actions/checkout@v5
        with:
          ref: ${{ inputs.commit_hash != '' && inputs.commit_hash || github.head_ref || github.ref_name }}

      - name: Show Commit Used
        run: |
          echo "Building from ref: ${{ inputs.commit_hash != '' && inputs.commit_hash || github.head_ref || github.ref_name }}"

      - name: Get Python
        uses: actions/setup-python@v6
        with:
          python-version: 3.8.10

      - name: Install python dependencies
        run: |
          python -m pip install --upgrade pip
          pip install customtkinter==5.2.0 pyinstaller==5.12.0 psutil==5.9.5 jinja2==3.1.6

      - name: Display full Visual Studio info Before
        run: |
          & "C:\Program Files (x86)\Microsoft Visual Studio\Installer\vswhere.exe" -all -products * -format json
        shell: pwsh

      - name: Visual Studio 2019 Reinstall
        shell: cmd
        run: |
          @echo off
          echo Preparing setup
          curl -fLO https://download.visualstudio.microsoft.com/download/pr/1fbe074b-8ae1-4e9b-8e83-d1ce4200c9d1/61098e228df7ba3a6a8b4e920a415ad8878d386de6dd0f23f194fe1a55db189a/vs_Enterprise.exe
          vs_Enterprise.exe --quiet --add Microsoft.VisualStudio.Workload.VCTools --add Microsoft.VisualStudio.Component.VC.CLI.Support --add Microsoft.VisualStudio.Component.Windows10SDK.19041 --add Microsoft.VisualStudio.Workload.UniversalBuildTools --add Microsoft.VisualStudio.Component.VC.CMake.Project
          echo Waiting for VS2019 setup
          set "ProcessName=setup.exe"
          :CheckProcess
          tasklist /FI "IMAGENAME eq %ProcessName%" | find /I "%ProcessName%" >nul
          if %errorlevel%==0 (
              ping 127.0.0.1 /n 5 >nul
              goto CheckProcess
          )
          echo VS2019 Setup completed
          exit /b 0

      - uses: Jimver/cuda-toolkit@v0.2.35
        id: cuda-toolkit
        with:
          cuda: '12.1.0'
          use-github-cache: false

      - name: Disable Visual Studio 2022 by Renaming
        run: |
          Rename-Item "C:\Program Files\Microsoft Visual Studio\2022\Enterprise" "Enterprise_DISABLED"
        shell: pwsh

      - name: Display full Visual Studio info After
        run: |
          & "C:\Program Files (x86)\Microsoft Visual Studio\Installer\vswhere.exe" -all -products * -format json
        shell: pwsh

      - name: Download and install win64devkit
        run: |
          curl -L https://github.com/skeeto/w64devkit/releases/download/v1.22.0/w64devkit-1.22.0.zip --output w64devkit.zip
          Expand-Archive w64devkit.zip -DestinationPath .

      - name: Add w64devkit to PATH
        run: |
          echo "$(Get-Location)\w64devkit\bin" | Out-File -Append -FilePath $env:GITHUB_PATH -Encoding utf8

      - name: Build Non-CUDA
        id: make_build
        run: |
          make LLAMA_VULKAN=1 LLAMA_PORTABLE=1 -j ${env:NUMBER_OF_PROCESSORS}

      - name: Build CUDA
        id: cmake_build
        run: |
          mkdir build
          cd build
          cmake .. -DLLAMA_CUBLAS=ON -DCMAKE_SYSTEM_VERSION="10.0.19041.0"
          cmake --build . --config Release -j 2
          cd ..

      # note: The libraries that come from the github cuda directory seem to be larger, so they are not recommended
      # - name: Download CuBLAS Libraries
      #   run: |
      #     curl -L https://github.com/LostRuins/koboldcpp/releases/download/cuda11_cublas_libraries/cublas64_11.dll --output cublas64_11.dll
      #     curl -L https://github.com/LostRuins/koboldcpp/releases/download/cuda11_cublas_libraries/cublasLt64_11.dll --output cublasLt64_11.dll
      #     ls
      - name: Copy CuBLAS Libraries
        run: |
          copy "C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v12.1\bin\cublasLt64_12.dll" .
          copy "C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v12.1\bin\cublas64_12.dll" .
          ls

      - name: Package PyInstallers
        id: make_pyinstaller
        run: |
          ./make_pyinstaller.bat
          ./make_pyinstaller_cuda.bat

      - name: Save artifact
        uses: actions/upload-artifact@v6
        with:
          name: kcpp_windows_pyinstallers
          path: dist/

      - name: Generate VK Instructions
        id: gen_vk_instructions
        run: |
          echo "If you cannot compile vulkan shaders yourself with glslc, you can manually patch in precompiled vulkan shader source files. Copy ggml-vulkan-shaders.cpp and ggml-vulkan-shaders.hpp to the ggml/src subdirectory in KoboldCpp source files before building." > vulkan-readme.txt

      - name: Upload to GitHub Rolling Release
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          gh release upload rolling dist/koboldcpp.exe --clobber
          gh release upload rolling dist/koboldcpp-nocuda.exe --clobber

      - name: Save Standalone Vulkan Shaders
        uses: actions/upload-artifact@v6
        with:
          name: vulkan_precompiled_shaders
          path: |
            ggml/src/ggml-vulkan-shaders.cpp
            ggml/src/ggml-vulkan-shaders.hpp
            vulkan-readme.txt

      - name: Build Tools
        id: make_tools
        run: |
          make tools -j 4
          New-Item -ItemType Directory -Path legacy
          Copy-Item quantize_gpt2.exe -Destination legacy
          Copy-Item quantize_gptj.exe -Destination legacy
          Copy-Item quantize_mpt.exe -Destination legacy
          Copy-Item quantize_neox.exe -Destination legacy
          Copy-Item otherarch/tools/convert_hf_gpt2.py -Destination legacy
          Copy-Item otherarch/tools/convert_hf_gptj.py -Destination legacy
          Copy-Item otherarch/tools/convert_hf_mpt.py -Destination legacy
          Copy-Item otherarch/tools/convert_hf_neox.py -Destination legacy
          Copy-Item otherarch/tools/convert_llama_ggml_to_gguf.py -Destination legacy
          Copy-Item otherarch/tools/convert_pt_rwkv.py -Destination legacy
        shell: pwsh

      - name: Upload Tools
        uses: actions/upload-artifact@v6
        with:
          name: koboldcpp_tools
          path: |
            gguf-split.exe
            quantize_gguf.exe
            whispermain.exe
            sdmain.exe
            ttsmain.exe
            convert_hf_to_gguf.py
            convert_hf_to_gguf_update.py
            conversion
            gguf-py
            legacy

      - name: Package Tools Release
        shell: pwsh
        run: |
          Compress-Archive `
            -Path `
              gguf-split.exe,
              quantize_gguf.exe,
              whispermain.exe,
              sdmain.exe,
              ttsmain.exe,
              convert_hf_to_gguf.py,
              convert_hf_to_gguf_update.py,
              conversion,
              gguf-py,
              legacy `
            -DestinationPath koboldcpp_tools.zip `
            -Force

      - name: Upload tools to GitHub Rolling Tools Release
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        shell: pwsh
        run: |
          gh release upload kcpp_tools_rolling `
            koboldcpp_tools.zip `
            --clobber