Skip to content

Commit

Permalink
Add paper link to new attr methods
Browse files Browse the repository at this point in the history
  • Loading branch information
@josephenguehard
josephenguehard committed Jun 6, 2023
1 parent 730cc3f commit be174bb
Show file tree
Hide file tree
Showing 12 changed files with 41 additions and 7 deletions.
Binary file modified docs/build/doctrees/attr.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
View file
Binary file not shown.
6 changes: 6 additions & 0 deletions docs/build/html/_modules/tint/attr/lof.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,9 @@ <h1>Source code for tint.attr.lof</h1><div class="highlight"><pre>
<span class="sd"> kwargs includes baselines, feature_mask, num_interp_features</span>
<span class="sd"> (integer, determined from feature mask).</span>

<span class="sd"> References:</span>
<span class="sd"> `Time Interpret: a Unified Model Interpretability Library for Time Series &lt;https://arxiv.org/abs/2306.02968&gt;`_</span>

<span class="sd"> Examples:</span>
<span class="sd"> &gt;&gt;&gt; import torch as th</span>
<span class="sd"> &gt;&gt;&gt; from tint.attr import LofLime</span>
Expand Down Expand Up @@ -395,6 +398,9 @@ <h1>Source code for tint.attr.lof</h1><div class="highlight"><pre>
<span class="sd"> n_neighbors (int): Number of neighbors to use by default.</span>
<span class="sd"> Default to 20</span>

<span class="sd"> References:</span>
<span class="sd"> `Time Interpret: a Unified Model Interpretability Library for Time Series &lt;https://arxiv.org/abs/2306.02968&gt;`_</span>

<span class="sd"> Examples:</span>
<span class="sd"> &gt;&gt;&gt; import torch as th</span>
<span class="sd"> &gt;&gt;&gt; from tint.attr import LofKernelShap</span>
Expand Down
3 changes: 2 additions & 1 deletion docs/build/html/_modules/tint/attr/non_linearities_tunnel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,8 @@ <h1>Source code for tint.attr.non_linearities_tunnel</h1><div class="highlight">
<span class="sd"> Conductance or Saliency.</span>

<span class="sd"> References:</span>
<span class="sd"> `Explanations can be manipulated and geometry is to blame &lt;https://arxiv.org/abs/1906.07983&gt;`_</span>
<span class="sd"> #. `Time Interpret: a Unified Model Interpretability Library for Time Series &lt;https://arxiv.org/abs/2306.02968&gt;`_</span>
<span class="sd"> #. `Explanations can be manipulated and geometry is to blame &lt;https://arxiv.org/abs/1906.07983&gt;`_</span>

<span class="sd"> Examples:</span>
<span class="sd"> &gt;&gt;&gt; import torch as th</span>
Expand Down
3 changes: 3 additions & 0 deletions docs/build/html/_modules/tint/attr/temporal_ig.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,9 @@ <h1>Source code for tint.attr.temporal_ig</h1><div class="highlight"><pre>
<span class="sd"> is set to True, final sensitivity scores are being multiplied by</span>
<span class="sd"> (inputs - baselines).</span>

<span class="sd"> References:</span>
<span class="sd"> `Time Interpret: a Unified Model Interpretability Library for Time Series &lt;https://arxiv.org/abs/2306.02968&gt;`_</span>

<span class="sd"> Examples:</span>
<span class="sd"> &gt;&gt;&gt; import torch as th</span>
<span class="sd"> &gt;&gt;&gt; from tint.attr import TemporalIntegratedGradients</span>
Expand Down
3 changes: 2 additions & 1 deletion docs/build/html/_modules/tint/attr/time_forward_tunnel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,8 @@ <h1>Source code for tint.attr.time_forward_tunnel</h1><div class="highlight"><pr
<span class="sd"> Conductance or Saliency.</span>

<span class="sd"> References:</span>
<span class="sd"> `What went wrong and when? Instance-wise Feature Importance for Time-series Models &lt;https://arxiv.org/abs/2003.02821&gt;`_</span>
<span class="sd"> #. `What went wrong and when? Instance-wise Feature Importance for Time-series Models &lt;https://arxiv.org/abs/2003.02821&gt;`_</span>
<span class="sd"> #. `Time Interpret: a Unified Model Interpretability Library for Time Series &lt;https://arxiv.org/abs/2306.02968&gt;`_</span>

<span class="sd"> Examples:</span>
<span class="sd"> &gt;&gt;&gt; import torch as th</span>
Expand Down
16 changes: 14 additions & 2 deletions docs/build/html/attr.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2235,6 +2235,8 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headin
</ul>
</dd>
</dl>
<p class="rubric">References</p>
<p><a class="reference external" href="https://arxiv.org/abs/2306.02968">Time Interpret: a Unified Model Interpretability Library for Time Series</a></p>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">torch</span> <span class="k">as</span> <span class="nn">th</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">tint.attr</span> <span class="kn">import</span> <span class="n">LofKernelShap</span>
Expand Down Expand Up @@ -2344,6 +2346,8 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headin
</ul>
</dd>
</dl>
<p class="rubric">References</p>
<p><a class="reference external" href="https://arxiv.org/abs/2306.02968">Time Interpret: a Unified Model Interpretability Library for Time Series</a></p>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">torch</span> <span class="k">as</span> <span class="nn">th</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">tint.attr</span> <span class="kn">import</span> <span class="n">LofLime</span>
Expand Down Expand Up @@ -2386,7 +2390,10 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headin
</dd>
</dl>
<p class="rubric">References</p>
<p><a class="reference external" href="https://arxiv.org/abs/1906.07983">Explanations can be manipulated and geometry is to blame</a></p>
<ol class="arabic simple">
<li><p><a class="reference external" href="https://arxiv.org/abs/2306.02968">Time Interpret: a Unified Model Interpretability Library for Time Series</a></p></li>
<li><p><a class="reference external" href="https://arxiv.org/abs/1906.07983">Explanations can be manipulated and geometry is to blame</a></p></li>
</ol>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">torch</span> <span class="k">as</span> <span class="nn">th</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">captum.attr</span> <span class="kn">import</span> <span class="n">Saliency</span>
Expand Down Expand Up @@ -3244,6 +3251,8 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headin
</ul>
</dd>
</dl>
<p class="rubric">References</p>
<p><a class="reference external" href="https://arxiv.org/abs/2306.02968">Time Interpret: a Unified Model Interpretability Library for Time Series</a></p>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">torch</span> <span class="k">as</span> <span class="nn">th</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">tint.attr</span> <span class="kn">import</span> <span class="n">TemporalIntegratedGradients</span>
Expand Down Expand Up @@ -3619,7 +3628,10 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headin
</dd>
</dl>
<p class="rubric">References</p>
<p><a class="reference external" href="https://arxiv.org/abs/2003.02821">What went wrong and when? Instance-wise Feature Importance for Time-series Models</a></p>
<ol class="arabic simple">
<li><p><a class="reference external" href="https://arxiv.org/abs/2003.02821">What went wrong and when? Instance-wise Feature Importance for Time-series Models</a></p></li>
<li><p><a class="reference external" href="https://arxiv.org/abs/2306.02968">Time Interpret: a Unified Model Interpretability Library for Time Series</a></p></li>
</ol>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">torch</span> <span class="k">as</span> <span class="nn">th</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">captum.attr</span> <span class="kn">import</span> <span class="n">Saliency</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js
View file

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions tint/attr/lof.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,9 @@ class LofLime(Lime, LOF):
kwargs includes baselines, feature_mask, num_interp_features
(integer, determined from feature mask).
References:
`Time Interpret: a Unified Model Interpretability Library for Time Series <https://arxiv.org/abs/2306.02968>`_
Examples:
>>> import torch as th
>>> from tint.attr import LofLime
Expand Down Expand Up @@ -224,6 +227,9 @@ class LofKernelShap(KernelShap, LOF):
n_neighbors (int): Number of neighbors to use by default.
Default to 20
References:
`Time Interpret: a Unified Model Interpretability Library for Time Series <https://arxiv.org/abs/2306.02968>`_
Examples:
>>> import torch as th
>>> from tint.attr import LofKernelShap
Expand Down
3 changes: 2 additions & 1 deletion tint/attr/non_linearities_tunnel.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ class NonLinearitiesTunnel(Attribution):
Conductance or Saliency.
References:
`Explanations can be manipulated and geometry is to blame <https://arxiv.org/abs/1906.07983>`_
#. `Time Interpret: a Unified Model Interpretability Library for Time Series <https://arxiv.org/abs/2306.02968>`_
#. `Explanations can be manipulated and geometry is to blame <https://arxiv.org/abs/1906.07983>`_
Examples:
>>> import torch as th
Expand Down
3 changes: 3 additions & 0 deletions tint/attr/temporal_ig.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ class TemporalIntegratedGradients(IntegratedGradients):
is set to True, final sensitivity scores are being multiplied by
(inputs - baselines).
References:
`Time Interpret: a Unified Model Interpretability Library for Time Series <https://arxiv.org/abs/2306.02968>`_
Examples:
>>> import torch as th
>>> from tint.attr import TemporalIntegratedGradients
Expand Down
3 changes: 2 additions & 1 deletion tint/attr/time_forward_tunnel.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ class TimeForwardTunnel(Attribution):
Conductance or Saliency.
References:
`What went wrong and when? Instance-wise Feature Importance for Time-series Models <https://arxiv.org/abs/2003.02821>`_
#. `What went wrong and when? Instance-wise Feature Importance for Time-series Models <https://arxiv.org/abs/2003.02821>`_
#. `Time Interpret: a Unified Model Interpretability Library for Time Series <https://arxiv.org/abs/2306.02968>`_
Examples:
>>> import torch as th
Expand Down

0 comments on commit be174bb

Please sign in to comment.