Skip to content

Commit

Permalink
build based on 871d0ae
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Apr 17, 2024
1 parent 5538703 commit 0fadae6
Show file tree
Hide file tree
Showing 57 changed files with 5,206 additions and 1,660 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-16T07:13:22","documenter_version":"1.3.0"}}
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-17T12:49:05","documenter_version":"1.4.0"}}
2 changes: 2 additions & 0 deletions dev/CHANGELOG/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Changelog · CounterfactualExplanations.jl</title><meta name="title" content="Changelog · CounterfactualExplanations.jl"/><meta property="og:title" content="Changelog · CounterfactualExplanations.jl"/><meta property="twitter:title" content="Changelog · CounterfactualExplanations.jl"/><meta name="description" content="Documentation for CounterfactualExplanations.jl."/><meta property="og:description" content="Documentation for CounterfactualExplanations.jl."/><meta property="twitter:description" content="Documentation for CounterfactualExplanations.jl."/><meta property="og:url" content="https://juliatrustworthyai.github.io/CounterfactualExplanations.jl/stable/CHANGELOG/"/><meta property="twitter:url" content="https://juliatrustworthyai.github.io/CounterfactualExplanations.jl/stable/CHANGELOG/"/><link rel="canonical" href="https://juliatrustworthyai.github.io/CounterfactualExplanations.jl/stable/CHANGELOG/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="CounterfactualExplanations.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">CounterfactualExplanations.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">🏠 Home</a></li><li><span class="tocitem">🫣 Tutorials</span><ul><li><a class="tocitem" href="../tutorials/">Overview</a></li><li><a class="tocitem" href="../tutorials/simple_example/">Simple Example</a></li><li><a class="tocitem" href="../tutorials/whistle_stop/">Whiste-Stop Tour</a></li><li><a class="tocitem" href="../tutorials/data_preprocessing/">Handling Data</a></li><li><a class="tocitem" href="../tutorials/data_catalogue/">Data Catalogue</a></li><li><a class="tocitem" href="../tutorials/models/">Handling Models</a></li><li><a class="tocitem" href="../tutorials/model_catalogue/">Model Catalogue</a></li><li><a class="tocitem" href="../tutorials/generators/">Handling Generators</a></li><li><a class="tocitem" href="../tutorials/evaluation/">Evaluating Explanations</a></li><li><a class="tocitem" href="../tutorials/benchmarking/">Benchmarking Explanations</a></li><li><a class="tocitem" href="../tutorials/parallelization/">Parallelization</a></li><li><a class="tocitem" href="../tutorials/convergence/">Convergence</a></li></ul></li><li><span class="tocitem">🤓 Explanation</span><ul><li><a class="tocitem" href="../explanation/">Overview</a></li><li><a class="tocitem" href="../explanation/architecture/">Package Architecture</a></li><li><input class="collapse-toggle" id="menuitem-3-3" type="checkbox"/><label class="tocitem" for="menuitem-3-3"><span class="docs-label">Generators</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../explanation/generators/overview/">Overview</a></li><li><a class="tocitem" href="../explanation/generators/generic/">Generic</a></li><li><a class="tocitem" href="../explanation/generators/clap_roar/">ClaPROAR</a></li><li><a class="tocitem" href="../explanation/generators/clue/">CLUE</a></li><li><a class="tocitem" href="../explanation/generators/dice/">DiCE</a></li><li><a class="tocitem" href="../explanation/generators/feature_tweak/">FeatureTweak</a></li><li><a class="tocitem" href="../explanation/generators/gravitational/">Gravitational</a></li><li><a class="tocitem" href="../explanation/generators/greedy/">Greedy</a></li><li><a class="tocitem" href="../explanation/generators/growing_spheres/">GrowingSpheres</a></li><li><a class="tocitem" href="../explanation/generators/probe/">PROBE</a></li><li><a class="tocitem" href="../explanation/generators/revise/">REVISE</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-3-4" type="checkbox"/><label class="tocitem" for="menuitem-3-4"><span class="docs-label">Optimisers</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../explanation/optimisers/overview/">Overview</a></li><li><a class="tocitem" href="../explanation/optimisers/jsma/">JSMA</a></li></ul></li><li><a class="tocitem" href="../explanation/categorical/">Categorical Features</a></li></ul></li><li><span class="tocitem">🫡 How-To ...</span><ul><li><a class="tocitem" href="../how_to_guides/">Overview</a></li><li><a class="tocitem" href="../how_to_guides/custom_generators/">... add custom generators</a></li><li><a class="tocitem" href="../how_to_guides/custom_models/">... add custom models</a></li></ul></li><li><span class="tocitem">⛓️ Extensions</span><ul><li><a class="tocitem" href="../extensions/">Overview</a></li><li><a class="tocitem" href="../extensions/neurotree/">NeuroTrees</a></li><li><a class="tocitem" href="../extensions/laplace_redux/">LaplaceRedux</a></li></ul></li><li><a class="tocitem" href="../reference/">🧐 Reference</a></li><li><a class="tocitem" href="../contribute/">🛠 Contribute</a></li><li><a class="tocitem" href="../assets/resources/">📚 Additional Resources</a></li><li><a class="tocitem" href="../release-notes/">Release Notes</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Changelog</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Changelog</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/juliatrustworthyai/CounterfactualExplanations.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/juliatrustworthyai/CounterfactualExplanations.jl/blob/main/docs/src/CHANGELOG.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Changelog"><a class="docs-heading-anchor" href="#Changelog">Changelog</a><a id="Changelog-1"></a><a class="docs-heading-anchor-permalink" href="#Changelog" title="Permalink"></a></h1><p>All notable changes to this project will be documented in this file.</p><p>The format is based on <a href="https://keepachangelog.com/en/1.1.0/">Keep a Changelog</a>, and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p><p><em>Note</em>: We try to adhere to these practices as of version <code>1.1.1</code>.</p><h2 id="[Unreleased]"><a class="docs-heading-anchor" href="#[Unreleased]">[Unreleased]</a><a id="[Unreleased]-1"></a><a class="docs-heading-anchor-permalink" href="#[Unreleased]" title="Permalink"></a></h2><h3 id="Added"><a class="docs-heading-anchor" href="#Added">Added</a><a id="Added-1"></a><a class="docs-heading-anchor-permalink" href="#Added" title="Permalink"></a></h3><ul><li>Adds a section on <code>Convergence</code> to the documentation, <code>Changelog.jl</code> functionality and a few doc tests. [#429]</li></ul><h2 id="[1.1.2]-2024-04-16"><a class="docs-heading-anchor" href="#[1.1.2]-2024-04-16">[1.1.2] - 2024-04-16</a><a id="[1.1.2]-2024-04-16-1"></a><a class="docs-heading-anchor-permalink" href="#[1.1.2]-2024-04-16" title="Permalink"></a></h2><h3 id="Changed"><a class="docs-heading-anchor" href="#Changed">Changed</a><a id="Changed-1"></a><a class="docs-heading-anchor-permalink" href="#Changed" title="Permalink"></a></h3><ul><li>Replaces the GIF in the README and introduction of docs for a static image. </li></ul><h2 id="[1.1.1]-2024-04-15"><a class="docs-heading-anchor" href="#[1.1.1]-2024-04-15">[1.1.1] - 2024-04-15</a><a id="[1.1.1]-2024-04-15-1"></a><a class="docs-heading-anchor-permalink" href="#[1.1.1]-2024-04-15" title="Permalink"></a></h2><h3 id="Added-2"><a class="docs-heading-anchor" href="#Added-2">Added</a><a class="docs-heading-anchor-permalink" href="#Added-2" title="Permalink"></a></h3><ul><li>Added tests for LaplaceRedux extension. Bumped upper compat bound for LaplaceRedux.jl. [#428]</li></ul><p>&lt;!– Links generated by Changelog.jl –&gt;</p><p>[#428]: https://github.com/juliatrustworthyai/CounterfactualExplanations.jl/issues/428 [#429]: https://github.com/juliatrustworthyai/CounterfactualExplanations.jl/issues/429</p></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="auto">Automatic (OS)</option><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 1.4.0 on <span class="colophon-date" title="Wednesday 17 April 2024 12:49">Wednesday 17 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
21 changes: 21 additions & 0 deletions dev/LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Patrick Altmeyer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit 0fadae6

Please sign in to comment.