Skip to content

Commit

Permalink
Version Bump [Update/v0.9] (#334)
Browse files Browse the repository at this point in the history 
* updated notebook to always use opposite as desired class

* updated version number and docs

* removed nbsphinx allow errors
  • Loading branch information
@amit-sharma
amit-sharma committed Oct 19, 2022
1 parent 7d8db2c commit 06657fd
Show file tree
Hide file tree
Showing 61 changed files with 4,292 additions and 6,365 deletions.
1 change: 1 addition & 0 deletions MANIFEST.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ include requirements-linting.txt
include environment.yml
include environment-deeplearning.yml
include LICENSE
include CODEOWNERS
recursive-include docs *
recursive-include tests *.py
include dice_ml/utils/sample_trained_models/*
9 changes: 6 additions & 3 deletions docs/_modules/dice_ml/constants.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>dice_ml.constants &mdash; DiCE 0.8 documentation</title>
<title>dice_ml.constants &mdash; DiCE 0.9 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,9 @@
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/sphinx_highlight.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
Expand Down Expand Up @@ -46,7 +48,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_multiclass_classification_and_regression.html">Generating counterfactuals for multi-class classification and regression models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_multiclass_classification_and_regression.html#Regression">Regression</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_model_agnostic_CFs.html">Generating counterfactual explanations with any ML model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_with_private_data.html">Generating Counterfactual Explanations without access to training data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_with_private_data.html">Generating counterfactual explanations without access to training data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_with_advanced_options.html">Advanced options to customize Counterfactual Explanations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started_feasible.html">Generate feasible counterfactual explanations using a VAE</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started_feasible.html#Adding-feasibility-constraints">Adding feasibility constraints</a></li>
Expand Down Expand Up @@ -96,7 +98,8 @@ <h1>Source code for dice_ml.constants</h1><div class="highlight"><pre>
<div class="viewcode-block" id="SamplingStrategy"><a class="viewcode-back" href="../../dice_ml.html#dice_ml.constants.SamplingStrategy">[docs]</a><span class="k">class</span> <span class="nc">SamplingStrategy</span><span class="p">:</span>
<span class="n">Random</span> <span class="o">=</span> <span class="s1">&#39;random&#39;</span>
<span class="n">Genetic</span> <span class="o">=</span> <span class="s1">&#39;genetic&#39;</span>
<span class="n">KdTree</span> <span class="o">=</span> <span class="s1">&#39;kdtree&#39;</span></div>
<span class="n">KdTree</span> <span class="o">=</span> <span class="s1">&#39;kdtree&#39;</span>
<span class="n">Gradient</span> <span class="o">=</span> <span class="s1">&#39;gradient&#39;</span></div>


<div class="viewcode-block" id="ModelTypes"><a class="viewcode-back" href="../../dice_ml.html#dice_ml.constants.ModelTypes">[docs]</a><span class="k">class</span> <span class="nc">ModelTypes</span><span class="p">:</span>
Expand Down
10 changes: 6 additions & 4 deletions docs/_modules/dice_ml/counterfactual_explanations.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>dice_ml.counterfactual_explanations &mdash; DiCE 0.8 documentation</title>
<title>dice_ml.counterfactual_explanations &mdash; DiCE 0.9 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,9 @@
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/sphinx_highlight.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
Expand Down Expand Up @@ -46,7 +48,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_multiclass_classification_and_regression.html">Generating counterfactuals for multi-class classification and regression models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_multiclass_classification_and_regression.html#Regression">Regression</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_model_agnostic_CFs.html">Generating counterfactual explanations with any ML model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_with_private_data.html">Generating Counterfactual Explanations without access to training data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_with_private_data.html">Generating counterfactual explanations without access to training data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_with_advanced_options.html">Advanced options to customize Counterfactual Explanations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started_feasible.html">Generate feasible counterfactual explanations using a VAE</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started_feasible.html#Adding-feasibility-constraints">Adding feasibility constraints</a></li>
Expand Down Expand Up @@ -249,7 +251,7 @@ <h1>Source code for dice_ml.counterfactual_explanations</h1><div class="highligh
<span class="n">combined_test_instance_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">serialized_cf_examples</span><span class="p">[</span>
<span class="n">_DiverseCFV2SchemaConstants</span><span class="o">.</span><span class="n">TEST_INSTANCE_LIST</span><span class="p">])</span>
<span class="n">combined_final_cfs_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">serialized_cf_examples</span><span class="p">[</span>
<span class="n">_DiverseCFV2SchemaConstants</span><span class="o">.</span><span class="n">FIANL_CFS_LIST</span><span class="p">])</span>
<span class="n">_DiverseCFV2SchemaConstants</span><span class="o">.</span><span class="n">FINAL_CFS_LIST</span><span class="p">])</span>
<span class="n">data_interface</span> <span class="o">=</span> <span class="n">serialized_cf_examples</span><span class="p">[</span>
<span class="n">_DiverseCFV2SchemaConstants</span><span class="o">.</span><span class="n">DATA_INTERFACE</span><span class="p">]</span>
<span class="n">feature_names</span> <span class="o">=</span> <span class="n">serialized_cf_examples</span><span class="p">[</span>
Expand Down Expand Up @@ -335,7 +337,7 @@ <h1>Source code for dice_ml.counterfactual_explanations</h1><div class="highligh
<span class="c1"># counterfactual example.</span>
<span class="n">cf_examples_str</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span>
<span class="p">{</span>
<span class="n">_DiverseCFV2SchemaConstants</span><span class="o">.</span><span class="n">FIANL_CFS_LIST</span><span class="p">:</span> <span class="n">json_dict</span><span class="p">[</span>
<span class="n">_DiverseCFV2SchemaConstants</span><span class="o">.</span><span class="n">FINAL_CFS_LIST</span><span class="p">:</span> <span class="n">json_dict</span><span class="p">[</span>
<span class="n">_CounterfactualExpV2SchemaConstants</span><span class="o">.</span><span class="n">CFS_LIST</span><span class="p">][</span><span class="n">index</span><span class="p">],</span>
<span class="n">_DiverseCFV2SchemaConstants</span><span class="o">.</span><span class="n">TEST_INSTANCE_LIST</span><span class="p">:</span> <span class="n">json_dict</span><span class="p">[</span>
<span class="n">_CounterfactualExpV2SchemaConstants</span><span class="o">.</span><span class="n">TEST_DATA</span><span class="p">][</span><span class="n">index</span><span class="p">],</span>
Expand Down
6 changes: 4 additions & 2 deletions docs/_modules/dice_ml/data.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>dice_ml.data &mdash; DiCE 0.8 documentation</title>
<title>dice_ml.data &mdash; DiCE 0.9 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
Expand All @@ -13,7 +13,9 @@
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/sphinx_highlight.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
Expand Down Expand Up @@ -46,7 +48,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_multiclass_classification_and_regression.html">Generating counterfactuals for multi-class classification and regression models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_multiclass_classification_and_regression.html#Regression">Regression</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_model_agnostic_CFs.html">Generating counterfactual explanations with any ML model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_with_private_data.html">Generating Counterfactual Explanations without access to training data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_with_private_data.html">Generating counterfactual explanations without access to training data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_with_advanced_options.html">Advanced options to customize Counterfactual Explanations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started_feasible.html">Generate feasible counterfactual explanations using a VAE</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started_feasible.html#Adding-feasibility-constraints">Adding feasibility constraints</a></li>
Expand Down
Loading

0 comments on commit 06657fd

Please sign in to comment.