Merge pull request #2744 from lukaszstolarczuk/bench-fixes

[CI][Bench] Fix for pip packages and fix md file path

Author: lukaszstolarczuk

.github/workflows/benchmarks-nightly.yml

@@ -10,7 +10,7 @@ permissions:
 
 jobs:
   nightly:
-    name: Compute Benchmarks Nightly level-zero PVC
+    name: '[PVC] CB Nightly level-zero'
     uses: ./.github/workflows/benchmarks-reusable.yml
     with:
       str_name: 'level_zero'
@@ -23,10 +23,9 @@ jobs:
       runner: 'level_zero_PERF'
 
   nightly2:
-    # we need to wait until previous job is done so that the html report
-    # contains both runs
+    # uses the same machine, so let's just wait for the prev. job
     needs: nightly
-    name: Compute Benchmarks Nightly level-zero v2 PVC
+    name: '[PVC] CB Nightly level-zero v2'
     uses: ./.github/workflows/benchmarks-reusable.yml
     with:
         str_name: 'level_zero_v2'
@@ -39,7 +38,7 @@ jobs:
         runner: 'level_zero_PERF'
 
   nightly3:
-    name: Compute Benchmarks Nightly level-zero BMG
+    name: '[BMG] CB Nightly level-zero'
     uses: ./.github/workflows/benchmarks-reusable.yml
     with:
       str_name: 'level_zero'
@@ -52,10 +51,9 @@ jobs:
       runner: 'DSS-L0-BMG'
 
   nightly4:
-    # we need to wait until previous job is done so that the html report
-    # contains both runs
+    # uses the same machine, so let's just wait for the prev. job
     needs: nightly3
-    name: Compute Benchmarks Nightly level-zero v2 BMG
+    name: '[BMG] CB Nightly level-zero v2'
     uses: ./.github/workflows/benchmarks-reusable.yml
     with:
         str_name: 'level_zero_v2'

.github/workflows/benchmarks-reusable.yml

@@ -37,14 +37,13 @@ on:
       runner:
         required: true
         type: string
-        default: 'level_zero_PERF'
 
 permissions:
   contents: write
   pull-requests: write
 
 jobs:
-  e2e-build-hw:
+  benchmarks:
     name: Build SYCL, UR, run Compute Benchmarks
     strategy:
       matrix:
@@ -54,7 +53,6 @@ jobs:
           }
         ]
         build_type: [Release]
-        compiler: [{c: clang, cxx: clang++}]
 
     runs-on: "${{ inputs.runner }}"
 
@@ -92,12 +90,11 @@ jobs:
         ref: benchmark-results
         path: results-repo
 
-    - name: Create virtual environment
-      run: python -m venv .venv
-
-    - name: Activate virtual environment and install pip packages
+    - name: Install Python requirements in venv
       run: |
+        python -m venv .venv
         source .venv/bin/activate
+        echo "$PATH" >> $GITHUB_PATH
         pip install -r sc/devops/scripts/benchmarks/requirements.txt
 
     - name: Checkout SYCL
@@ -175,7 +172,6 @@ jobs:
     - name: Run benchmarks
       id: benchmarks
       run: >
-        source .venv/bin/activate &&
         taskset -c ${{ env.CORES }} ./sc/devops/scripts/benchmarks/main.py
         ~/ur_bench_workdir
         --sycl ${{ github.workspace }}/sycl_build
@@ -189,9 +185,10 @@ jobs:
         --preset ${{ inputs.preset }}
         ${{ inputs.bench_script_params }}
 
+    # In case it failed to add a comment, we can still print the results.
     - name: Print benchmark results
-      run: |
-        cat ${{ github.workspace }}/sc/devops/scripts/benchmarks/benchmark_results.md || true
+      if: ${{ always() }}
+      run: cat ${{ github.workspace }}/benchmark_results.md || true
 
     - name: Add comment to PR
       uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
@@ -201,7 +198,7 @@ jobs:
           let markdown = ""
           try {
             const fs = require('fs');
-            markdown = fs.readFileSync('sc/devops/scripts/benchmarks/benchmark_results.md', 'utf8');
+            markdown = fs.readFileSync('${{ github.workspace }}/benchmark_results.md', 'utf8');
           } catch(err) {
           }
 
@@ -227,7 +224,7 @@ jobs:
         git config --global user.email "actions@github.com"
 
         for attempt in {1..5}; do
-          echo "Attempt $attempt to push changes"
+          echo "Attempt #$attempt to push changes"
 
           rm -f data.json
           cp ${{ github.workspace }}/sc/devops/scripts/benchmarks/html/data.json .

.github/workflows/benchmarks.yml

@@ -25,6 +25,8 @@ on:
         type: number
         required: true
       bench_script_params:
+        # If you want to save the results of the manual run in 'benchmark-results' branch,
+        # you have to pass '--save XXX', where XXX is the label of your results.
         description: Parameters passed to the script executing benchmark
         type: string
         required: false