build based on bd98fcb

v0.1.32/contribute/performance/index.html

@@ -10,4 +10,4 @@
 
 # Search:
 generator = GenericGenerator()
-ce = generate_counterfactual(x, target, counterfactual_data, M, generator)</code></pre><pre><code class="language-julia hljs">counterfactual_data_large = load_linearly_separable(100000)</code></pre><pre><code class="language-julia hljs">@time generate_counterfactual(x, target, counterfactual_data, M, generator)</code></pre><pre><code class="language-julia hljs">@time generate_counterfactual(x, target, counterfactual_data_large, M, generator)</code></pre></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 20 March 2024 15:54">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ce = generate_counterfactual(x, target, counterfactual_data, M, generator)</code></pre><pre><code class="language-julia hljs">counterfactual_data_large = load_linearly_separable(100000)</code></pre><pre><code class="language-julia hljs">@time generate_counterfactual(x, target, counterfactual_data, M, generator)</code></pre><pre><code class="language-julia hljs">@time generate_counterfactual(x, target, counterfactual_data_large, M, generator)</code></pre></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 20 March 2024 15:55">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

v0.1.32/explanation/categorical/index.html

@@ -117,4 +117,4 @@
  0.0
  0.0
  1.0
- 1.85</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../optimisers/jsma/">« JSMA</a><a class="docs-footer-nextpage" href="../../how_to_guides/">Overview »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 20 March 2024 15:54">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 1.85</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../optimisers/jsma/">« JSMA</a><a class="docs-footer-nextpage" href="../../how_to_guides/">Overview »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 20 March 2024 15:55">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

v0.1.32/explanation/generators/clap_roar/index.html

@@ -3,4 +3,4 @@
 \text{extcost}(f(\mathbf{s}^\prime)) = l(M(f(\mathbf{s}^\prime)),y^\prime)
 \end{aligned}\]</p><p>for each counterfactual <span>$k$</span> where <span>$l$</span> denotes the loss function used to train <span>$M$</span>. This approach is based on the intuition that (endogenous) model shifts will be triggered by counterfactuals that increase classifier loss (Altmeyer et al. 2023).</p><h2 id="Usage"><a class="docs-heading-anchor" href="#Usage">Usage</a><a id="Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Usage" title="Permalink"></a></h2><p>The approach can be used in our package as follows:</p><pre><code class="language-julia hljs">generator = ClaPROARGenerator()
 ce = generate_counterfactual(x, target, counterfactual_data, M, generator)
-plot(ce)</code></pre><p><img src="../clap_roar_files/figure-commonmark/cell-3-output-1.svg" alt/></p><h3 id="Comparison-to-GenericGenerator"><a class="docs-heading-anchor" href="#Comparison-to-GenericGenerator">Comparison to <code>GenericGenerator</code></a><a id="Comparison-to-GenericGenerator-1"></a><a class="docs-heading-anchor-permalink" href="#Comparison-to-GenericGenerator" title="Permalink"></a></h3><p>The figure below compares the outcome for the <code>GenericGenerator</code> and the <code>ClaPROARGenerator</code>.</p><p><img src="../clap_roar_files/figure-commonmark/cell-5-output-1.svg" alt/></p><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>Altmeyer, Patrick, Giovan Angela, Aleksander Buszydlik, Karol Dobiczek, Arie van Deursen, and Cynthia Liem. 2023. “Endogenous Macrodynamics in Algorithmic Recourse.” In <em>First IEEE Conference on Secure and Trustworthy Machine Learning</em>.</p><p>Upadhyay, Sohini, Shalmali Joshi, and Himabindu Lakkaraju. 2021. “Towards Robust and Reliable Algorithmic Recourse.” <a href="https://arxiv.org/abs/2102.13620">https://arxiv.org/abs/2102.13620</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../generic/">« Generic</a><a class="docs-footer-nextpage" href="../clue/">CLUE »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 20 March 2024 15:54">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+plot(ce)</code></pre><p><img src="../clap_roar_files/figure-commonmark/cell-3-output-1.svg" alt/></p><h3 id="Comparison-to-GenericGenerator"><a class="docs-heading-anchor" href="#Comparison-to-GenericGenerator">Comparison to <code>GenericGenerator</code></a><a id="Comparison-to-GenericGenerator-1"></a><a class="docs-heading-anchor-permalink" href="#Comparison-to-GenericGenerator" title="Permalink"></a></h3><p>The figure below compares the outcome for the <code>GenericGenerator</code> and the <code>ClaPROARGenerator</code>.</p><p><img src="../clap_roar_files/figure-commonmark/cell-5-output-1.svg" alt/></p><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>Altmeyer, Patrick, Giovan Angela, Aleksander Buszydlik, Karol Dobiczek, Arie van Deursen, and Cynthia Liem. 2023. “Endogenous Macrodynamics in Algorithmic Recourse.” In <em>First IEEE Conference on Secure and Trustworthy Machine Learning</em>.</p><p>Upadhyay, Sohini, Shalmali Joshi, and Himabindu Lakkaraju. 2021. “Towards Robust and Reliable Algorithmic Recourse.” <a href="https://arxiv.org/abs/2102.13620">https://arxiv.org/abs/2102.13620</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../generic/">« Generic</a><a class="docs-footer-nextpage" href="../clue/">CLUE »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 20 March 2024 15:55">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

v0.1.32/explanation/generators/clue/index.html

@@ -6,4 +6,4 @@
 ce = generate_counterfactual(
     x, target, counterfactual_data, M, generator;
     converge_when=:max_iter, max_iter=1000)
-plot(ce)</code></pre><p><img src="../clue_files/figure-commonmark/cell-3-output-1.svg" alt/></p><p>Extra: The CLUE generator can also be used upon already having achieved a counterfactual with a different generator. In this case you can use CLUE and make the counterfactual more robust.</p><p><em>Note: The above documentation is based on the information provided in the CLUE paper. Please refer to the original paper for more detailed explanations and implementation specifics.</em></p><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>Antorán, Javier, Umang Bhatt, Tameem Adel, Adrian Weller, and José Miguel Hernández-Lobato. 2020. “Getting a Clue: A Method for Explaining Uncertainty Estimates.” <a href="https://arxiv.org/abs/2006.06848">https://arxiv.org/abs/2006.06848</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../clap_roar/">« ClaPROAR</a><a class="docs-footer-nextpage" href="../dice/">DiCE »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 20 March 2024 15:54">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+plot(ce)</code></pre><p><img src="../clue_files/figure-commonmark/cell-3-output-1.svg" alt/></p><p>Extra: The CLUE generator can also be used upon already having achieved a counterfactual with a different generator. In this case you can use CLUE and make the counterfactual more robust.</p><p><em>Note: The above documentation is based on the information provided in the CLUE paper. Please refer to the original paper for more detailed explanations and implementation specifics.</em></p><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>Antorán, Javier, Umang Bhatt, Tameem Adel, Adrian Weller, and José Miguel Hernández-Lobato. 2020. “Getting a Clue: A Method for Explaining Uncertainty Estimates.” <a href="https://arxiv.org/abs/2006.06848">https://arxiv.org/abs/2006.06848</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../clap_roar/">« ClaPROAR</a><a class="docs-footer-nextpage" href="../dice/">DiCE »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 20 March 2024 15:55">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

v0.1.32/explanation/generators/dice/index.html

@@ -39,4 +39,4 @@
             num_counterfactuals=n_cf, converge_when=:generator_conditions
       )
     )
-end</code></pre><p>The figure below shows the resulting counterfactual paths. As expected, the resulting counterfactuals are more dispersed across the feature domain for higher choices of <span>$\lambda_2$</span></p><p><img src="../dice_files/figure-commonmark/cell-7-output-1.svg" alt/></p><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>Mothilal, Ramaravind K, Amit Sharma, and Chenhao Tan. 2020. “Explaining Machine Learning Classifiers Through Diverse Counterfactual Explanations.” In <em>Proceedings of the 2020 Conference on Fairness, Accountability, and Transparency</em>, 607–17.</p><p>[1] With thanks to the respondents on <a href="https://discourse.julialang.org/t/getting-around-zygote-mutating-array-issue/83907/2.png">Discourse</a></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../clue/">« CLUE</a><a class="docs-footer-nextpage" href="../feature_tweak/">FeatureTweak »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 20 March 2024 15:54">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><p>The figure below shows the resulting counterfactual paths. As expected, the resulting counterfactuals are more dispersed across the feature domain for higher choices of <span>$\lambda_2$</span></p><p><img src="../dice_files/figure-commonmark/cell-7-output-1.svg" alt/></p><h2 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h2><p>Mothilal, Ramaravind K, Amit Sharma, and Chenhao Tan. 2020. “Explaining Machine Learning Classifiers Through Diverse Counterfactual Explanations.” In <em>Proceedings of the 2020 Conference on Fairness, Accountability, and Transparency</em>, 607–17.</p><p>[1] With thanks to the respondents on <a href="https://discourse.julialang.org/t/getting-around-zygote-mutating-array-issue/83907/2.png">Discourse</a></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../clue/">« CLUE</a><a class="docs-footer-nextpage" href="../feature_tweak/">FeatureTweak »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 20 March 2024 15:55">Wednesday 20 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>