[skip ci] Documentation updates

frgfm · Oct 19, 2023 · 3498c8c · 3498c8c
1 parent 8b3b51b
commit 3498c8c
Show file tree

Hide file tree

Showing 48 changed files with 948 additions and 118 deletions.
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/installing.doctree b/.doctrees/installing.doctree
diff --git a/.doctrees/metrics.doctree b/.doctrees/metrics.doctree
diff --git a/_modules/index.html b/_modules/index.html
@@ -172,6 +172,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../methods.html">torchcam.methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../metrics.html">torchcam.metrics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../utils.html">torchcam.utils</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
@@ -213,6 +214,7 @@
           <h1>All modules for which code is available</h1>
 <ul><li><a href="torchcam/methods/activation.html">torchcam.methods.activation</a></li>
 <li><a href="torchcam/methods/gradient.html">torchcam.methods.gradient</a></li>
+<li><a href="torchcam/metrics.html">torchcam.metrics</a></li>
 <li><a href="torchcam/utils.html">torchcam.utils</a></li>
 </ul>
         </article>
@@ -253,12 +255,12 @@ <h1>All modules for which code is available</h1>
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=4478a36a"></script>
+</div><script src="../_static/documentation_options.js?v=cd94c4bc"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="../_static/copybutton.js?v=f281be69"></script>
-    <script src="../_static/js/custom.js?v=80ad3375"></script>
+    <script src="../_static/js/custom.js?v=d052c7dc"></script>
     </body>
 </html>
diff --git a/_modules/torchcam/methods/activation.html b/_modules/torchcam/methods/activation.html
diff --git a/_modules/torchcam/methods/gradient.html b/_modules/torchcam/methods/gradient.html
diff --git a/_modules/torchcam/metrics.html b/_modules/torchcam/metrics.html
diff --git a/_modules/torchcam/utils.html b/_modules/torchcam/utils.html
@@ -172,6 +172,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../methods.html">torchcam.methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../metrics.html">torchcam.metrics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../utils.html">torchcam.utils</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
@@ -211,13 +212,13 @@
         </div>
         <article role="main">
           <h1>Source code for torchcam.utils</h1><div class="highlight"><pre>
-<span></span><span class="c1"># Copyright (C) 2020-2022, François-Guillaume Fernandez.</span>
+<span></span><span class="c1"># Copyright (C) 2020-2023, François-Guillaume Fernandez.</span>
 
 <span class="c1"># This program is licensed under the Apache License 2.0.</span>
 <span class="c1"># See LICENSE or go to &lt;https://www.apache.org/licenses/LICENSE-2.0&gt; for full license details.</span>
 
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
-<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="kn">import</span> <span class="n">cm</span>
+<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="kn">import</span> <span class="n">colormaps</span> <span class="k">as</span> <span class="n">cm</span>
 <span class="kn">from</span> <span class="nn">PIL</span> <span class="kn">import</span> <span class="n">Image</span>
 
 
@@ -246,7 +247,6 @@ <h1>Source code for torchcam.utils</h1><div class="highlight"><pre>
 <span class="sd">        TypeError: when the arguments have invalid types</span>
 <span class="sd">        ValueError: when the alpha argument has an incorrect value</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-
     <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">img</span><span class="p">,</span> <span class="n">Image</span><span class="o">.</span><span class="n">Image</span><span class="p">)</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">mask</span><span class="p">,</span> <span class="n">Image</span><span class="o">.</span><span class="n">Image</span><span class="p">):</span>
         <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;img and mask arguments need to be PIL.Image&quot;</span><span class="p">)</span>
 
@@ -301,12 +301,12 @@ <h1>Source code for torchcam.utils</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=4478a36a"></script>
+</div><script src="../../_static/documentation_options.js?v=cd94c4bc"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="../../_static/copybutton.js?v=f281be69"></script>
-    <script src="../../_static/js/custom.js?v=80ad3375"></script>
+    <script src="../../_static/js/custom.js?v=d052c7dc"></script>
     </body>
 </html>
diff --git a/_sources/changelog.rst.txt b/_sources/changelog.rst.txt
@@ -1,6 +1,10 @@
 Changelog
 =========
 
+v0.3.2 (2022-08-02)
+-------------------
+Release note: `v0.3.2 <https://github.com/frgfm/torch-cam/releases/tag/v0.3.2>`_
+
 v0.3.1 (2021-10-31)
 -------------------
 Release note: `v0.3.1 <https://github.com/frgfm/torch-cam/releases/tag/v0.3.1>`_

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -51,6 +51,7 @@ Gradient-based methods
    :hidden:
 
    methods
+   metrics
    utils
 
 

diff --git a/_sources/installing.rst.txt b/_sources/installing.rst.txt
@@ -3,7 +3,7 @@
 Installation
 ************
 
-This library requires `Python <https://www.python.org/downloads/>`_ 3.6 or higher.
+This library requires `Python <https://www.python.org/downloads/>`_ 3.8 or higher.
 
 Via Python Package
 ==================

diff --git a/_sources/metrics.rst.txt b/_sources/metrics.rst.txt
@@ -0,0 +1,13 @@
+torchcam.metrics
+================
+
+
+.. currentmodule:: torchcam.metrics
+
+
+Apart from qualitative visual comparison, it is important to have a refined evaluation metric for class activation maps. This submodule is dedicated to the evaluation of CAM methods.
+
+.. autoclass:: ClassificationMetric
+
+    .. automethod:: update
+    .. automethod:: summary
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.3.2.dev0-git',
+    VERSION: '0.4.0.dev0-git',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/_static/js/custom.js b/_static/js/custom.js
diff --git a/changelog.html b/changelog.html
@@ -173,6 +173,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="methods.html">torchcam.methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="metrics.html">torchcam.metrics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="utils.html">torchcam.utils</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
@@ -222,6 +223,10 @@
         <article role="main">
           <section id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading">#</a></h1>
+<section id="v0-3-2-2022-08-02">
+<h2>v0.3.2 (2022-08-02)<a class="headerlink" href="#v0-3-2-2022-08-02" title="Link to this heading">#</a></h2>
+<p>Release note: <a class="reference external" href="https://github.com/frgfm/torch-cam/releases/tag/v0.3.2">v0.3.2</a></p>
+</section>
 <section id="v0-3-1-2021-10-31">
 <h2>v0.3.1 (2021-10-31)<a class="headerlink" href="#v0-3-1-2021-10-31" title="Link to this heading">#</a></h2>
 <p>Release note: <a class="reference external" href="https://github.com/frgfm/torch-cam/releases/tag/v0.3.1">v0.3.1</a></p>
@@ -303,6 +308,7 @@ <h2>v0.1.0 (2020-03-24)<a class="headerlink" href="#v0-1-0-2020-03-24" title="Li
           <div class="toc-tree">
             <ul>
 <li><a class="reference internal" href="#">Changelog</a><ul>
+<li><a class="reference internal" href="#v0-3-2-2022-08-02">v0.3.2 (2022-08-02)</a></li>
 <li><a class="reference internal" href="#v0-3-1-2021-10-31">v0.3.1 (2021-10-31)</a></li>
 <li><a class="reference internal" href="#v0-3-0-2021-10-31">v0.3.0 (2021-10-31)</a></li>
 <li><a class="reference internal" href="#v0-2-0-2021-04-10">v0.2.0 (2021-04-10)</a></li>
@@ -320,12 +326,12 @@ <h2>v0.1.0 (2020-03-24)<a class="headerlink" href="#v0-1-0-2020-03-24" title="Li
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=4478a36a"></script>
+</div><script src="_static/documentation_options.js?v=cd94c4bc"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="_static/copybutton.js?v=f281be69"></script>
-    <script src="_static/js/custom.js?v=80ad3375"></script>
+    <script src="_static/js/custom.js?v=d052c7dc"></script>
     </body>
 </html>
diff --git a/genindex.html b/genindex.html
@@ -171,6 +171,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="methods.html">torchcam.methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="metrics.html">torchcam.metrics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="utils.html">torchcam.utils</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
@@ -212,13 +213,17 @@
 
 <section class="genindex-section">
   <h1 id="index">Index</h1>
-  <div class="genindex-jumpbox"><a href="#C"><strong>C</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#X"><strong>X</strong></a></div>
+  <div class="genindex-jumpbox"><a href="#C"><strong>C</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#U"><strong>U</strong></a> | <a href="#X"><strong>X</strong></a></div>
 </section>
 <section id="C" class="genindex-section">
   <h2>C</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="methods.html#torchcam.methods.CAM">CAM (class in torchcam.methods)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="metrics.html#torchcam.metrics.ClassificationMetric">ClassificationMetric (class in torchcam.metrics)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -284,11 +289,23 @@ <h2>S</h2>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="methods.html#torchcam.methods.ScoreCAM">ScoreCAM (class in torchcam.methods)</a>
 </li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="methods.html#torchcam.methods.SmoothGradCAMpp">SmoothGradCAMpp (class in torchcam.methods)</a>
 </li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="methods.html#torchcam.methods.SSCAM">SSCAM (class in torchcam.methods)</a>
+</li>
+        <li><a href="metrics.html#torchcam.metrics.ClassificationMetric.summary">summary() (torchcam.metrics.ClassificationMetric method)</a>
+</li>
+    </ul></td>
+  </tr></table>
+</section>
+
+<section id="U" class="genindex-section">
+  <h2>U</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="metrics.html#torchcam.metrics.ClassificationMetric.update">update() (torchcam.metrics.ClassificationMetric method)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -343,12 +360,12 @@ <h2>X</h2>
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=4478a36a"></script>
+</div><script src="_static/documentation_options.js?v=cd94c4bc"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="_static/copybutton.js?v=f281be69"></script>
-    <script src="_static/js/custom.js?v=80ad3375"></script>
+    <script src="_static/js/custom.js?v=d052c7dc"></script>
     </body>
 </html>
diff --git a/index.html b/index.html
@@ -173,6 +173,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="methods.html">torchcam.methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="metrics.html">torchcam.metrics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="utils.html">torchcam.utils</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
@@ -334,12 +335,12 @@ <h3>Gradient-based methods<a class="headerlink" href="#gradient-based-methods" t
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=4478a36a"></script>
+</div><script src="_static/documentation_options.js?v=cd94c4bc"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="_static/copybutton.js?v=f281be69"></script>
-    <script src="_static/js/custom.js?v=80ad3375"></script>
+    <script src="_static/js/custom.js?v=d052c7dc"></script>
     </body>
 </html>
diff --git a/installing.html b/installing.html
@@ -173,6 +173,7 @@
 <p class="caption" role="heading"><span class="caption-text">Package Reference</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="methods.html">torchcam.methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="metrics.html">torchcam.metrics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="utils.html">torchcam.utils</a></li>
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
@@ -222,7 +223,7 @@
         <article role="main">
           <section id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">#</a></h1>
-<p>This library requires <a class="reference external" href="https://www.python.org/downloads/">Python</a> 3.6 or higher.</p>
+<p>This library requires <a class="reference external" href="https://www.python.org/downloads/">Python</a> 3.8 or higher.</p>
 <section id="via-python-package">
 <h2>Via Python Package<a class="headerlink" href="#via-python-package" title="Link to this heading">#</a></h2>
 <p>Install the last stable release of the package using <a class="reference external" href="https://pip.pypa.io/en/stable/installation/">pip</a>:</p>
@@ -324,12 +325,12 @@ <h2>Via Git<a class="headerlink" href="#via-git" title="Link to this heading">#<
 
     </aside>
   </div>
-</div><script src="_static/documentation_options.js?v=4478a36a"></script>
+</div><script src="_static/documentation_options.js?v=cd94c4bc"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="_static/copybutton.js?v=f281be69"></script>
-    <script src="_static/js/custom.js?v=80ad3375"></script>
+    <script src="_static/js/custom.js?v=d052c7dc"></script>
     </body>
 </html>
diff --git a/latest/.doctrees/changelog.doctree b/latest/.doctrees/changelog.doctree
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/_modules/index.html b/latest/_modules/index.html
@@ -255,12 +255,12 @@ <h1>All modules for which code is available</h1>
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=cd94c4bc"></script>
+</div><script src="../_static/documentation_options.js?v=478c7602"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="../_static/copybutton.js?v=f281be69"></script>
-    <script src="../_static/js/custom.js?v=80ad3375"></script>
+    <script src="../_static/js/custom.js?v=d052c7dc"></script>
     </body>
 </html>
diff --git a/latest/_modules/torchcam/methods/activation.html b/latest/_modules/torchcam/methods/activation.html
@@ -680,12 +680,12 @@ <h1>Source code for torchcam.methods.activation</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=cd94c4bc"></script>
+</div><script src="../../../_static/documentation_options.js?v=478c7602"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="../../../_static/copybutton.js?v=f281be69"></script>
-    <script src="../../../_static/js/custom.js?v=80ad3375"></script>
+    <script src="../../../_static/js/custom.js?v=d052c7dc"></script>
     </body>
 </html>
diff --git a/latest/_modules/torchcam/methods/gradient.html b/latest/_modules/torchcam/methods/gradient.html
@@ -659,12 +659,12 @@ <h1>Source code for torchcam.methods.gradient</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=cd94c4bc"></script>
+</div><script src="../../../_static/documentation_options.js?v=478c7602"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="../../../_static/copybutton.js?v=f281be69"></script>
-    <script src="../../../_static/js/custom.js?v=80ad3375"></script>
+    <script src="../../../_static/js/custom.js?v=d052c7dc"></script>
     </body>
 </html>
diff --git a/latest/_modules/torchcam/metrics.html b/latest/_modules/torchcam/metrics.html
@@ -393,12 +393,12 @@ <h1>Source code for torchcam.metrics</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../_static/documentation_options.js?v=cd94c4bc"></script>
+</div><script src="../../_static/documentation_options.js?v=478c7602"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../_static/scripts/furo.js?v=32e29ea5"></script>
     <script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
     <script src="../../_static/copybutton.js?v=f281be69"></script>
-    <script src="../../_static/js/custom.js?v=80ad3375"></script>
+    <script src="../../_static/js/custom.js?v=d052c7dc"></script>
     </body>
 </html>
-Original file line number
+Diff line change
@@ Expand Up / @@ -51,6 +51,7 @@ Gradient-based methods @@
        :hidden:
        methods
+       metrics
        utils
@@ Expand Down @@