Skip to content

Commit 6b107f5

Browse files
amit-sharmaamit-sharma
authored
updated docs for version update (#379)
1 parent 8c58e13 commit 6b107f5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+16483
-3096
lines changed

‎docs/_modules/dice_ml/counterfactual_explanations.html‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>dice_ml.counterfactual_explanations &mdash; DiCE 0.9 documentation</title>
6+
<title>dice_ml.counterfactual_explanations &mdash; DiCE 0.10 documentation</title>
77
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
99
<!--[if lt IE 9]>
@@ -50,8 +50,6 @@
5050
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_model_agnostic_CFs.html">Generating counterfactual explanations with any ML model</a></li>
5151
<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>
5252
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_with_advanced_options.html">Advanced options to customize Counterfactual Explanations</a></li>
53-
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started_feasible.html">Generate feasible counterfactual explanations using a VAE</a></li>
54-
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started_feasible.html#Adding-feasibility-constraints">Adding feasibility constraints</a></li>
5553
</ul>
5654
<p class="caption" role="heading"><span class="caption-text">Package:</span></p>
5755
<ul>
@@ -87,11 +85,11 @@ <h1>Source code for dice_ml.counterfactual_explanations</h1><div class="highligh
8785
<span class="kn">import</span> <span class="nn">os</span>
8886

8987
<span class="kn">import</span> <span class="nn">jsonschema</span>
88+
<span class="kn">from</span> <span class="nn">raiutils.exceptions</span> <span class="kn">import</span> <span class="n">UserConfigValidationException</span>
9089

9190
<span class="kn">from</span> <span class="nn">dice_ml.constants</span> <span class="kn">import</span> <span class="n">_SchemaVersions</span>
9291
<span class="kn">from</span> <span class="nn">dice_ml.diverse_counterfactuals</span> <span class="kn">import</span> <span class="p">(</span><span class="n">CounterfactualExamples</span><span class="p">,</span>
9392
<span class="n">_DiverseCFV2SchemaConstants</span><span class="p">)</span>
94-
<span class="kn">from</span> <span class="nn">dice_ml.utils.exception</span> <span class="kn">import</span> <span class="n">UserConfigValidationException</span>
9593

9694

9795
<span class="k">class</span> <span class="nc">_CommonSchemaConstants</span><span class="p">:</span>
@@ -126,7 +124,7 @@ <h1>Source code for dice_ml.counterfactual_explanations</h1><div class="highligh
126124

127125

128126
<div class="viewcode-block" id="CounterfactualExplanations"><a class="viewcode-back" href="../../dice_ml.html#dice_ml.counterfactual_explanations.CounterfactualExplanations">[docs]</a><span class="k">class</span> <span class="nc">CounterfactualExplanations</span><span class="p">:</span>
129-
<span class="sd">&quot;&quot;&quot;A class to store counterfactual examples for one or more inputs</span>
127+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;A class to store counterfactual examples for one or more inputs</span>
130128
<span class="sd"> and feature importance scores.</span>
131129

132130
<span class="sd"> :param cf_examples_list: A list of CounterfactualExamples instances</span>
@@ -199,7 +197,7 @@ <h1>Source code for dice_ml.counterfactual_explanations</h1><div class="highligh
199197
<span class="nd">@staticmethod</span>
200198
<span class="k">def</span> <span class="nf">_check_cf_exp_output_against_json_schema</span><span class="p">(</span>
201199
<span class="n">cf_dict</span><span class="p">,</span> <span class="n">version</span><span class="p">):</span>
202-
<span class="sd">&quot;&quot;&quot;</span>
200+
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
203201
<span class="sd"> Validate the dictionary version of the counterfactual explanations.</span>
204202

205203
<span class="sd"> :param cf_dict: Serialized version of the counterfactual explanations.</span>
@@ -215,7 +213,7 @@ <h1>Source code for dice_ml.counterfactual_explanations</h1><div class="highligh
215213
<span class="n">jsonschema</span><span class="o">.</span><span class="n">validate</span><span class="p">(</span><span class="n">cf_dict</span><span class="p">,</span> <span class="n">schema_json</span><span class="p">)</span>
216214

217215
<div class="viewcode-block" id="CounterfactualExplanations.to_json"><a class="viewcode-back" href="../../dice_ml.html#dice_ml.counterfactual_explanations.CounterfactualExplanations.to_json">[docs]</a> <span class="k">def</span> <span class="nf">to_json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
218-
<span class="sd">&quot;&quot;&quot; Serialize Explanations object to json.</span>
216+
<span class="w"> </span><span class="sd">&quot;&quot;&quot; Serialize Explanations object to json.</span>
219217
<span class="sd"> &quot;&quot;&quot;</span>
220218
<span class="n">serialization_version</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">[</span><span class="s1">&#39;version&#39;</span><span class="p">]</span>
221219
<span class="k">if</span> <span class="n">serialization_version</span> <span class="o">==</span> <span class="n">_SchemaVersions</span><span class="o">.</span><span class="n">V1</span><span class="p">:</span>
@@ -309,7 +307,7 @@ <h1>Source code for dice_ml.counterfactual_explanations</h1><div class="highligh
309307

310308
<div class="viewcode-block" id="CounterfactualExplanations.from_json"><a class="viewcode-back" href="../../dice_ml.html#dice_ml.counterfactual_explanations.CounterfactualExplanations.from_json">[docs]</a> <span class="nd">@staticmethod</span>
311309
<span class="k">def</span> <span class="nf">from_json</span><span class="p">(</span><span class="n">json_str</span><span class="p">):</span>
312-
<span class="sd">&quot;&quot;&quot; Deserialize json string to a CounterfactualExplanations object.</span>
310+
<span class="w"> </span><span class="sd">&quot;&quot;&quot; Deserialize json string to a CounterfactualExplanations object.</span>
313311
<span class="sd"> &quot;&quot;&quot;</span>
314312
<span class="n">json_dict</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">json_str</span><span class="p">)</span>
315313
<span class="k">if</span> <span class="n">_CommonSchemaConstants</span><span class="o">.</span><span class="n">METADATA</span> <span class="ow">in</span> <span class="n">json_dict</span><span class="p">:</span>

0 commit comments

Comments
 (0)