Skip to content

Commit

Permalink
doc build
Browse files Browse the repository at this point in the history
  • Loading branch information
@mattclifford1
mattclifford1 committed Oct 8, 2024
1 parent a480876 commit 416cf0f
Show file tree
Hide file tree
Showing 28 changed files with 1,141 additions and 826 deletions.
30 changes: 27 additions & 3 deletions docs/IQM_Vis.metrics.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,34 @@ Subpackages
Submodules
----------

IQM\_Vis.metrics.IQMs module
----------------------------
IQM\_Vis.metrics.metric\_utils module
-------------------------------------

.. automodule:: IQM_Vis.metrics.IQMs
.. automodule:: IQM_Vis.metrics.metric_utils
:members:
:undoc-members:
:show-inheritance:

IQM\_Vis.metrics.non\_perceptual module
---------------------------------------

.. automodule:: IQM_Vis.metrics.non_perceptual
:members:
:undoc-members:
:show-inheritance:

IQM\_Vis.metrics.perceptual\_DL module
--------------------------------------

.. automodule:: IQM_Vis.metrics.perceptual_DL
:members:
:undoc-members:
:show-inheritance:

IQM\_Vis.metrics.perceptual\_trad module
----------------------------------------

.. automodule:: IQM_Vis.metrics.perceptual_trad
:members:
:undoc-members:
:show-inheritance:
Expand Down
Binary file modified docs/_build/doctrees/IQM_Vis.metrics.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/IQM_Vis.transforms.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
5 changes: 4 additions & 1 deletion docs/_build/html/IQM_Vis.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,10 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics.IQMs">IQM_Vis.metrics.IQMs module</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics.metric_utils">IQM_Vis.metrics.metric_utils module</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics.non_perceptual">IQM_Vis.metrics.non_perceptual module</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics.perceptual_DL">IQM_Vis.metrics.perceptual_DL module</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics.perceptual_trad">IQM_Vis.metrics.perceptual_trad module</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics">Module contents</a></li>
</ul>
</li>
Expand Down
5 changes: 4 additions & 1 deletion docs/_build/html/IQM_Vis.metrics.SSIM.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics.IQMs">IQM_Vis.metrics.IQMs module</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics.metric_utils">IQM_Vis.metrics.metric_utils module</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics.non_perceptual">IQM_Vis.metrics.non_perceptual module</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics.perceptual_DL">IQM_Vis.metrics.perceptual_DL module</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics.perceptual_trad">IQM_Vis.metrics.perceptual_trad module</a></li>
<li class="toctree-l2"><a class="reference internal" href="IQM_Vis.metrics.html#module-IQM_Vis.metrics">Module contents</a></li>
</ul>
</li>
Expand Down
233 changes: 120 additions & 113 deletions docs/_build/html/IQM_Vis.metrics.html
View file

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/_build/html/IQM_Vis.transforms.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,14 +273,15 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this

<dl class="py function">
<dt class="sig sig-object py" id="IQM_Vis.transforms.effects.blur">
<span class="sig-prename descclassname"><span class="pre">IQM_Vis.transforms.effects.</span></span><span class="sig-name descname"><span class="pre">blur</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kernel_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">7</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/transforms/effects.html#blur"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.transforms.effects.blur" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">IQM_Vis.transforms.effects.</span></span><span class="sig-name descname"><span class="pre">blur</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kernel_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/transforms/effects.html#blur"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.transforms.effects.blur" title="Permalink to this definition"></a></dt>
<dd><p>Gaussian Blur on an image</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>image</strong> (<em>np.array</em>) – image to be rotated</p></li>
<li><p><strong>kernel_size</strong> (<em>int</em>) – size of the convolutional kernel, will be converted
to an odd number. (Defaults to 7)</p></li>
to an odd number. 1 is no blur.
(Defaults to 1)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
Expand Down Expand Up @@ -380,15 +381,15 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this

<dl class="py function">
<dt class="sig sig-object py" id="IQM_Vis.transforms.effects.jpeg_compression">
<span class="sig-prename descclassname"><span class="pre">IQM_Vis.transforms.effects.</span></span><span class="sig-name descname"><span class="pre">jpeg_compression</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">90</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/transforms/effects.html#jpeg_compression"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.transforms.effects.jpeg_compression" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">IQM_Vis.transforms.effects.</span></span><span class="sig-name descname"><span class="pre">jpeg_compression</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">image</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">101</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/IQM_Vis/transforms/effects.html#jpeg_compression"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#IQM_Vis.transforms.effects.jpeg_compression" title="Permalink to this definition"></a></dt>
<dd><p>encode image using jpeg then decode</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>image</strong> (<em>np.array</em>) – image to be compressed</p></li>
<li><p><strong>compression</strong> (<em>int</em>) – amount of jpeg compression, higher is better quality.
101 returns identity image.
(Defaults to 90)</p></li>
(Defaults to 101)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/_modules/IQM_Vis/UI/experiment_mode.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ <h1>Source code for IQM_Vis.UI.experiment_mode</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">ref_image_unprocessed</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_store</span><span class="o">.</span><span class="n">get_reference_unprocessed</span><span class="p">()</span>
<span class="c1"># get MSE for experiments to get a rough sorting</span>
<span class="n">mses</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">mse</span> <span class="o">=</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">MSE</span><span class="p">()</span>
<span class="n">mse</span> <span class="o">=</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">MSE</span><span class="p">()</span>
<span class="k">for</span> <span class="n">trans</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">experiment_trans_params</span><span class="p">:</span>
<span class="n">mses</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
<span class="n">mse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">ref_image</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_single_transform_im</span><span class="p">(</span><span class="n">trans</span><span class="p">)))</span>
Expand Down
10 changes: 5 additions & 5 deletions docs/_build/html/_modules/IQM_Vis/examples/dataset.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,15 +93,15 @@ <h1>Source code for IQM_Vis.examples.dataset</h1><div class="highlight"><pre>

<div class="viewcode-block" id="run"><a class="viewcode-back" href="../../../IQM_Vis.examples.html#IQM_Vis.examples.dataset.run">[docs]</a><span class="k">def</span> <span class="nf">run</span><span class="p">():</span>
<span class="c1"># metrics functions must return a single value</span>
<span class="n">metric</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;MAE&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">MAE</span><span class="p">(),</span>
<span class="s1">&#39;MSE&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">MSE</span><span class="p">(),</span>
<span class="s1">&#39;1-SSIM&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">SSIM</span><span class="p">()</span>
<span class="n">metric</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;MAE&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">MAE</span><span class="p">(),</span>
<span class="s1">&#39;MSE&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">MSE</span><span class="p">(),</span>
<span class="s1">&#39;1-SSIM&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">SSIM</span><span class="p">()</span>
<span class="p">}</span>

<span class="c1"># metrics images return a numpy image</span>
<span class="n">metric_images</span> <span class="o">=</span> <span class="p">{</span>
<span class="c1"># &#39;MSE&#39;: IQM_Vis.IQMs.MSE(return_image=True),</span>
<span class="c1"># &#39;SSIM&#39;: IQM_Vis.IQMs.SSIM(return_image=True)</span>
<span class="c1"># &#39;MSE&#39;: IQM_Vis.metrics.MSE(return_image=True),</span>
<span class="c1"># &#39;SSIM&#39;: IQM_Vis.metrics.SSIM(return_image=True)</span>
<span class="p">}</span>

<span class="c1"># make dataset list of images</span>
Expand Down
12 changes: 6 additions & 6 deletions docs/_build/html/_modules/IQM_Vis/examples/dists.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,12 +165,12 @@ <h1>Source code for IQM_Vis.examples.dists</h1><div class="highlight"><pre>

<div class="viewcode-block" id="run"><a class="viewcode-back" href="../../../IQM_Vis.examples.html#IQM_Vis.examples.dists.run">[docs]</a><span class="k">def</span> <span class="nf">run</span><span class="p">():</span>
<span class="c1"># metrics functions must return a single value</span>
<span class="n">metric</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;DISTS&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">DISTS</span><span class="p">(),</span>
<span class="s1">&#39;LPIPS&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">LPIPS</span><span class="p">(),</span>
<span class="s1">&#39;1-SSIM&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">SSIM</span><span class="p">(),</span>
<span class="s1">&#39;MAE&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">MAE</span><span class="p">(),</span>
<span class="c1"># &#39;1-MS_SSIM&#39;: IQM_Vis.IQMs.MS_SSIM(),</span>
<span class="c1"># &#39;NLPD&#39;: IQM_Vis.IQMs.NLPD(),</span>
<span class="n">metric</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;DISTS&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">DISTS</span><span class="p">(),</span>
<span class="s1">&#39;LPIPS&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">LPIPS</span><span class="p">(),</span>
<span class="s1">&#39;1-SSIM&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">SSIM</span><span class="p">(),</span>
<span class="s1">&#39;MAE&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">MAE</span><span class="p">(),</span>
<span class="c1"># &#39;1-MS_SSIM&#39;: IQM_Vis.metrics.MS_SSIM(),</span>
<span class="c1"># &#39;NLPD&#39;: IQM_Vis.metrics.NLPD(),</span>
<span class="p">}</span>

<span class="c1"># metrics images return a numpy image - dont include any for this example</span>
Expand Down
12 changes: 6 additions & 6 deletions docs/_build/html/_modules/IQM_Vis/examples/experiment.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,12 @@ <h1>Source code for IQM_Vis.examples.experiment</h1><div class="highlight"><pre>

<div class="viewcode-block" id="run"><a class="viewcode-back" href="../../../IQM_Vis.examples.html#IQM_Vis.examples.experiment.run">[docs]</a><span class="k">def</span> <span class="nf">run</span><span class="p">():</span>
<span class="c1"># metrics functions must return a single value</span>
<span class="n">metric</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;DISTS&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">DISTS</span><span class="p">(),</span>
<span class="s1">&#39;MAE&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">MAE</span><span class="p">(),</span>
<span class="s1">&#39;1-SSIM&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">SSIM</span><span class="p">(),</span>
<span class="c1"># &#39;1-MS_SSIM&#39;: IQM_Vis.IQMs.MS_SSIM(),</span>
<span class="s1">&#39;NLPD&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">IQMs</span><span class="o">.</span><span class="n">NLPD</span><span class="p">(),</span>
<span class="c1"># &#39;LPIPS&#39;: IQM_Vis.IQMs.LPIPS(),</span>
<span class="n">metric</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;DISTS&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">DISTS</span><span class="p">(),</span>
<span class="s1">&#39;MAE&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">MAE</span><span class="p">(),</span>
<span class="s1">&#39;1-SSIM&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">SSIM</span><span class="p">(),</span>
<span class="c1"># &#39;1-MS_SSIM&#39;: IQM_Vis.metrics.MS_SSIM(),</span>
<span class="s1">&#39;NLPD&#39;</span><span class="p">:</span> <span class="n">IQM_Vis</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">NLPD</span><span class="p">(),</span>
<span class="c1"># &#39;LPIPS&#39;: IQM_Vis.metrics.LPIPS(),</span>
<span class="p">}</span>

<span class="c1"># metrics images return a numpy image</span>
Expand Down
Loading

0 comments on commit 416cf0f

Please sign in to comment.