Update documentation

Author: actions-user

releases/1.1.0/_downloads/bf0a086155a09e7733279dc08c5ed41b/recipro_cam.py

@@ -7,12 +7,12 @@
 
 import numpy as np
 import openvino.runtime as ov
-import torch
 from openvino.runtime import opset10 as opset
 
 from openvino_xai.common.utils import IdentityPreprocessFN
 from openvino_xai.inserter.model_parser import IRParserCls, ModelType
 from openvino_xai.methods.white_box.base import WhiteBoxMethod
+from openvino_xai.utils.torch import torch
 
 
 class FeatureMapPerturbationBase(WhiteBoxMethod):

releases/1.1.0/_modules/openvino_xai/api/api.html

@@ -401,11 +401,11 @@ <h1>Source code for openvino_xai.api.api</h1><div class="highlight"><pre>
 <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="kn">from</span> <span class="nn">openvino_xai.utils.torch</span> <span class="kn">import</span> <span class="n">torch</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>
 

releases/1.1.0/_modules/openvino_xai/common/utils.html

@@ -408,7 +408,8 @@ <h1>Source code for openvino_xai.common.utils</h1><div class="highlight"><pre>
 
 <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</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.utils.torch</span> <span class="kn">import</span> <span class="n">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>

releases/1.1.0/_modules/openvino_xai/methods/white_box/activation_map.html

@@ -402,12 +402,12 @@ <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>
 <span class="kn">from</span> <span class="nn">openvino_xai.inserter.model_parser</span> <span class="kn">import</span> <span class="n">IRParserCls</span><span class="p">,</span> <span class="n">ModelType</span>
 <span class="kn">from</span> <span class="nn">openvino_xai.methods.white_box.base</span> <span class="kn">import</span> <span class="n">WhiteBoxMethod</span>
+<span class="kn">from</span> <span class="nn">openvino_xai.utils.torch</span> <span class="kn">import</span> <span class="n">torch</span>
 
 
 <div class="viewcode-block" id="ActivationMap">

releases/1.1.0/_modules/openvino_xai/methods/white_box/base.html

@@ -401,7 +401,6 @@ <h1>Source code for openvino_xai.methods.white_box.base</h1><div class="highligh
 <span class="kn">import</span> <span class="nn">copy</span>
 <span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">abstractmethod</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span>
-<span class="kn">from</span> <span class="nn">venv</span> <span class="kn">import</span> <span class="n">logger</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>
@@ -411,6 +410,7 @@ <h1>Source code for openvino_xai.methods.white_box.base</h1><div class="highligh
     <span class="n">SALIENCY_MAP_OUTPUT_NAME</span><span class="p">,</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="p">,</span>
 <span class="p">)</span>
 <span class="kn">from</span> <span class="nn">openvino_xai.inserter.inserter</span> <span class="kn">import</span> <span class="n">insert_xai_branch_into_model</span>
 <span class="kn">from</span> <span class="nn">openvino_xai.methods.base</span> <span class="kn">import</span> <span class="n">MethodBase</span>

releases/1.1.0/_modules/openvino_xai/methods/white_box/recipro_cam.html

@@ -404,12 +404,12 @@ <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>
 <span class="kn">from</span> <span class="nn">openvino_xai.inserter.model_parser</span> <span class="kn">import</span> <span class="n">IRParserCls</span><span class="p">,</span> <span class="n">ModelType</span>
 <span class="kn">from</span> <span class="nn">openvino_xai.methods.white_box.base</span> <span class="kn">import</span> <span class="n">WhiteBoxMethod</span>
+<span class="kn">from</span> <span class="nn">openvino_xai.utils.torch</span> <span class="kn">import</span> <span class="n">torch</span>
 
 
 <div class="viewcode-block" id="FeatureMapPerturbationBase">

releases/1.1.0/getting-started.html

@@ -567,6 +567,15 @@ <h2>Installation<a class="headerlink" href="#installation" title="Link to this h
 </div>
 </details>
 <details>
+<summary>(Optional) Enable PyTorch support</summary>
+<p>You can enjoy the PyTorch XAI feature if the PyTorch is installed along with the OpenVINO XAI.</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install PyTorch (CPU version as example)</span>
+pip3<span class="w"> </span>install<span class="w"> </span>torch<span class="w"> </span>--index-url<span class="w"> </span>https://download.pytorch.org/whl/cpu
+</pre></div>
+</div>
+<p>Please refer to the <a class="reference external" href="https://pytorch.org/get-started/locally/">PyTorch Installation Guide</a> for other options.</p>
+</details>
+<details>
 <summary>Verify installation</summary>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Run tests</span>
 pytest<span class="w"> </span>-v<span class="w"> </span>-s<span class="w"> </span>./tests/unit