|
3 | 3 | <head> |
4 | 4 | <meta charset="utf-8" /> |
5 | 5 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
6 | | - <title>dice_ml.data — DiCE 0.9 documentation</title> |
| 6 | + <title>dice_ml.data — DiCE 0.11 documentation</title> |
7 | 7 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
8 | 8 | <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
9 | 9 | <!--[if lt IE 9]> |
|
50 | 50 | <li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_model_agnostic_CFs.html">Generating counterfactual explanations with any ML model</a></li> |
51 | 51 | <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> |
52 | 52 | <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> |
55 | 53 | </ul> |
56 | 54 | <p class="caption" role="heading"><span class="caption-text">Package:</span></p> |
57 | 55 | <ul> |
@@ -95,23 +93,23 @@ <h1>Source code for dice_ml.data</h1><div class="highlight"><pre> |
95 | 93 |
|
96 | 94 |
|
97 | 95 | <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> |
98 | | - <span class="sd">"""Class containing all required information about the data for DiCE."""</span> |
| 96 | +<span class="w"> </span><span class="sd">"""Class containing all required information about the data for DiCE."""</span> |
99 | 97 |
|
100 | 98 | <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> |
101 | | - <span class="sd">"""Init method</span> |
| 99 | +<span class="w"> </span><span class="sd">"""Init method</span> |
102 | 100 |
|
103 | 101 | <span class="sd"> :param **params: a dictionary of required parameters.</span> |
104 | 102 | <span class="sd"> """</span> |
105 | 103 | <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> |
106 | 104 |
|
107 | 105 | <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> |
108 | | - <span class="sd">"""Decides if the Data class is for public or private data."""</span> |
| 106 | +<span class="w"> </span><span class="sd">"""Decides if the Data class is for public or private data."""</span> |
109 | 107 | <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> |
110 | 108 | <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> |
111 | 109 |
|
112 | 110 |
|
113 | 111 | <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> |
114 | | - <span class="sd">"""Decides if the Data class is for public or private data.</span> |
| 112 | +<span class="w"> </span><span class="sd">"""Decides if the Data class is for public or private data.</span> |
115 | 113 |
|
116 | 114 | <span class="sd"> To add new implementations of Data, add the class in data_interfaces</span> |
117 | 115 | <span class="sd"> subpackage and import-and-return the class in an elif loop as shown</span> |
|
0 commit comments