Merge pull request #512 from JuliaTrustworthyAI/counterfactual-method…

…-for-flattened done
JuliaTrustworthyAI · Jan 13, 2025 · eab93a0 · eab93a0 · pat-alt · Jan 13, 2025
2 parents b4b0527 + 1a4dc7a
commit eab93a0
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 *Note*: We try to adhere to these practices as of version [v1.1.1].
 
+## Version [1.4.5] - 2025-01-13
+
+### Changed
+
+- Dispatching `factual` and `counterfactual` over `AbstractCounterfactualExplanation` instead of `CounterfactualExplanation`. [#512]
+- Added type conversion to `compute_divergence`. [#512]
+
 ## Version [1.4.4] - 2025-01-08
 
 ### Added

diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "CounterfactualExplanations"
 uuid = "2f13d31b-18db-44c1-bc43-ebaf2cff0be0"
 authors = ["Patrick Altmeyer <p.altmeyer@tudelft.nl> and contributors"]
-version = "1.4.4"
+version = "1.4.5"
 
 [deps]
 CategoricalArrays = "324d7699-5711-5eae-9e2f-1d82baa6b597"

diff --git a/src/counterfactuals/info_extraction.jl b/src/counterfactuals/info_extraction.jl
@@ -1,9 +1,9 @@
 """
-    factual(ce::CounterfactualExplanation)
+    factual(ce::AbstractCounterfactualExplanation)
 
 A convenience method to retrieve the factual `x`.
 """
-function factual(ce::CounterfactualExplanation)
+function factual(ce::AbstractCounterfactualExplanation)
     return ce.factual
 end
 
@@ -29,11 +29,11 @@ function factual_label(ce::CounterfactualExplanation)
 end
 
 """
-    counterfactual(ce::CounterfactualExplanation)
+    counterfactual(ce::AbstractCounterfactualExplanation)
 
 A convenience method that returns the counterfactual.
 """
-function counterfactual(ce::CounterfactualExplanation)
+function counterfactual(ce::AbstractCounterfactualExplanation)
     return ce.counterfactual
 end
 

diff --git a/src/evaluation/benchmark.jl b/src/evaluation/benchmark.jl
@@ -587,7 +587,10 @@ function compute_divergence(
             _df.pval .= NaN
         else
             metric = measure[String.(measure_name.(measure)) .== unique(_df.variable)[1]][1]
-            val, pval = metric(collect(_df.ce), data)
+            ces =
+                collect(_df.ce) |>
+                ces -> [convert(AbstractCounterfactualExplanation, ce) for ce in ces]
+            val, pval = metric(ces, data)
             _df.value .= val
             _df.pval .= pval
         end