Skip to content

Commit

Permalink
Version Bump: Update to v0.11 (#413)
Browse files Browse the repository at this point in the history

* version bump: updated docs

Signed-off-by: Amit Sharma <amit_sharma@live.com>

---------

Signed-off-by: Amit Sharma <amit_sharma@live.com>
  • Loading branch information
amit-sharma committed Oct 26, 2023
1 parent b12abb4 commit 39dd297
Show file tree
Hide file tree
Showing 53 changed files with 1,177 additions and 1,131 deletions.
4 changes: 1 addition & 3 deletions docs/_modules/dice_ml/constants.html
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.9 documentation</title>
<title>dice_ml.constants &mdash; DiCE 0.11 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 Down Expand Up @@ -50,8 +50,6 @@
<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_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>
</ul>
<p class="caption" role="heading"><span class="caption-text">Package:</span></p>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/dice_ml/counterfactual_explanations.html
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.10 documentation</title>
<title>dice_ml.counterfactual_explanations &mdash; DiCE 0.11 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 Down
12 changes: 5 additions & 7 deletions docs/_modules/dice_ml/data.html
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.9 documentation</title>
<title>dice_ml.data &mdash; DiCE 0.11 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 Down Expand Up @@ -50,8 +50,6 @@
<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_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>
</ul>
<p class="caption" role="heading"><span class="caption-text">Package:</span></p>
<ul>
Expand Down Expand Up @@ -95,23 +93,23 @@ <h1>Source code for dice_ml.data</h1><div class="highlight"><pre>


<div class="viewcode-block" id="Data"><a class="viewcode-back" href="../../dice_ml.html#dice_ml.data.Data">[docs]</a><span class="k">class</span> <span class="nc">Data</span><span class="p">(</span><span class="n">_BaseData</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Class containing all required information about the data for DiCE.&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Class containing all required information about the data for DiCE.&quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">params</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Init method</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Init method</span>

<span class="sd"> :param **params: a dictionary of required parameters.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">decide_implementation_type</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>

<div class="viewcode-block" id="Data.decide_implementation_type"><a class="viewcode-back" href="../../dice_ml.html#dice_ml.data.Data.decide_implementation_type">[docs]</a> <span class="k">def</span> <span class="nf">decide_implementation_type</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Decides if the Data class is for public or private data.&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Decides if the Data class is for public or private data.&quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span> <span class="o">=</span> <span class="n">decide</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">params</span><span class="p">)</span></div></div>


<div class="viewcode-block" id="decide"><a class="viewcode-back" href="../../dice_ml.html#dice_ml.data.decide">[docs]</a><span class="k">def</span> <span class="nf">decide</span><span class="p">(</span><span class="n">params</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Decides if the Data class is for public or private data.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Decides if the Data class is for public or private data.</span>

<span class="sd"> To add new implementations of Data, add the class in data_interfaces</span>
<span class="sd"> subpackage and import-and-return the class in an elif loop as shown</span>
Expand Down

0 comments on commit 39dd297

Please sign in to comment.