renamed EndoROAR to ClapROAR as in Classifier-preserving ROAR

Author: pat-alt

dev/notebooks/endo_roar_generator.qmd

@@ -16,7 +16,7 @@ output_path = output_dir("generator")
 www_path = www_dir("generator")
 ```
 
-# `EndoROARGenerator`
+# `ClapROARGenerator`
 
 ```{julia}
 using MLJ
@@ -94,7 +94,7 @@ counterfactuals_strict = []
 generators = []
 for λ₂ ∈ Λ₂  
     λ = [0.1, λ₂]
-    generator = EndoROARGenerator(λ=λ)
+    generator = ClapROARGenerator(λ=λ)
     generators = vcat(generators..., generator)
     counterfactuals_strict = vcat(
       counterfactuals_strict...,
@@ -120,7 +120,7 @@ plt = plot(plts..., size=(1200,300), layout=(1,3))
 ```{julia}
 generators = Dict(
     :Generic => GenericGenerator(),
-    :ROAR => EndoROARGenerator()
+    :ROAR => ClapROARGenerator()
 )
 counterfactuals = Dict([name => generate_counterfactual(x, target, counterfactual_data, M, gen; T=T) for (name, gen) in generators])
 ```

dev/notebooks/mitigation_strategies.qmd

@@ -24,9 +24,10 @@ models = [
 ]
 generators = Dict(
     :Generic=>GenericGenerator(decision_threshold=0.5),
+    :REVISE=>REVISEGenerator(),
     :Generic_conservative=>GenericGenerator(decision_threshold=0.9),
     :Gravitational=>GravitationalGenerator(),
-    :ROAR=>EndoROARGenerator()
+    :ClapROAR=>ClapROARGenerator()
 )
 ```
 
@@ -231,14 +232,12 @@ end
 
 ### Latent Space Search
 
-
-
 ```{julia}
 generators = Dict(
     :REVISE=>GenericGenerator(decision_threshold=0.5),
     :REVISE_conservative=>GenericGenerator(decision_threshold=0.9),
     :Gravitational=>GravitationalGenerator(),
-    :ROAR=>EndoROARGenerator()
+    :ROAR=>ClapROARGenerator()
 )
 ```
 

src/AlgorithmicRecourseDynamics.jl

@@ -10,7 +10,7 @@ using .Models
 
 include("generators/Generators.jl")
 using .Generators
-export GravitationalGenerator, EndoROARGenerator
+export GravitationalGenerator, ClapROARGenerator
 
 include("experiments/Experiments.jl")
 using .Experiments

src/experiments/functions.jl

@@ -10,6 +10,7 @@ using Parameters
     intersect_::Bool = true
     convergence::Symbol = :threshold_only
     generative_model_params::NamedTuple = (;)
+    latent_space::Union{Nothing, Bool} = nothing
 end
 
 mutable struct Experiment
@@ -162,7 +163,8 @@ function update!(experiment::Experiment, recourse_system::RecourseSystem, chosen
     factuals = select_factual(counterfactual_data,chosen_individuals)
     results = generate_counterfactual(
         factuals, target, counterfactual_data, M, generator; 
-        T=T, num_counterfactuals=experiment.num_counterfactuals, generative_model_params=args.generative_model_params
+        T=T, num_counterfactuals=experiment.num_counterfactuals, generative_model_params=args.generative_model_params,
+        latent_space=args.latent_space
     );
 
     indices_ = rand(1:experiment.num_counterfactuals,length(results)) # randomly draw from generated counterfactuals

src/generators/EndoROARGenerator.jl

@@ -1,6 +1,6 @@
 using LinearAlgebra, CounterfactualExplanations
 
-mutable struct EndoROARGenerator <: AbstractGradientBasedGenerator
+mutable struct ClapROARGenerator <: AbstractGradientBasedGenerator
     loss::Union{Nothing,Symbol} # loss function
     complexity::Function # complexity function
     λ::Union{AbstractFloat,AbstractVector} # strength of penalty
@@ -11,13 +11,13 @@ end
 
 # API streamlining:
 using Parameters, Flux
-@with_kw struct EndoROARGeneratorParams
+@with_kw struct ClapROARGeneratorParams
     opt::Any=Flux.Optimise.Descent()
     τ::AbstractFloat=1e-5
 end
 
 """
-    EndoROARGenerator(
+    ClapROARGenerator(
         ;
         loss::Symbol=:logitbinarycrossentropy,
         complexity::Function=norm,
@@ -30,23 +30,23 @@ An outer constructor method that instantiates a generic generator.
 
 # Examples
 ```julia-repl
-generator = EndoROARGenerator()
+generator = ClapROARGenerator()
 ```
 """
-function EndoROARGenerator(
+function ClapROARGenerator(
     ;
     loss::Union{Nothing,Symbol}=nothing,
     complexity::Function=norm,
     λ::Union{AbstractFloat,AbstractVector}=[0.1,5.0],
     decision_threshold=nothing,
     kwargs...
 )
-    params = EndoROARGeneratorParams(;kwargs...)
-    EndoROARGenerator(loss, complexity, λ, decision_threshold, params.opt, params.τ)
+    params = ClapROARGeneratorParams(;kwargs...)
+    ClapROARGenerator(loss, complexity, λ, decision_threshold, params.opt, params.τ)
 end
 
 using Flux
-function gradient_penalty(generator::EndoROARGenerator, counterfactual_state::CounterfactualState.State)
+function gradient_penalty(generator::ClapROARGenerator, counterfactual_state::CounterfactualState.State)
 
     x_ = counterfactual_state.f(counterfactual_state.s′)
     M = counterfactual_state.M
@@ -68,7 +68,7 @@ import CounterfactualExplanations.Generators: h
 
 The default method to apply the generator complexity penalty to the current counterfactual state for any generator.
 """
-function h(generator::EndoROARGenerator, counterfactual_state::CounterfactualState.State)
+function h(generator::ClapROARGenerator, counterfactual_state::CounterfactualState.State)
 
     # Distance from factual:
     dist_ = generator.complexity(counterfactual_state.x .- counterfactual_state.f(counterfactual_state.s′))

src/generators/Generators.jl

@@ -3,7 +3,7 @@ module Generators
 include("GravitationalGenerator.jl")
 export GravitationalGenerator
 
-include("EndoROARGenerator.jl")
-export EndoROARGenerator
+include("ClapROARGenerator.jl")
+export ClapROARGenerator
 
 end