Merge pull request #230 from LibRapid/test

Pencilcaseman · web-flow · commit 5cbe7a042c12 · 2023-09-04T15:09:42.000+01:00
Include benchmarks in documentation
diff --git a/.github/workflows/continuous-integration.yaml b/.github/workflows/continuous-integration.yaml
@@ -291,26 +291,8 @@ jobs:
           cd buildRelease
           ctest -C Release --output-on-failure
 
-  quodona:
-    name: Run Qodana
-    needs: compile
-    runs-on: ubuntu-latest
-    continue-on-error: true
-
-    steps:
-      - name: Checkout LibRapid
-        uses: actions/checkout@v3
-        with:
-          submodules: recursive
-
-      # - name: Qodana Scan
-      #   uses: JetBrains/qodana-action@main
-      #   env:
-      #     QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
-
   build-docs:
     name: Build Documentation Locally
-    needs: [ compile ]
     runs-on: ubuntu-latest
 
     steps:
@@ -399,25 +381,243 @@ jobs:
           path: docs/build/**
 
   run-benchmarks:
-    name: Run Benchmarks
-    needs: [ compile ]
+    name: Run Benchmarks on ${{ matrix.os }} with ${{ matrix.cxx }}
+    needs: [ compile, build-docs ]
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            cc: ../../llvm/bin/clang
+            cxx: ../../llvm/bin/clang++
+            clangVer: "15.0"
+            smallArrays: ON
+            pretty: "LibRapid_Ubuntu_Clang_OptimiseSmallArrays"
+
+          - os: ubuntu-latest
+            cc: ../../llvm/bin/clang
+            cxx: ../../llvm/bin/clang++
+            clangVer: "15.0"
+            smallArrays: OFF
+            pretty: "LibRapid_Ubuntu_Clang"
+
+          - os: ubuntu-latest
+            cc: gcc-11
+            cxx: g++-11
+            smallArrays: ON
+            pretty: "LibRapid_Ubuntu_GCC_OptimiseSmallArrays"
+
+          - os: ubuntu-latest
+            cc: gcc-11
+            cxx: g++-11
+            smallArrays: OFF
+            pretty: "LibRapid_Ubuntu_GCC"
+
+          - os: macos-latest
+            cc: ../../llvm/bin/clang
+            cxx: ../../llvm/bin/clang++
+            clangVer: "15.0"
+            smallArrays: ON
+            pretty: "LibRapid_MacOS_Clang_OptimiseSmallArrays"
+
+          - os: macos-latest
+            cc: ../../llvm/bin/clang
+            cxx: ../../llvm/bin/clang++
+            clangVer: "15.0"
+            smallArrays: OFF
+            pretty: "LibRapid_MacOS_Clang"
+
+          - os: macos-latest
+            cc: gcc-11
+            cxx: g++-11
+            smallArrays: ON
+            pretty: "LibRapid_MacOS_GCC_OptimiseSmallArrays"
+
+          - os: macos-latest
+            cc: gcc-11
+            cxx: g++-11
+            smallArrays: OFF
+            pretty: "LibRapid_MacOS_GCC"
+
+          - os: windows-latest
+            cc: ../../llvm/clang
+            cxx: ../../llvm/clang++
+            clangVer: "15.0"
+            smallArrays: ON
+            pretty: "LibRapid_Windows_Clang_OptimiseSmallArrays"
+
+          - os: windows-latest
+            cc: ../../llvm/clang
+            cxx: ../../llvm/clang++
+            clangVer: "15.0"
+            smallArrays: OFF
+            pretty: "LibRapid_Windows_Clang"
+
+          - os: windows-latest
+            cc: msvc
+            cxx: msvc
+            smallArrays: ON
+            pretty: "LibRapid_Windows_MSVC_OptimiseSmallArrays"
+
+          - os: windows-latest
+            cc: msvc
+            cxx: msvc
+            smallArrays: OFF
+            pretty: "LibRapid_Windows_MSVC"
+
+    steps:
+      - name: Install Clang
+        if: matrix.clangVer != null
+        uses: KyleMayes/install-llvm-action@v1
+        with:
+          version: ${{ matrix.clangVer }}
+          directory: "./llvm"
+          env: on
+
+      - name: Install XCode
+        if: matrix.os == 'macos-latest'
+        uses: maxim-lobanov/setup-xcode@v1.5.1
+
+      - name: Clone Benchmark Repository
+        run: |
+          git clone https://github.com/LibRapid/BenchmarksCPP.git --recursive
+
+      - name: Update LibRapid Submodule
+        run: |
+          cd BenchmarksCPP
+          cd vendor/librapid
+          git checkout ${{ github.head_ref || github.ref_name }} -- || git checkout ${{ github.ref }}
+          git pull
+          git submodule update --init --recursive
+
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+
+      - name: Install Requirements
+        run: |
+          pip install --upgrade pip
+          cd BenchmarksCPP
+          pip install -r requirements.txt
+
+      - name: Compile Benchmarks
+        run: |
+          cd BenchmarksCPP
+          mkdir build
+          cd build
+          cmake .. -DCMAKE_BUILD_TYPE=Release -DUSING_GITHUB_ACTIONS=ON -DLIBRAPID_OPTIMISE_SMALL_ARRAYS=${{ matrix.smallArrays }}
+          cmake --build . --config Release
+        env:
+          CC: ${{ matrix.cc }}
+          CXX: ${{ matrix.cxx }}
+
+      # On Windows, the generated executable is in "build/Release"
+      - name: Run Benchmarks
+        if: matrix.os == 'windows-latest'
+        run: |
+          cd BenchmarksCPP/build/Release
+          ./BenchmarksCPP.exe
+
+        # On Unix systems, the generated executable is in "build"
+      - name: Run Benchmarks
+        if: matrix.os != 'windows-latest'
+        run: |
+          cd BenchmarksCPP/build
+          ./BenchmarksCPP
+
+      - name: Generate Benchmark Graphs
+        if: matrix.os == 'windows-latest'
+        run: |
+          cd BenchmarksCPP/scripts
+          python dataProcessor.py --directory ../build/Release --output ../../${{ matrix.pretty }} --relative Eigen --verbose
+
+      - name: Generate Benchmark Graphs
+        if: matrix.os != 'windows-latest'
+        run: |
+          cd BenchmarksCPP/scripts
+          python dataProcessor.py --directory ../build --output ../../${{ matrix.pretty }} --relative Eigen --verbose
+
+      - name: Upload Intermediate Benchmark Results
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ matrix.pretty }}
+          path: ${{ matrix.pretty }}
+
+  upload-benchmarks:
+    name: Upload Benchmark Results
+    needs: run-benchmarks
     runs-on: ubuntu-latest
     steps:
-      - name: Create a Test File
+      - name: Checkout LibRapid
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+
+      - name: Download Intermediate Benchmark Results
+        uses: actions/download-artifact@v2
+        with:
+          path: IntermediateBenchmarkResults
+
+      - name: Tree IntermediateBenchmarkResults
         run: |
-          mkdir BENCH_RESULTS
-          touch BENCH_RESULTS/hello.txt
-          echo "Hello, World!" > BENCH_RESULTS/hello.txt
+          cd IntermediateBenchmarkResults
+          tree
+          
+      - name: Upload Intermediate Benchmark Results
+        uses: actions/upload-artifact@v3
+        with:
+          name: IntermediateBenchmarkResults
+          path: IntermediateBenchmarkResults
 
-      - name: Upload Benchmark Results
+      - name: Auto-Generate Benchmark Documentation
+        run: |
+          git clone https://github.com/LibRapid/BenchmarksCPP.git
+          cd BenchmarksCPP
+          pip install --upgrade pip
+          pip install -r requirements.txt
+          cd scripts
+          python docGenerator.py --input ../../IntermediateBenchmarkResults --output ../../BenchmarkDocumentation
+
+      - name: Tree BenchmarkDocumentation
+        run: |
+          cd BenchmarkDocumentation
+          tree
+
+      - name: Upload Benchmark Documentation
         uses: actions/upload-artifact@v3
         with:
-          name: benchmark-results-for-${{ github.sha }}
-          path: BENCH_RESULTS/
+          name: LibRapid_Benchmark_SHA_${{ github.sha }}
+          path: BenchmarkDocumentation
+
+  quodona:
+    name: Run Qodana
+    needs: [ compile, upload-benchmarks ]
+    runs-on: ubuntu-latest
+    continue-on-error: true
+
+    steps:
+      - name: Checkout LibRapid
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      # - name: Qodana Scan
+      #   uses: JetBrains/qodana-action@main
+      #   env:
+      #     QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
 
   code-coverage:
     name: Code Coverage
-    needs: [ compile ]
+    needs: [ compile, upload-benchmarks ]
     runs-on: ubuntu-latest
     continue-on-error: true
 
@@ -460,7 +660,7 @@ jobs:
 
   trigger-docs:
     name: Trigger Documentation Build
-    needs: [ run-benchmarks, quodona, build-docs ]
+    needs: [ compile, build-docs, quodona, code-coverage ]
     runs-on: ubuntu-latest
     if: github.event_name != 'pull_request'
     steps:
@@ -478,7 +678,7 @@ jobs:
 
   success:
     name: Success
-    needs: [ trigger-docs ]
+    needs: trigger-docs
     runs-on: ubuntu-latest
     steps:
       - name: Print Success
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -13,7 +13,6 @@ python:
   version: "3.8"
   # install:
   #   - requirements: docs/requirements.txt
-  system_packages: true
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
diff --git a/README.md b/README.md
@@ -19,9 +19,6 @@
 
 ---
 
-(As a student, it's difficult to spend a lot of time on this project. If you like what I'm doing, a
-small [donation](https://github.com/sponsors/Pencilcaseman) would mean a lot to me!)
-
 ![Simple Demo](https://raw.githubusercontent.com/LibRapid/librapid_extras/master/images/librapidSimpleDemo.png)
 
 # What is LibRapid?
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -99,10 +99,10 @@
 if os.environ.get("GITHUB_TOKEN") is not None:
     extensions.append("rtds_action")
     rtds_action_github_repo = "LibRapid/librapid"
-    rtds_action_path = "BENCH_RESULTS"
-    rtds_action_artifact_prefix = "benchmark-results-for-"
+    rtds_action_path = "BenchmarkResults"
+    rtds_action_artifact_prefix = "LibRapid_Benchmark_SHA_"
     rtds_action_github_token = os.environ["GITHUB_TOKEN"]
-    rtds_action_error_if_missing = False
+    rtds_action_error_if_missing = True
 
 autosectionlabel_prefix_document = True
 
@@ -182,10 +182,10 @@
     <img src="/en/latest/_static/LR_icon.png" alt="LibRapid" width="22.5"></img>
     <a href="https://github.com/sponsors/Pencilcaseman">
         <span class="banner-resize-text-lg">
-            If you like LibRapid, please consider a small donation support its development!
+            If you like LibRapid, please consider supporting its development!
         </span>
         <span class="banner-resize-text-sm">
-            Please consider donating!
+            Support LibRapid's Development!
         </span>
     </a>
 </div>
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -38,11 +38,18 @@ View LibRapid's API and documentation.
 Learn how to use some of LibRapid's features.
 :::
 
-:::{grid-item-card} {octicon}`stopwatch` Performance and Benchmarks
+:::{grid-item-card} {octicon}`stopwatch` Performance Tips
 :link: performance/performance
 :link-type: doc
 
-View LibRapid's benchmark results.
+Learn how to get the most out of LibRapid.
+:::
+
+:::{grid-item-card} {octicon}`fold` Benchmarks
+:link: BenchmarkResults/BenchmarkResults
+:link-type: doc
+
+See how LibRapid compares to other libraries.
 :::
 
 :::{grid-item-card} {octicon}`alert` Caution
diff --git a/librapid/include/librapid/array/linalg/transpose.hpp b/librapid/include/librapid/array/linalg/transpose.hpp
diff --git a/librapid/src/preMain.cpp b/librapid/src/preMain.cpp
