Merge pull request #2 from DilumAluthge/dpa/fix-ci

Fix CI and add some docs

Author: chriselrod

.github/workflows/ci-julia-nightly.yml

@@ -0,0 +1,51 @@
+name: CI (Julia nightly)
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+    tags: '*'
+  workflow_dispatch:
+jobs:
+  test-julia-nightly:
+    name: ${{ matrix.version }}/${{ matrix.os }}${{ matrix.arch }}/t=${{ matrix.threads }}/${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        arch:
+          - x64
+        version:
+          - 'nightly'
+        os:
+          - ubuntu-latest
+        threads:
+          - '1'
+          - '2'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      # TODO: remove the following line once StrideArrays is registered
+      - run: julia --color=yes --project -e 'import Pkg; Pkg.develop(Pkg.PackageSpec(url = "https://github.com/chriselrod/StrideArrays.jl"))'
+        shell: bash
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+        with:
+          coverage: false
+        env:
+          JULIA_NUM_THREADS: ${{ matrix.threads }}

.github/workflows/ci.yml

@@ -1,24 +1,29 @@
-name: CI
+name: CI 
 on:
-  - push
-  - pull_request
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+    tags: '*'
+  workflow_dispatch:
 jobs:
   test:
-    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    name: ${{ matrix.version }}/${{ matrix.os }}${{ matrix.arch }}/t=${{ matrix.threads }}/${{ github.event_name }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
+        arch:
+          - x64
         version:
-          - '1.5'
-          - '1.7'
-          - 'nightly'
+          - '1'
         os:
           - ubuntu-latest
-          - macOS-latest
-          - windows-latest
-        arch:
-          - x64
+        threads:
+          - '1'
+          - '2'
     steps:
       - uses: actions/checkout@v2
       - uses: julia-actions/setup-julia@v1
@@ -35,12 +40,15 @@ jobs:
             ${{ runner.os }}-test-${{ env.cache-name }}-
             ${{ runner.os }}-test-
             ${{ runner.os }}-
+      # TODO: remove the following line once StrideArrays is registered
+      - run: julia --color=yes --project -e 'import Pkg; Pkg.develop(Pkg.PackageSpec(url = "https://github.com/chriselrod/StrideArrays.jl"))'
+        shell: bash
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
-      - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v1
         with:
-          file: lcov.info
+          coverage: false
+        env:
+          JULIA_NUM_THREADS: ${{ matrix.threads }}
   docs:
     name: Documentation
     runs-on: ubuntu-latest
@@ -49,11 +57,14 @@ jobs:
       - uses: julia-actions/setup-julia@v1
         with:
           version: '1'
+      # TODO: fix the following lines once StrideArrays is registered
       - run: |
           julia --project=docs -e '
             using Pkg
-            Pkg.develop(PackageSpec(path=pwd()))
+            pkgs = [PackageSpec(path = pwd()), PackageSpec(url = "https://github.com/chriselrod/StrideArrays.jl")]
+            Pkg.develop(pkgs)
             Pkg.instantiate()'
+        shell: bash
       - run: |
           julia --project=docs -e '
             using Documenter: doctest

.gitignore

@@ -1,6 +1,7 @@
 *.jl.*.cov
 *.jl.cov
 *.jl.mem
-/Manifest.toml
-/docs/build/
+*.png
 *~
+/docs/build/
+Manifest.toml

Project.toml

@@ -13,6 +13,8 @@ MKL_jll = "856f044c-d86e-5d09-b602-aeab76dc8ba7"
 Octavian = "6fd5a793-0b7e-452c-907f-f8bfe9c57db4"
 OpenBLAS_jll = "4536629a-c528-5b80-bd46-f80d51c5b363"
 ProgressMeter = "92933f4c-e287-5a05-a399-4b506db050ca"
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+StrideArrays = "d1fa6d79-ef01-42a6-86c9-f7c551f8593b"
 Tullio = "bc48ee85-29a4-5162-ae0b-a64e1601d4bc"
 VectorizationBase = "3d5dd08c-fd9d-11e8-17fa-ed2836048c2f"
 VegaLite = "112f6efa-9a02-5b7d-90c0-432ed331239a"
@@ -22,7 +24,9 @@ blis_jll = "6136c539-28a5-5bf0-87cc-b183200dce32"
 julia = "1.5"
 
 [extras]
+InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+VectorizationBase = "3d5dd08c-fd9d-11e8-17fa-ed2836048c2f"
 
 [targets]
-test = ["Test"]
+test = ["InteractiveUtils", "Test", "VectorizationBase"]

README.md

@@ -2,9 +2,10 @@
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://chriselrod.github.io/BLASBenchmarks.jl/stable)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://chriselrod.github.io/BLASBenchmarks.jl/dev)
-[![Build Status](https://github.com/chriselrod/BLASBenchmarks.jl/workflows/CI/badge.svg)](https://github.com/chriselrod/BLASBenchmarks.jl/actions)
-[![Coverage](https://codecov.io/gh/chriselrod/BLASBenchmarks.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/chriselrod/BLASBenchmarks.jl)
-
-For Benchmarking BLAS Libraries.
+[![Continuous Integration](https://github.com/chriselrod/BLASBenchmarks.jl/workflows/CI/badge.svg)](https://github.com/chriselrod/BLASBenchmarks.jl/actions)
+[![Continuous Integration (Julia nightly)](https://github.com/chriselrod/BLASBenchmarks.jl/workflows/CI%20(Julia%20nightly)/badge.svg)](https://github.com/chriselrod/BLASBenchmarks.jl/actions?query=workflow%3A%22CI+%28Julia+nightly%29%22)
 
+BLASBenchmarks is a Julia package for benchmarking BLAS libraries.
 
+Please see the
+[documentation](https://chriselrod.github.io/BLASBenchmarks.jl/stable).

docs/Manifest.toml

@@ -1,3 +1,4 @@
 [deps]
 BLASBenchmarks = "5fdc822c-4560-4d20-af7e-e5ee461714d5"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+StrideArrays = "d1fa6d79-ef01-42a6-86c9-f7c551f8593b"

docs/Project.toml

@@ -4,18 +4,22 @@ using Documenter
 makedocs(;
     modules=[BLASBenchmarks],
     authors="Chris Elrod <[email protected]> and contributors",
-    repo="https://github.com/"Chris Elrod"/BLASBenchmarks.jl/blob/{commit}{path}#L{line}",
+    repo="https://github.com/chriselrod/BLASBenchmarks.jl/blob/{commit}{path}#L{line}",
     sitename="BLASBenchmarks.jl",
     format=Documenter.HTML(;
         prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://"Chris Elrod".github.io/BLASBenchmarks.jl",
+        canonical="https://chriselrod.github.io/BLASBenchmarks.jl",
         assets=String[],
     ),
     pages=[
         "Home" => "index.md",
+        "Usage" => "usage.md",
+        "Public API" => "public-api.md",
+        "Internals (Private)" => "internals.md",
     ],
+    strict=true,
 )
 
 deploydocs(;
-    repo="github.com/"Chris Elrod"/BLASBenchmarks.jl",
+    repo="github.com/chriselrod/BLASBenchmarks.jl",
 )

docs/make.jl

@@ -4,9 +4,15 @@ CurrentModule = BLASBenchmarks
 
 # BLASBenchmarks
 
-```@index
-```
+BLASBenchmarks is a Julia package for benchmarking BLAS libraries.
 
-```@autodocs
-Modules = [BLASBenchmarks]
-```
+The source code for this package is available in the
+[GitHub repository](https://github.com/chriselrod/BLASBenchmarks.jl).
+
+## Float64
+
+![Float64](../assets/gemm_Float64_10_30_haswell_AVX2__multithreaded_logscale.svg)
+
+## Float32
+
+![Float32](../assets/gemm_Float32_10_30_haswell_AVX2__multithreaded_logscale.svg)

docs/src/assets/gemm_Float32_10_30_haswell_AVX2__multithreaded_logscale.svg

@@ -0,0 +1,15 @@
+```@meta
+CurrentModule = BLASBenchmarks
+```
+
+# Internals (Private)
+
+```@index
+Pages   = ["internals.md"]
+```
+
+```@autodocs
+Modules = [BLASBenchmarks]
+Private = true
+Public = false
+```