-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Apr 16, 2024
1 parent
10fc676
commit bb1ab58
Showing
204 changed files
with
152,667 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
v1.1.1 | ||
v1.1.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
v1.1.1 | ||
v1.1.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
v1.1.1 | ||
v1.1.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-16T07:49:09","documenter_version":"1.3.0"}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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>Contributing · CounterfactualExplanations.jl</title><meta name="title" content="Contributing · CounterfactualExplanations.jl"/><meta property="og:title" content="Contributing · CounterfactualExplanations.jl"/><meta property="twitter:title" content="Contributing · 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/_contribute/"/><meta property="twitter:url" content="https://juliatrustworthyai.github.io/CounterfactualExplanations.jl/_contribute/"/><link rel="canonical" href="https://juliatrustworthyai.github.io/CounterfactualExplanations.jl/_contribute/"/><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></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></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>Contributing</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Contributing</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/juliatrustworthyai/CounterfactualExplanations.jl/blob/main/docs/src/_contribute.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="Contributing"><a class="docs-heading-anchor" href="#Contributing">Contributing</a><a id="Contributing-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing" title="Permalink"></a></h1><p>Our goal is to provide a go-to place for Counterfactual Explanations in Julia. To this end, the following is a non-exhaustive list of enhancements we have planned:</p><ol><li>Additional counterfactual generators and predictive models.</li><li>Additional datasets for testing, evaluation and benchmarking.</li><li>Support for regression models.</li></ol><p>For a complete list, have a look at outstanding <a href="https://github.com/juliatrustworthyai/CounterfactualExplanations.jl/issues">issue</a>.</p><h2 id="How-to-contribute?"><a class="docs-heading-anchor" href="#How-to-contribute?">How to contribute?</a><a id="How-to-contribute?-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-contribute?" title="Permalink"></a></h2><p>Any sort of contribution is welcome, in particular:</p><ol><li>Should you spot any errors or something is not working, please just open an <a href="https://github.com/juliatrustworthyai/CounterfactualExplanations.jl/issues">issue</a>.</li><li>If you want to contribute your code, please proceed as follows:<ul><li>Fork this repo and clone your fork: <code>git clone https://github.com/your_username/CounterfactualExplanations.jl</code>.</li><li>Implement your modifications and submit a pull request.</li></ul></li><li>For any other questions or comments, you can also start a <a href="https://github.com/juliatrustworthyai/CounterfactualExplanations.jl/discussions">discussion</a>.</li></ol></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.3.0 on <span class="colophon-date" title="Tuesday 16 April 2024 07:49">Tuesday 16 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.