Fix misleading phrasing in error message (#21)

* Fix misleading phrasing in error message

* Update CI workflow

* Use stable RNG in tests

Author: adrhill

.github/workflows/CI.yml

@@ -19,16 +19,16 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.6'
+          - 'lts'
           - '1'
-          - 'nightly'
+          - 'pre'
         os:
           - ubuntu-latest
         arch:
           - x64
     steps:
-      - uses: actions/checkout@v3
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
@@ -38,7 +38,7 @@ jobs:
       - uses: julia-actions/julia-runtest@v1
         continue-on-error: ${{ matrix.version == 'nightly' }}
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v5
         with:
           files: lcov.info
 
@@ -47,7 +47,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v1
+      - uses: julia-actions/setup-julia@v2
         with:
           version: '1'
       - run: |

src/output_selection.jl

@@ -1,5 +1,5 @@
-const BATCHDIM_MISSING = ArgumentError(
-    "The input is a 1D vector and therefore missing the required batch dimension."
+const BATCHDIM_MISSING_OUTPUT = ArgumentError(
+    "The output is a 1D vector and therefore missing the required batch dimension."
 )
 
 const NOTE_OUTPUT_SELECTOR = "## Note
@@ -44,7 +44,7 @@ julia> output_selector(output)
 """
 struct MaxActivationSelector <: AbstractOutputSelector end
 function (::MaxActivationSelector)(out::AbstractArray{T,N}) where {T,N}
-    N < 2 && throw(BATCHDIM_MISSING)
+    N < 2 && throw(BATCHDIM_MISSING_OUTPUT)
     return vec(argmax(out; dims=1:(N - 1)))
 end
 
@@ -77,12 +77,12 @@ struct IndexSelector{I} <: AbstractOutputSelector
     index::I
 end
 function (s::IndexSelector{<:Integer})(out::AbstractArray{T,N}) where {T,N}
-    N < 2 && throw(BATCHDIM_MISSING)
+    N < 2 && throw(BATCHDIM_MISSING_OUTPUT)
     batchsize = size(out, N)
     return [CartesianIndex{N}(s.index, b) for b in 1:batchsize]
 end
 function (s::IndexSelector{I})(out::AbstractArray{T,N}) where {I,T,N}
-    N < 2 && throw(BATCHDIM_MISSING)
+    N < 2 && throw(BATCHDIM_MISSING_OUTPUT)
     batchsize = size(out, N)
     return [CartesianIndex{N}(s.index..., b) for b in 1:batchsize]
 end

test/Project.toml

@@ -4,4 +4,5 @@ JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 ReferenceTests = "324d217c-45ce-50fc-942e-d289b448e8cf"
+StableRNGs = "860ef19b-820b-49d6-a774-d7a799459cd3"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

test/test_output_selection.jl

@@ -3,6 +3,7 @@ using Test
 
 using XAIBase: MaxActivationSelector, IndexSelector
 using Test
+using StableRNGs: StableRNG
 using Random
 
 ns_max = @inferred MaxActivationSelector()
@@ -53,16 +54,16 @@ I_idx = @inferred ns_idx(A)
 
 # 4x3x2 input with Tuple IndexSelector
 ns_idx = @inferred IndexSelector((4, 2))
-A = rand(MersenneTwister(1234), Float32, 4, 3, 2)
+A = rand(StableRNG(1234), Float32, 4, 3, 2)
 R = similar(A)
 
 I_max = @inferred ns_max(A)
 I_idx = @inferred ns_idx(A)
 @test I_max isa Vector{CartesianIndex{3}}
 @test I_idx isa Vector{CartesianIndex{3}}
 @test I_max == [
-    CartesianIndex(2, 1, 1)
-    CartesianIndex(4, 1, 2)
+    CartesianIndex(2, 3, 1)
+    CartesianIndex(4, 3, 2)
 ]
 @test I_idx == [
     CartesianIndex(4, 2, 1)