Skip to content

Commit 2ad3eaa

Browse files
committed
update
1 parent b13ac52 commit 2ad3eaa

File tree

6 files changed

+10
-20
lines changed

6 files changed

+10
-20
lines changed

docs/_build/html/_sources/guides/explain/lime.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The LIME explanation is also integrated into the `model_explain` function of PiM
4242
:target: ../../auto_examples/explain/plot_4_lime.html
4343
:align: left
4444

45-
This plot is similar to the local interpretation of `GLM`_, as we use Lasso as the surrogate model. It shows the linear regression coefficients and marginal effects of the top-10 features (with feature values on the right axis) that contribute to the prediction of bike counts. The `Weight` represents the regression coefficients, and `Effect` represents the marginal effects. From top to bottom, `hr` contributes the most to the prediction of bike counts, followed by `atemp`, then `hum`, and so on. Note that this plot only shows the top 10 features with the largest contributions. To get the full results, you can set the parameter `return_data` to True.
45+
This plot is similar to the local interpretation of `GLM`_, as we use Lasso as the surrogate model. The stems represent the coefficients and the bars show the effect. It shows the linear regression coefficients and marginal effects of the top-10 features (with feature values on the right axis) that contribute to the prediction of bike counts. The `Weight` represents the regression coefficients, and `Effect` represents the marginal effects. From top to bottom, `hr` contributes the most to the prediction of bike counts, followed by `atemp`, then `hum`, and so on. Note that this plot only shows the top 10 features with the largest contributions. To get the full results, you can set the parameter `return_data` to True.
4646

4747
.. _GLM: glm.html#local-interpretation
4848

docs/_build/html/_sources/guides/models/glm.rst.txt

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -148,13 +148,9 @@ Local interpretation refers to the local contribution of each feature for a part
148148
:target: ../../auto_examples/models/plot_0_glm_reg.html
149149
:align: left
150150

151-
In this plot,
151+
In this plot, the bars show the marginal contribution (effects) of each feature. The longer the bar, the larger the marginal effect, and the more contribution the corresponding feature has on the prediction. In contrast, the regression coefficients (weights) indicate the strength and direction of the relationship between each feature and the target variable. The larger the coefficient, the more sensitive the corresponding feature' contribution to the prediction.
152152

153-
- The bars marked as `Weight` represent the regression coefficients, which indicate the strength and direction of the relationship between each feature and the target variable. The longer the bar, the larger the coefficient, and the more sensitive the corresponding feature' contribution to the prediction.
154-
155-
- The stems marked as `Effect` represent the marginal effects. The longer the stem, the larger the marginal effect, and the more contribution the corresponding feature has on the prediction.
156-
157-
The `sample_id=0` indicates that the plot is showing the coefficients and marginal effects for the first sample in the training set, and the feature values for this sample are shown on the right axis. Note that this plot only shows the top 10 features with the largest contributions. To get the full results, you can set the parameter `return_data` to True.
153+
The `sample_id=0` indicates that the plot is showing the marginal effects for the first sample in the training set, and the feature values for this sample are shown on the right axis. Note that this plot only shows the top 10 features with the largest contributions. To get the full results, you can set the parameter `return_data` to True.
158154

159155
Original Scale Option
160156
""""""""""""""""""""""""""

docs/_build/html/_sources/guides/models/reludnn.rst.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,7 @@ Local Interpretation
197197
Local Feature Contribution plot
198198
""""""""""""""""""""""""""""""""
199199

200-
The local feature importance plot (with the keyword "local_fi") shows the prediction decomposition of a single training sample.
201-
This plot is similar to that of GLM, see the local interpretation of `GLM`_.
200+
The local feature importance plot (with the keyword "local_fi") shows the prediction decomposition of a single training sample.
202201

203202
.. _GLM: glm.html#local-interpretation
204203

@@ -210,7 +209,7 @@ This plot is similar to that of GLM, see the local interpretation of `GLM`_.
210209
:target: ../../auto_examples/models/plot_plot_8_reludnn_cls.html
211210
:align: left
212211

213-
The definition of `Weight` and `Effect` can be found in the introduction for GLM. Similarly, we provide the `centered` option, as shown below.
212+
The definition of `Weight` and `Effect` can be found in the introduction for GLM. The stems represent the coefficients and the bars show the effect. Similarly, we provide the `centered` option, as shown below.
214213

215214
.. jupyter-input::
216215

docs/_build/html/guides/explain/lime.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ <h2><span class="section-number">4.2.1.2. </span>Usage<a class="headerlink" href
247247
<figure class="align-left">
248248
<a class="reference external image-reference" href="../../auto_examples/explain/plot_4_lime.html"><img alt="../../_images/sphx_glr_plot_4_lime_001.png" src="../../_images/sphx_glr_plot_4_lime_001.png" /></a>
249249
</figure>
250-
<p>This plot is similar to the local interpretation of <a class="reference external" href="glm.html#local-interpretation">GLM</a>, as we use Lasso as the surrogate model. It shows the linear regression coefficients and marginal effects of the top-10 features (with feature values on the right axis) that contribute to the prediction of bike counts. The <code class="docutils literal notranslate"><span class="pre">Weight</span></code> represents the regression coefficients, and <code class="docutils literal notranslate"><span class="pre">Effect</span></code> represents the marginal effects. From top to bottom, <code class="docutils literal notranslate"><span class="pre">hr</span></code> contributes the most to the prediction of bike counts, followed by <code class="docutils literal notranslate"><span class="pre">atemp</span></code>, then <code class="docutils literal notranslate"><span class="pre">hum</span></code>, and so on. Note that this plot only shows the top 10 features with the largest contributions. To get the full results, you can set the parameter <code class="docutils literal notranslate"><span class="pre">return_data</span></code> to True.</p>
250+
<p>This plot is similar to the local interpretation of <a class="reference external" href="glm.html#local-interpretation">GLM</a>, as we use Lasso as the surrogate model. The stems represent the coefficients and the bars show the effect. It shows the linear regression coefficients and marginal effects of the top-10 features (with feature values on the right axis) that contribute to the prediction of bike counts. The <code class="docutils literal notranslate"><span class="pre">Weight</span></code> represents the regression coefficients, and <code class="docutils literal notranslate"><span class="pre">Effect</span></code> represents the marginal effects. From top to bottom, <code class="docutils literal notranslate"><span class="pre">hr</span></code> contributes the most to the prediction of bike counts, followed by <code class="docutils literal notranslate"><span class="pre">atemp</span></code>, then <code class="docutils literal notranslate"><span class="pre">hum</span></code>, and so on. Note that this plot only shows the top 10 features with the largest contributions. To get the full results, you can set the parameter <code class="docutils literal notranslate"><span class="pre">return_data</span></code> to True.</p>
251251
<p><strong>Centered predictors</strong></p>
252252
<p>Centering is crucial when group effects are of interest and can be done by subtracting the mean attribute from each attribute element.</p>
253253
<div class="jupyter_cell jupyter_container docutils container">

docs/_build/html/guides/models/glm.html

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -390,12 +390,8 @@ <h2><span class="section-number">5.1.3. </span>Local Interpretation<a class="hea
390390
<figure class="align-left">
391391
<a class="reference external image-reference" href="../../auto_examples/models/plot_0_glm_reg.html"><img alt="../../_images/sphx_glr_plot_0_glm_reg_004.png" src="../../_images/sphx_glr_plot_0_glm_reg_004.png" /></a>
392392
</figure>
393-
<p>In this plot,</p>
394-
<ul class="simple">
395-
<li><p>The bars marked as <code class="docutils literal notranslate"><span class="pre">Weight</span></code> represent the regression coefficients, which indicate the strength and direction of the relationship between each feature and the target variable. The longer the bar, the larger the coefficient, and the more sensitive the corresponding feature’ contribution to the prediction.</p></li>
396-
<li><p>The stems marked as <code class="docutils literal notranslate"><span class="pre">Effect</span></code> represent the marginal effects. The longer the stem, the larger the marginal effect, and the more contribution the corresponding feature has on the prediction.</p></li>
397-
</ul>
398-
<p>The <code class="docutils literal notranslate"><span class="pre">sample_id=0</span></code> indicates that the plot is showing the coefficients and marginal effects for the first sample in the training set, and the feature values for this sample are shown on the right axis. Note that this plot only shows the top 10 features with the largest contributions. To get the full results, you can set the parameter <code class="docutils literal notranslate"><span class="pre">return_data</span></code> to True.</p>
393+
<p>In this plot, the bars show the marginal contribution (effects) of each feature. The longer the bar, the larger the marginal effect, and the more contribution the corresponding feature has on the prediction. In contrast, the regression coefficients (weights) indicate the strength and direction of the relationship between each feature and the target variable. The larger the coefficient, the more sensitive the corresponding feature’ contribution to the prediction.</p>
394+
<p>The <code class="docutils literal notranslate"><span class="pre">sample_id=0</span></code> indicates that the plot is showing the marginal effects for the first sample in the training set, and the feature values for this sample are shown on the right axis. Note that this plot only shows the top 10 features with the largest contributions. To get the full results, you can set the parameter <code class="docutils literal notranslate"><span class="pre">return_data</span></code> to True.</p>
399395
<section id="original-scale-option">
400396
<h3><span class="section-number">5.1.3.1. </span>Original Scale Option<a class="headerlink" href="#original-scale-option" title="Permalink to this heading"></a></h3>
401397
<p>The right axis of the local interpretation plot shows the scaled feature values. If you want to know the original feature values before the preprocessing, set <code class="docutils literal notranslate"><span class="pre">original_scale=True</span></code>.</p>

docs/_build/html/guides/models/reludnn.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -437,8 +437,7 @@ <h3><span class="section-number">5.9.4.6. </span>LLM pairwise plot<a class="head
437437
<h2><span class="section-number">5.9.5. </span>Local Interpretation<a class="headerlink" href="#local-interpretation" title="Permalink to this heading"></a></h2>
438438
<section id="local-feature-contribution-plot">
439439
<h3><span class="section-number">5.9.5.1. </span>Local Feature Contribution plot<a class="headerlink" href="#local-feature-contribution-plot" title="Permalink to this heading"></a></h3>
440-
<p>The local feature importance plot (with the keyword “local_fi”) shows the prediction decomposition of a single training sample.
441-
This plot is similar to that of GLM, see the local interpretation of <a class="reference external" href="glm.html#local-interpretation">GLM</a>.</p>
440+
<p>The local feature importance plot (with the keyword “local_fi”) shows the prediction decomposition of a single training sample.</p>
442441
<div class="jupyter_cell jupyter_container docutils container">
443442
<div class="cell_input code_cell docutils container">
444443
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">exp</span><span class="o">.</span><span class="n">model_interpret</span><span class="p">(</span><span class="n">model</span><span class="o">=</span><span class="s2">&quot;ReLUDNN&quot;</span><span class="p">,</span> <span class="n">show</span><span class="o">=</span><span class="s2">&quot;local_fi&quot;</span><span class="p">,</span> <span class="n">sample_id</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">centered</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">original_scale</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">4</span><span class="p">))</span>
@@ -451,7 +450,7 @@ <h3><span class="section-number">5.9.5.1. </span>Local Feature Contribution plot
451450
<figure class="align-left">
452451
<a class="reference external image-reference" href="../../auto_examples/models/plot_plot_8_reludnn_cls.html"><img alt="../../_images/sphx_glr_plot_8_reludnn_cls_006.png" src="../../_images/sphx_glr_plot_8_reludnn_cls_006.png" /></a>
453452
</figure>
454-
<p>The definition of <code class="docutils literal notranslate"><span class="pre">Weight</span></code> and <code class="docutils literal notranslate"><span class="pre">Effect</span></code> can be found in the introduction for GLM. Similarly, we provide the <code class="docutils literal notranslate"><span class="pre">centered</span></code> option, as shown below.</p>
453+
<p>The definition of <code class="docutils literal notranslate"><span class="pre">Weight</span></code> and <code class="docutils literal notranslate"><span class="pre">Effect</span></code> can be found in the introduction for GLM. The stems represent the coefficients and the bars show the effect. Similarly, we provide the <code class="docutils literal notranslate"><span class="pre">centered</span></code> option, as shown below.</p>
455454
<div class="jupyter_cell jupyter_container docutils container">
456455
<div class="cell_input code_cell docutils container">
457456
<div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="n">exp</span><span class="o">.</span><span class="n">model_interpret</span><span class="p">(</span><span class="n">model</span><span class="o">=</span><span class="s2">&quot;ReLUDNN&quot;</span><span class="p">,</span> <span class="n">show</span><span class="o">=</span><span class="s2">&quot;local_fi&quot;</span><span class="p">,</span> <span class="n">sample_id</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">centered</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">original_scale</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">figsize</span><span class="o">=</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">4</span><span class="p">))</span>

0 commit comments

Comments
 (0)