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 <[email protected]>
interpretml · Jun 1, 2022 · 2eb8e54 · 2eb8e54
1 parent 6b5a521
commit 2eb8e54
Show file tree

Hide file tree

Showing 70 changed files with 6,449 additions and 8,919 deletions.
diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
@@ -15,11 +15,8 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9, "3.10"]
+        python-version: [3.7, 3.8, 3.9, "3.10"]
         os: [ubuntu-latest, macos-latest]
-        exclude:
-          - os: macos-latest
-            python-version: 3.6
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }} ${{ matrix.os }}

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,6 +1,9 @@
 include requirements.txt
 include requirements-deeplearning.txt
 include requirements-test.txt
+include requirements-linting.txt
+include environment.yml
+include environment-deeplearning.yml
 include LICENSE
 recursive-include docs *
 recursive-include tests *.py

diff --git a/dice_ml/utils/sample_trained_models/custom.sav b/dice_ml/utils/sample_trained_models/custom.sav
diff --git a/dice_ml/utils/sample_trained_models/custom_binary.sav b/dice_ml/utils/sample_trained_models/custom_binary.sav
diff --git a/dice_ml/utils/sample_trained_models/custom_multiclass.sav b/dice_ml/utils/sample_trained_models/custom_multiclass.sav
diff --git a/dice_ml/utils/sample_trained_models/custom_regression.sav b/dice_ml/utils/sample_trained_models/custom_regression.sav
diff --git a/dice_ml/utils/sample_trained_models/custom_vars.sav b/dice_ml/utils/sample_trained_models/custom_vars.sav
diff --git a/docs/_modules/dice_ml/constants.html b/docs/_modules/dice_ml/constants.html
@@ -1,93 +1,45 @@
-
-
 <!DOCTYPE html>
 <html class="writer-html5" lang="en" >
 <head>
-  <meta charset="utf-8">
-
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-  <title>dice_ml.constants &mdash; DiCE 0.7 documentation</title>
-
-
-
-  <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
-  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
-
-
-
-
-
-
-
+  <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>
+      <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]>
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-
-      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
+        <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/doctools.js"></script>
-        <script src="../../_static/language_data.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 async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
-        <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
-
-    <script type="text/javascript" src="../../_static/js/theme.js"></script>
-
-
+    <script src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" /> 
 </head>
 
-<body class="wy-body-for-nav">
-
-
+<body class="wy-body-for-nav"> 
   <div class="wy-grid-for-nav">
-
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
-
-
-
-            <a href="../../index.html" class="icon icon-home" alt="Documentation Home"> DiCE
-
-
-
+            <a href="../../index.html" class="icon icon-home"> DiCE
           </a>
-
-
-
-
-
-
-
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>
-
-
-        </div>
-
-
-        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
-
-
-
-
-
-
-              <p class="caption"><span class="caption-text">Getting Started:</span></p>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Getting Started:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../readme.html">Diverse Counterfactual Explanations (DiCE) for ML</a></li>
 </ul>
-<p class="caption"><span class="caption-text">Notebooks:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Notebooks:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/DiCE_getting_started.html">Quick introduction to generating counterfactual explanations using DiCE</a></li>
 <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 @@
 <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"><span class="caption-text">Package:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Package:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../dice_ml.html">dice_ml package</a></li>
 </ul>
 
-
-
         </div>
-
       </div>
     </nav>
 
-    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
-
-
-      <nav class="wy-nav-top" aria-label="top navigation">
-
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="../../index.html">DiCE</a>
-
       </nav>
 
-
       <div class="wy-nav-content">
-
         <div class="rst-content">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<div role="navigation" aria-label="breadcrumbs navigation">
-
+          <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-
       <li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
-
           <li><a href="../index.html">Module code</a> &raquo;</li>
-
       <li>dice_ml.constants</li>
-
-
       <li class="wy-breadcrumbs-aside">
-
       </li>
-
   </ul>
-
-
   <hr/>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
-
+             
   <h1>Source code for dice_ml.constants</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Constants for dice-ml package.&quot;&quot;&quot;</span>
 
@@ -197,52 +112,40 @@ <h1>Source code for dice_ml.constants</h1><div class="highlight"><pre>
     <span class="n">CURRENT_VERSION</span> <span class="o">=</span> <span class="n">V2</span>
 
     <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>
+
+
+<span class="k">class</span> <span class="nc">_PostHocSparsityTypes</span><span class="p">:</span>
+    <span class="n">LINEAR</span> <span class="o">=</span> <span class="s1">&#39;linear&#39;</span>
+    <span class="n">BINARY</span> <span class="o">=</span> <span class="s1">&#39;binary&#39;</span>
+
+    <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>
 </pre></div>
 
            </div>
-
           </div>
           <footer>
-
 
   <hr/>
 
   <div role="contentinfo">
-    <p>
-
-        &copy; Copyright 2020, Ramaravind, Amit, Chenhao
-
-    </p>
+    <p>&#169; Copyright 2020, Ramaravind, Amit, Chenhao.</p>
   </div>
-
-
-
-    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
-
-    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
-
-    provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 
-</footer>
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
 
+</footer>
         </div>
       </div>
-
     </section>
-
   </div>
-
-
-  <script type="text/javascript">
+  <script>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
-
-
-
-
-
+  </script> 
 
 </body>
 </html>