Skip to content

Commit 2eb8e54

Browse files
amit-sharmaamit-sharma
authored
Version Bump [0.8]: Updated version and docs (#301)
* updated version and docs * updated models using _save template models to be compatible with sklearn 1.1 * added environment yml files to manifest * removed test for 3.6 Signed-off-by: Amit Sharma <amit_sharma@live.com>
1 parent 6b5a521 commit 2eb8e54

70 files changed

Lines changed: 6449 additions & 8919 deletions

File tree

Some content is hidden

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

‎.github/workflows/pythonpackage.yml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,8 @@ jobs:
1515
runs-on: ${{ matrix.os }}
1616
strategy:
1717
matrix:
18-
python-version: [3.6, 3.7, 3.8, 3.9, "3.10"]
18+
python-version: [3.7, 3.8, 3.9, "3.10"]
1919
os: [ubuntu-latest, macos-latest]
20-
exclude:
21-
- os: macos-latest
22-
python-version: 3.6
2320
steps:
2421
- uses: actions/checkout@v3
2522
- name: Set up Python ${{ matrix.python-version }} ${{ matrix.os }}

‎MANIFEST.in‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
include requirements.txt
22
include requirements-deeplearning.txt
33
include requirements-test.txt
4+
include requirements-linting.txt
5+
include environment.yml
6+
include environment-deeplearning.yml
47
include LICENSE
58
recursive-include docs *
69
recursive-include tests *.py

‎dice_ml/utils/sample_trained_models/custom.sav‎

-9.44 KB
Binary file not shown.

‎dice_ml/utils/sample_trained_models/custom_binary.sav‎

-5.61 KB
Binary file not shown.

‎dice_ml/utils/sample_trained_models/custom_multiclass.sav‎

-4.08 KB
Binary file not shown.

‎dice_ml/utils/sample_trained_models/custom_regression.sav‎

3.76 KB
Binary file not shown.

‎dice_ml/utils/sample_trained_models/custom_vars.sav‎

4.29 KB
Binary file not shown.

‎docs/_modules/dice_ml/constants.html‎

Lines changed: 31 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,45 @@
1-
2-
31
<!DOCTYPE html>
42
<html class="writer-html5" lang="en" >
53
<head>
6-
<meta charset="utf-8">
7-
8-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
9-
10-
<title>dice_ml.constants &mdash; DiCE 0.7 documentation</title>
11-
12-
13-
14-
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
15-
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
16-
17-
18-
19-
20-
21-
22-
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>dice_ml.constants &mdash; DiCE 0.8 documentation</title>
7+
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
8+
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
239
<!--[if lt IE 9]>
2410
<script src="../../_static/js/html5shiv.min.js"></script>
2511
<![endif]-->
2612

27-
28-
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
13+
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
2914
<script src="../../_static/jquery.js"></script>
3015
<script src="../../_static/underscore.js"></script>
3116
<script src="../../_static/doctools.js"></script>
32-
<script src="../../_static/language_data.js"></script>
3317
<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>
34-
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
35-
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
36-
37-
<script type="text/javascript" src="../../_static/js/theme.js"></script>
38-
39-
18+
<script src="../../_static/js/theme.js"></script>
4019
<link rel="index" title="Index" href="../../genindex.html" />
4120
<link rel="search" title="Search" href="../../search.html" />
4221
</head>
4322

44-
<body class="wy-body-for-nav">
45-
46-
23+
<body class="wy-body-for-nav">
4724
<div class="wy-grid-for-nav">
48-
4925
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
5026
<div class="wy-side-scroll">
5127
<div class="wy-side-nav-search" >
52-
53-
54-
55-
<a href="../../index.html" class="icon icon-home" alt="Documentation Home"> DiCE
56-
57-
58-
28+
<a href="../../index.html" class="icon icon-home"> DiCE
5929
</a>
60-
61-
62-
63-
64-
65-
66-
6730
<div role="search">
6831
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
6932
<input type="text" name="q" placeholder="Search docs" />
7033
<input type="hidden" name="check_keywords" value="yes" />
7134
<input type="hidden" name="area" value="default" />
7235
</form>
7336
</div>
74-
75-
76-
</div>
77-
78-
79-
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
80-
81-
82-
83-
84-
85-
86-
<p class="caption"><span class="caption-text">Getting Started:</span></p>
37+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
38+
<p class="caption" role="heading"><span class="caption-text">Getting Started:</span></p>
8739
<ul>
8840
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Diverse Counterfactual Explanations (DiCE) for ML</a></li>
8941
</ul>
90-
<p class="caption"><span class="caption-text">Notebooks:</span></p>
42+
<p class="caption" role="heading"><span class="caption-text">Notebooks:</span></p>
9143
<ul>
9244
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started.html">Quick introduction to generating counterfactual explanations using DiCE</a></li>
9345
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_feature_importances.html">Estimating local and global feature importance scores using DiCE</a></li>
@@ -99,72 +51,35 @@
9951
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started_feasible.html">Generate feasible counterfactual explanations using a VAE</a></li>
10052
<li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started_feasible.html#Adding-feasibility-constraints">Adding feasibility constraints</a></li>
10153
</ul>
102-
<p class="caption"><span class="caption-text">Package:</span></p>
54+
<p class="caption" role="heading"><span class="caption-text">Package:</span></p>
10355
<ul>
10456
<li class="toctree-l1"><a class="reference internal" href="../../dice_ml.html">dice_ml package</a></li>
10557
</ul>
10658

107-
108-
10959
</div>
110-
11160
</div>
11261
</nav>
11362

114-
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
115-
116-
117-
<nav class="wy-nav-top" aria-label="top navigation">
118-
63+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
11964
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
12065
<a href="../../index.html">DiCE</a>
121-
12266
</nav>
12367

124-
12568
<div class="wy-nav-content">
126-
12769
<div class="rst-content">
128-
129-
130-
131-
132-
133-
134-
135-
136-
137-
138-
139-
140-
141-
142-
143-
144-
145-
<div role="navigation" aria-label="breadcrumbs navigation">
146-
70+
<div role="navigation" aria-label="Page navigation">
14771
<ul class="wy-breadcrumbs">
148-
14972
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
150-
15173
<li><a href="../index.html">Module code</a> &raquo;</li>
152-
15374
<li>dice_ml.constants</li>
154-
155-
15675
<li class="wy-breadcrumbs-aside">
157-
15876
</li>
159-
16077
</ul>
161-
162-
16378
<hr/>
16479
</div>
16580
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
16681
<div itemprop="articleBody">
167-
82+
16883
<h1>Source code for dice_ml.constants</h1><div class="highlight"><pre>
16984
<span></span><span class="sd">&quot;&quot;&quot;Constants for dice-ml package.&quot;&quot;&quot;</span>
17085

@@ -197,52 +112,40 @@ <h1>Source code for dice_ml.constants</h1><div class="highlight"><pre>
197112
<span class="n">CURRENT_VERSION</span> <span class="o">=</span> <span class="n">V2</span>
198113

199114
<span class="n">ALL_VERSIONS</span> <span class="o">=</span> <span class="p">[</span><span class="n">V1</span><span class="p">,</span> <span class="n">V2</span><span class="p">]</span>
115+
116+
117+
<span class="k">class</span> <span class="nc">_PostHocSparsityTypes</span><span class="p">:</span>
118+
<span class="n">LINEAR</span> <span class="o">=</span> <span class="s1">&#39;linear&#39;</span>
119+
<span class="n">BINARY</span> <span class="o">=</span> <span class="s1">&#39;binary&#39;</span>
120+
121+
<span class="n">ALL</span> <span class="o">=</span> <span class="p">[</span><span class="n">LINEAR</span><span class="p">,</span> <span class="n">BINARY</span><span class="p">]</span>
200122
</pre></div>
201123

202124
</div>
203-
204125
</div>
205126
<footer>
206-
207127

208128
<hr/>
209129

210130
<div role="contentinfo">
211-
<p>
212-
213-
&copy; Copyright 2020, Ramaravind, Amit, Chenhao
214-
215-
</p>
131+
<p>&#169; Copyright 2020, Ramaravind, Amit, Chenhao.</p>
216132
</div>
217-
218-
219-
220-
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
221-
222-
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
223-
224-
provided by <a href="https://readthedocs.org">Read the Docs</a>.
225133

226-
</footer>
134+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
135+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
136+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
137+
227138

139+
</footer>
228140
</div>
229141
</div>
230-
231142
</section>
232-
233143
</div>
234-
235-
236-
<script type="text/javascript">
144+
<script>
237145
jQuery(function () {
238146
SphinxRtdTheme.Navigation.enable(true);
239147
});
240-
</script>
241-
242-
243-
244-
245-
148+
</script>
246149

247150
</body>
248151
</html>

0 commit comments

Comments
 (0)