Update documentation

Author: actions-user

develop/_modules/openvino_xai/api/api.html

@@ -398,33 +398,36 @@ <h1>Source code for openvino_xai.api.api</h1><div class="highlight"><pre>
 <span></span><span class="c1"># Copyright (C) 2024 Intel Corporation</span>
 <span class="c1"># SPDX-License-Identifier: Apache-2.0</span>
 
-<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span>
+<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">TypeVar</span>
 
 <span class="kn">import</span> <span class="nn">openvino</span> <span class="k">as</span> <span class="nn">ov</span>
+<span class="kn">import</span> <span class="nn">torch</span>
 
 <span class="kn">from</span> <span class="nn">openvino_xai.common.parameters</span> <span class="kn">import</span> <span class="n">Method</span><span class="p">,</span> <span class="n">Task</span>
 <span class="kn">from</span> <span class="nn">openvino_xai.common.utils</span> <span class="kn">import</span> <span class="n">IdentityPreprocessFN</span><span class="p">,</span> <span class="n">has_xai</span><span class="p">,</span> <span class="n">logger</span>
 <span class="kn">from</span> <span class="nn">openvino_xai.methods.factory</span> <span class="kn">import</span> <span class="n">WhiteBoxMethodFactory</span>
 
+<span class="n">Model</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;Model&quot;</span><span class="p">,</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">)</span>
+
 
 <div class="viewcode-block" id="insert_xai">
 <a class="viewcode-back" href="../../../api-manual.html#openvino_xai.api.insert_xai">[docs]</a>
 <span class="k">def</span> <span class="nf">insert_xai</span><span class="p">(</span>
-    <span class="n">model</span><span class="p">:</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span><span class="p">,</span>
+    <span class="n">model</span><span class="p">:</span> <span class="n">Model</span><span class="p">,</span>
     <span class="n">task</span><span class="p">:</span> <span class="n">Task</span><span class="p">,</span>
     <span class="n">explain_method</span><span class="p">:</span> <span class="n">Method</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
     <span class="n">target_layer</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
     <span class="n">embed_scaling</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span>
     <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
-<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span><span class="p">:</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Model</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    Function that inserts XAI branch into IR.</span>
+<span class="sd">    Inserts XAI branch into the given model.</span>
 
 <span class="sd">    Usage:</span>
 <span class="sd">        model_xai = openvino_xai.insert_xai(model, task=Task.CLASSIFICATION)</span>
 
-<span class="sd">    :param model: Original IR.</span>
-<span class="sd">    :type model: ov.Model | str</span>
+<span class="sd">    :param model: Original model.</span>
+<span class="sd">    :type model: ov.Model | torch.nn.Module</span>
 <span class="sd">    :param task: Type of the task: CLASSIFICATION or DETECTION.</span>
 <span class="sd">    :type task: Task</span>
 <span class="sd">    :parameter explain_method: Explain method to use for model explanation.</span>
@@ -436,7 +439,7 @@ <h1>Source code for openvino_xai.api.api</h1><div class="highlight"><pre>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="k">if</span> <span class="n">has_xai</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
-        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Provided IR model already contains XAI branch, return it as-is.&quot;</span><span class="p">)</span>
+        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Provided model already contains XAI branch, return it as-is.&quot;</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">model</span>
 
     <span class="n">method</span> <span class="o">=</span> <span class="n">WhiteBoxMethodFactory</span><span class="o">.</span><span class="n">create_method</span><span class="p">(</span>

develop/_modules/openvino_xai/common/utils.html

@@ -407,7 +407,8 @@ <h1>Source code for openvino_xai.common.utils</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">urllib.request</span> <span class="kn">import</span> <span class="n">urlretrieve</span>
 
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
-<span class="kn">import</span> <span class="nn">openvino.runtime</span> <span class="k">as</span> <span class="nn">ov</span>
+<span class="kn">import</span> <span class="nn">openvino</span> <span class="k">as</span> <span class="nn">ov</span>
+<span class="kn">import</span> <span class="nn">torch</span>
 
 <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;openvino_xai&quot;</span><span class="p">)</span>
 <span class="n">handler</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">()</span>
@@ -422,20 +423,23 @@ <h1>Source code for openvino_xai.common.utils</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="has_xai">
 <a class="viewcode-back" href="../../../api-manual.html#openvino_xai.common.has_xai">[docs]</a>
-<span class="k">def</span> <span class="nf">has_xai</span><span class="p">(</span><span class="n">model</span><span class="p">:</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
+<span class="k">def</span> <span class="nf">has_xai</span><span class="p">(</span><span class="n">model</span><span class="p">:</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span> <span class="o">|</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Function checks if the model contains XAI branch.</span>
 
-<span class="sd">    :param model: OV IR model.</span>
-<span class="sd">    :type model: ov.Model</span>
+<span class="sd">    :param model: Input model for inspect.</span>
+<span class="sd">    :type model: ov.Model | torch.nn.Module</span>
 <span class="sd">    :return: True is the model has XAI branch and saliency_map output, False otherwise.</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">model</span><span class="p">,</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
-        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Input model has to be ov.Model instance, but got</span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">model</span><span class="p">)</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span>
-    <span class="k">for</span> <span class="n">output</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">outputs</span><span class="p">:</span>
-        <span class="k">if</span> <span class="n">SALIENCY_MAP_OUTPUT_NAME</span> <span class="ow">in</span> <span class="n">output</span><span class="o">.</span><span class="n">get_names</span><span class="p">():</span>
-            <span class="k">return</span> <span class="kc">True</span>
-    <span class="k">return</span> <span class="kc">False</span></div>
+    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
+        <span class="k">for</span> <span class="n">output</span> <span class="ow">in</span> <span class="n">model</span><span class="o">.</span><span class="n">outputs</span><span class="p">:</span>
+            <span class="k">if</span> <span class="n">SALIENCY_MAP_OUTPUT_NAME</span> <span class="ow">in</span> <span class="n">output</span><span class="o">.</span><span class="n">get_names</span><span class="p">():</span>
+                <span class="k">return</span> <span class="kc">True</span>
+        <span class="k">return</span> <span class="kc">False</span>
+    <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
+        <span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="s2">&quot;has_xai&quot;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+    <span class="k">else</span><span class="p">:</span>
+        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Input model has to be openvino.Model or torch.nn.Module instance, but got</span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">model</span><span class="p">)</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span></div>
 
 
 

develop/_modules/openvino_xai/methods/white_box/activation_map.html

@@ -402,6 +402,7 @@ <h1>Source code for openvino_xai.methods.white_box.activation_map</h1><div class
 
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
 <span class="kn">import</span> <span class="nn">openvino.runtime</span> <span class="k">as</span> <span class="nn">ov</span>
+<span class="kn">import</span> <span class="nn">torch</span>
 <span class="kn">from</span> <span class="nn">openvino.runtime</span> <span class="kn">import</span> <span class="n">opset10</span> <span class="k">as</span> <span class="n">opset</span>
 
 <span class="kn">from</span> <span class="nn">openvino_xai.common.utils</span> <span class="kn">import</span> <span class="n">IdentityPreprocessFN</span>
@@ -430,6 +431,18 @@ <h1>Source code for openvino_xai.methods.white_box.activation_map</h1><div class
 <span class="sd">    :type prepare_model: bool</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">def</span> <span class="fm">__new__</span><span class="p">(</span>
+        <span class="bp">cls</span><span class="p">,</span>
+        <span class="n">model</span><span class="p">:</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span> <span class="o">|</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+        <span class="o">*</span><span class="n">args</span><span class="p">,</span>
+        <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
+    <span class="p">):</span>
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
+            <span class="kn">from</span> <span class="nn">.torch</span> <span class="kn">import</span> <span class="n">TorchActivationMap</span>
+
+            <span class="k">return</span> <span class="n">TorchActivationMap</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+        <span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span>
+
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">model</span><span class="p">:</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span><span class="p">,</span>

develop/_modules/openvino_xai/methods/white_box/base.html

@@ -418,7 +418,7 @@ <h1>Source code for openvino_xai.methods.white_box.base</h1><div class="highligh
 
 <div class="viewcode-block" id="WhiteBoxMethod">
 <a class="viewcode-back" href="../../../../api-manual.html#openvino_xai.methods.WhiteBoxMethod">[docs]</a>
-<span class="k">class</span> <span class="nc">WhiteBoxMethod</span><span class="p">(</span><span class="n">MethodBase</span><span class="p">):</span>
+<span class="k">class</span> <span class="nc">WhiteBoxMethod</span><span class="p">(</span><span class="n">MethodBase</span><span class="p">[</span><span class="n">ov</span><span class="o">.</span><span class="n">Model</span><span class="p">,</span> <span class="n">ov</span><span class="o">.</span><span class="n">CompiledModel</span><span class="p">]):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Base class for white-box XAI methods.</span>
 
@@ -471,15 +471,15 @@ <h1>Source code for openvino_xai.methods.white_box.base</h1><div class="highligh
             <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Provided IR model already contains XAI branch.&quot;</span><span class="p">)</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">_model</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model_ori</span>
             <span class="k">if</span> <span class="n">load_model</span><span class="p">:</span>
-                <span class="bp">self</span><span class="o">.</span><span class="n">load_model</span><span class="p">()</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">_model_compiled</span> <span class="o">=</span> <span class="n">ov</span><span class="o">.</span><span class="n">Core</span><span class="p">()</span><span class="o">.</span><span class="n">compile_model</span><span class="p">(</span><span class="n">model</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="p">,</span> <span class="n">device_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_device_name</span><span class="p">)</span>
             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span>
 
         <span class="n">xai_output_node</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">generate_xai_branch</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_model</span> <span class="o">=</span> <span class="n">insert_xai_branch_into_model</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_model_ori</span><span class="p">,</span> <span class="n">xai_output_node</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">embed_scaling</span><span class="p">)</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="n">has_xai</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="p">):</span>
             <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s2">&quot;Insertion of the XAI branch into the model was not successful.&quot;</span><span class="p">)</span>
         <span class="k">if</span> <span class="n">load_model</span><span class="p">:</span>
-            <span class="bp">self</span><span class="o">.</span><span class="n">load_model</span><span class="p">()</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_model_compiled</span> <span class="o">=</span> <span class="n">ov</span><span class="o">.</span><span class="n">Core</span><span class="p">()</span><span class="o">.</span><span class="n">compile_model</span><span class="p">(</span><span class="n">model</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="p">,</span> <span class="n">device_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_device_name</span><span class="p">)</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span></div>
 
 

develop/_modules/openvino_xai/methods/white_box/recipro_cam.html

@@ -404,6 +404,7 @@ <h1>Source code for openvino_xai.methods.white_box.recipro_cam</h1><div class="h
 
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
 <span class="kn">import</span> <span class="nn">openvino.runtime</span> <span class="k">as</span> <span class="nn">ov</span>
+<span class="kn">import</span> <span class="nn">torch</span>
 <span class="kn">from</span> <span class="nn">openvino.runtime</span> <span class="kn">import</span> <span class="n">opset10</span> <span class="k">as</span> <span class="n">opset</span>
 
 <span class="kn">from</span> <span class="nn">openvino_xai.common.utils</span> <span class="kn">import</span> <span class="n">IdentityPreprocessFN</span>
@@ -483,6 +484,18 @@ <h1>Source code for openvino_xai.methods.white_box.recipro_cam</h1><div class="h
 <span class="sd">    :type prepare_model: bool</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">def</span> <span class="fm">__new__</span><span class="p">(</span>
+        <span class="bp">cls</span><span class="p">,</span>
+        <span class="n">model</span><span class="p">:</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span> <span class="o">|</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+        <span class="o">*</span><span class="n">args</span><span class="p">,</span>
+        <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
+    <span class="p">):</span>
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
+            <span class="kn">from</span> <span class="nn">.torch</span> <span class="kn">import</span> <span class="n">TorchReciproCAM</span>
+
+            <span class="k">return</span> <span class="n">TorchReciproCAM</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+        <span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span>
+
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">model</span><span class="p">:</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span><span class="p">,</span>
@@ -579,6 +592,18 @@ <h1>Source code for openvino_xai.methods.white_box.recipro_cam</h1><div class="h
 <span class="sd">    :type prepare_model: bool</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
+    <span class="k">def</span> <span class="fm">__new__</span><span class="p">(</span>
+        <span class="bp">cls</span><span class="p">,</span>
+        <span class="n">model</span><span class="p">:</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span> <span class="o">|</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+        <span class="o">*</span><span class="n">args</span><span class="p">,</span>
+        <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
+    <span class="p">):</span>
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">torch</span><span class="o">.</span><span class="n">nn</span><span class="o">.</span><span class="n">Module</span><span class="p">):</span>
+            <span class="kn">from</span> <span class="nn">.torch</span> <span class="kn">import</span> <span class="n">TorchViTReciproCAM</span>
+
+            <span class="k">return</span> <span class="n">TorchViTReciproCAM</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+        <span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__new__</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span>
+
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">model</span><span class="p">:</span> <span class="n">ov</span><span class="o">.</span><span class="n">Model</span><span class="p">,</span>