Minor fixes to documentation

Julia-XAI · Oct 11, 2023 · 1409c4f · 1409c4f
1 parent efef6db
commit 1409c4f
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -22,4 +22,5 @@ To install this package and its dependencies, open the Julia REPL and run
 
 ## Related packages
 * [TextHeatmaps.jl](https://github.com/Julia-XAI/TextHeatmaps.jl):
-  Sibling package for visualization of sentiment analysis and input space attributions of NLP models.
+  Sibling package for visualization of sentiment analysis and input space attributions of NLP models.
+* [ExplainableAI.jl](https://github.com/Julia-XAI/ExplainableAI.jl): VisionHeatmaps.jl was designed as a dependency for visualization of attributions from ExplainableAI.jl.
diff --git a/docs/make.jl b/docs/make.jl
@@ -13,6 +13,7 @@ makedocs(;
         canonical="https://julia-xai.github.io/VisionHeatmaps.jl",
         edit_link="main",
         assets=String[],
+        size_threshold_ignore=["example.md"],
     ),
     pages=["Home" => "index.md", "Getting started" => "example.md"],
 )

diff --git a/docs/src/example.md b/docs/src/example.md
@@ -121,7 +121,7 @@ imgs = [load(joinpath(asset_dir, f)) for f in ("img1.png", "img2.png", "img3.png
 Once again, we assume that `val_batch` is in WHCN format:
 
 ```@example 1
-url = joinpath(asset_dir, "heatmap.jld2") # hide
+url = joinpath(asset_dir, "heatmaps.jld2") # hide
 data_heatmaps = download(url) # hide
 val_batch = load(data_heatmaps, "x") # load precomputed array from file
 typeof(val_batch)

diff --git a/src/heatmap.jl b/src/heatmap.jl
@@ -3,7 +3,7 @@ const DEFAULT_REDUCE = :sum
 const DEFAULT_RANGESCALE = :centered
 
 """
-    heatmap(val)
+    heatmap(x)
 
 Visualize 4D arrays as heatmaps, assuming the WHCN convention for input array dimensions
 (width, height, color channels, batch dimension).