Make XAIBase a direct dependency (#5)

Author: adrhill

Project.toml

@@ -1,27 +1,19 @@
 name = "TextHeatmaps"
 uuid = "2dd6718a-6083-4824-b9f7-90e4a57f72d2"
 authors = ["Adrian Hill <[email protected]>"]
-version = "1.2.0"
+version = "1.2.1-DEV"
 
 [deps]
 ColorSchemes = "35d6a980-a343-548e-a6ea-1d62b119f2f4"
 Colors = "5ae59095-9a9b-59fe-a467-6f913c188581"
 Crayons = "a8cc5b0e-0ffa-5ad4-8c14-923d3ee1735f"
 FixedPointNumbers = "53c48c17-4a7d-5ca2-90c5-79b7896eea93"
-Requires = "ae029012-a4dd-5104-9daa-d747884805df"
 XAIBase = "9b48221d-a747-4c1b-9860-46a1d8ba24a7"
 
-[weakdeps]
-XAIBase = "9b48221d-a747-4c1b-9860-46a1d8ba24a7"
-
-[extensions]
-TextHeatmapsXAIBaseExt = "XAIBase"
-
 [compat]
 ColorSchemes = "3"
 Colors = "0.12"
 Crayons = "4"
 FixedPointNumbers = "0.8"
-Requires = "1"
 XAIBase = "3"
 julia = "1.6"

src/TextHeatmaps.jl

@@ -4,18 +4,10 @@ using Crayons: Crayon
 using FixedPointNumbers: N0f8
 using Colors: Colorant, RGB, hex
 using ColorSchemes: ColorScheme, colorschemes, get, seismic
-using Requires: @require
+using XAIBase: Explanation, AbstractXAIMethod, analyze
 
 include("heatmap.jl")
-
-if !isdefined(Base, :get_extension)
-    using Requires
-    function __init__()
-        @require XAIBase = "9b48221d-a747-4c1b-9860-46a1d8ba24a7" include(
-            "../ext/TextHeatmapsXAIBaseExt.jl"
-        )
-    end
-end
+include("xaibase.jl")
 
 export heatmap
 

src/heatmap.jl

@@ -1,8 +1,9 @@
-const DEFAULT_COLORSCHEME = seismic
+const DEFAULT_COLORSCHEME = :seismic
 const DEFAULT_RANGESCALE = :centered
+const DEFAULT_REDUCE = :sum
 
 """
-    heatmap(values, words)
+    heatmap(values::AbstractArray, words)
 
 Create a heatmap of words where the background color of each word is determined by its corresponding value.
 Arguments `values` and `words` (and optionally `colors`) must have the same size.

ext/TextHeatmapsXAIBaseExt.jl renamed to src/xaibase.jl

@@ -1,5 +1,3 @@
-module TextHeatmapsXAIBaseExt
-
 using TextHeatmaps, XAIBase
 
 struct HeatmapConfig
@@ -8,9 +6,6 @@ struct HeatmapConfig
     rangescale::Symbol
 end
 
-const DEFAULT_COLORSCHEME = :seismic
-const DEFAULT_REDUCE = :sum
-const DEFAULT_RANGESCALE = :centered
 const DEFAULT_HEATMAP_PRESET = HeatmapConfig(
     DEFAULT_COLORSCHEME, DEFAULT_REDUCE, DEFAULT_RANGESCALE
 )
@@ -37,17 +32,13 @@ function get_heatmapping_config(expl::Explanation; kwargs...)
 end
 
 """
-    heatmap(explanation, text)
+    heatmap(expl::Explanation, text)
 
-Visualize [`Explanation`](@ref) from XAIBase as text heatmap.
+Visualize `Explanation` from XAIBase as text heatmap.
 Text should be a vector containing vectors of strings, one for each input in the batched explanation.
 
-## Keyword arguments
-- `colorscheme::Union{ColorScheme,Symbol}`: color scheme from ColorSchemes.jl.
-  Defaults to `:$DEFAULT_COLORSCHEME`.
-- `rangescale::Symbol`: selects how the color channel reduced heatmap is normalized
-  before the color scheme is applied. Can be either `:extrema` or `:centered`.
-  Defaults to `:$DEFAULT_RANGESCALE` for use with the default color scheme `:$DEFAULT_COLORSCHEME`.
+This will use the default heatmapping style for the given type of explanation.
+Defaults can be overridden via keyword arguments.
 """
 function TextHeatmaps.heatmap(
     expl::Explanation, texts::AbstractVector{<:AbstractVector{<:AbstractString}}; kwargs...
@@ -75,5 +66,3 @@ function TextHeatmaps.heatmap(
 )
     return heatmap(expl, [text]; kwargs...)
 end
-
-end # module

test/runtests.jl

@@ -21,8 +21,8 @@ using JuliaFormatter
         @info "Testing heatmaps..."
         include("test_heatmap.jl")
     end
-    @testset "XAIBase extension" begin
+    @testset "XAIBase Explanations" begin
         @info "Testing heatmaps on XAIBase explanations..."
-        include("test_xaibase_ext.jl")
+        include("test_xaibase.jl")
     end
 end