change name to shapkit and update docs for MC & Shapley values methods

Author: simon.grah

Makefile

@@ -1,10 +1,10 @@
 SRC = $(wildcard nbs/*.ipynb)
 
-all: shapkit_nbdev docs
+all: shapkit docs
 
-shapkit_nbdev: $(SRC)
+shapkit: $(SRC)
 	nbdev_build_lib
-	touch shapkit_nbdev
+	touch shapkit
 
 docs_serve: docs
 	cd docs && bundle exec jekyll serve

README.md

@@ -52,15 +52,15 @@ x = X.iloc[idx_x,:]
 ```
 
 ```python
-from shapkit_nbdev.shapley_values import ShapleyValues
-from shapkit_nbdev.monte_carlo_shapley import MonteCarloShapley
-from shapkit_nbdev.sgd_shapley import SGDshapley
+from shapkit.shapley_values import ShapleyValues
+from shapkit.monte_carlo_shapley import MonteCarloShapley
+from shapkit.sgd_shapley import SGDshapley
 ```
 
 #### Shapley Values
 
 ```python
-true_shap = ShapleyValues(x=x, fc=fc, r=r)
+true_shap = ShapleyValues(x=x, fc=fc, ref=r)
 ```
 
     100%|██████████| 5/5 [00:00<00:00, 296.03it/s]
@@ -85,7 +85,7 @@ true_shap
 #### Monte Carlo
 
 ```python
-mc_shap = MonteCarloShapley(x=x, fc=fc, r=r, n_iter=100, callback=None)
+mc_shap = MonteCarloShapley(x=x, fc=fc, ref=r, n_iter=100, callback=None)
 ```
 
     100%|██████████| 100/100 [00:00<00:00, 5709.10it/s]

ToDoList.txt

@@ -0,0 +1,4 @@
+ToDoList:
+* Index (README) à updater: description haut niveau de la lib, illustration plot, références, définition du reward, utilisations des functions, paragraphe sur nbdev.
+* Update de SGD Shap
+* Amélioration des tutorials

docs/_config.yml

@@ -1,7 +1,7 @@
-repository: simon.grah/shapkit_nbdev
+repository: simon.grah/shapkit
 output: web
-topnav_title: shapkit_nbdev
-site_title: shapkit_nbdev
+topnav_title: shapkit
+site_title: shapkit
 company_name: THALES
 description: A description of your project
 # Set to false to disable KaTeX math
@@ -61,4 +61,4 @@ sidebars:
 permalink: pretty
 
 theme: jekyll-theme-cayman
-baseurl: /shapkit_nbdev/
+baseurl: /shapkit/

docs/_data/sidebars/home_sidebar.yml

@@ -11,7 +11,7 @@ entries:
       url: /
     - output: web,pdf
       title: Title
-      url: /inspector
+      url: /plots
     - output: web,pdf
       title: Monte Carlo Shapley
       url: /monte_carlo_shapley
@@ -22,6 +22,6 @@ entries:
       title: Shapley Value
       url: /shapley_values
     output: web
-    title: shapkit_nbdev
+    title: shapkit
   output: web
   title: Sidebar

docs/index.html

@@ -148,9 +148,9 @@ <h3 id="Regression-example">Regression example<a class="anchor-link" href="#Regr
 
 <div class="inner_cell">
     <div class="input_area">
-<div class=" highlight hl-ipython3"><pre><span></span><span class="kn">from</span> <span class="nn">shapkit_nbdev.shapley_values</span> <span class="k">import</span> <span class="n">ShapleyValues</span>
-<span class="kn">from</span> <span class="nn">shapkit_nbdev.monte_carlo_shapley</span> <span class="k">import</span> <span class="n">MonteCarloShapley</span>
-<span class="kn">from</span> <span class="nn">shapkit_nbdev.sgd_shapley</span> <span class="k">import</span> <span class="n">SGDshapley</span>
+<div class=" highlight hl-ipython3"><pre><span></span><span class="kn">from</span> <span class="nn">shapkit.shapley_values</span> <span class="k">import</span> <span class="n">ShapleyValues</span>
+<span class="kn">from</span> <span class="nn">shapkit.monte_carlo_shapley</span> <span class="k">import</span> <span class="n">MonteCarloShapley</span>
+<span class="kn">from</span> <span class="nn">shapkit.sgd_shapley</span> <span class="k">import</span> <span class="n">SGDshapley</span>
 </pre></div>
 
     </div>
@@ -173,7 +173,7 @@ <h4 id="Shapley-Values">Shapley Values<a class="anchor-link" href="#Shapley-Valu
 
 <div class="inner_cell">
     <div class="input_area">
-<div class=" highlight hl-ipython3"><pre><span></span><span class="n">true_shap</span> <span class="o">=</span> <span class="n">ShapleyValues</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">fc</span><span class="o">=</span><span class="n">fc</span><span class="p">,</span> <span class="n">r</span><span class="o">=</span><span class="n">r</span><span class="p">)</span>
+<div class=" highlight hl-ipython3"><pre><span></span><span class="n">true_shap</span> <span class="o">=</span> <span class="n">ShapleyValues</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">fc</span><span class="o">=</span><span class="n">fc</span><span class="p">,</span> <span class="n">ref</span><span class="o">=</span><span class="n">r</span><span class="p">)</span>
 </pre></div>
 
     </div>
@@ -248,7 +248,7 @@ <h4 id="Monte-Carlo">Monte Carlo<a class="anchor-link" href="#Monte-Carlo"> </a>
 
 <div class="inner_cell">
     <div class="input_area">
-<div class=" highlight hl-ipython3"><pre><span></span><span class="n">mc_shap</span> <span class="o">=</span> <span class="n">MonteCarloShapley</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">fc</span><span class="o">=</span><span class="n">fc</span><span class="p">,</span> <span class="n">r</span><span class="o">=</span><span class="n">r</span><span class="p">,</span> <span class="n">n_iter</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">callback</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
+<div class=" highlight hl-ipython3"><pre><span></span><span class="n">mc_shap</span> <span class="o">=</span> <span class="n">MonteCarloShapley</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">fc</span><span class="o">=</span><span class="n">fc</span><span class="p">,</span> <span class="n">ref</span><span class="o">=</span><span class="n">r</span><span class="p">,</span> <span class="n">n_iter</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">callback</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
 </pre></div>
 
     </div>

docs/inspector.html

@@ -58,7 +58,7 @@ <h1 id="Callback-for-monitoring-estimation-errors">Callback for monitoring estim
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="inspector" class="doc_header"><code>inspector</code><a href="https://github.com/simon.grah/shapkit_nbdev/tree/master/shapkit_nbdev/inspector.py#L9" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>inspector</code>(<strong><code>x_min</code></strong>, <strong><code>precision</code></strong>=<em><code>0</code></em>, <strong><code>verbose</code></strong>=<em><code>False</code></em>)</p>
+<h4 id="inspector" class="doc_header"><code>inspector</code><a href="https://github.com/simon.grah/shapkit/tree/master/shapkit/inspector.py#L9" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>inspector</code>(<strong><code>x_min</code></strong>, <strong><code>precision</code></strong>=<em><code>0</code></em>, <strong><code>verbose</code></strong>=<em><code>False</code></em>)</p>
 </blockquote>
 <p>A closure called to update metrics after each iteration.</p>