From 4c66205eb5ba4b292c477cc551df75f045b27a16 Mon Sep 17 00:00:00 2001
From: Wolfgang Meier <wolfgang.meier@fau.de>
Date: Mon, 12 Jul 2021 20:46:25 +0200
Subject: [PATCH] Update documentation (#222)

* update documentation

* add documentation page 'about this docuemntation'

* update about documentation
---
 docs/About this Documentation.html            | 236 ++++++++++++++++++
 docs/Architecture.html                        |   1 +
 docs/Backend.html                             |   1 +
 docs/Build & Deploy.html                      |   5 +-
 docs/Description.html                         |   1 +
 docs/License.html                             |   5 +-
 docs/Source Code Documentation.html           |   1 +
 docs/User Documentation.html                  |   1 +
 docs/Webservice.html                          |   1 +
 .../_sources/About this Documentation.rst.txt |  27 ++
 docs/_sources/Build & Deploy.rst.txt          |   6 +-
 docs/_sources/index.rst.txt                   |   1 +
 docs/app.html                                 |   1 +
 docs/colorization.atlas_utils.html            |   1 +
 docs/colorization.atlas_utils.lib.html        |   5 +-
 docs/colorization.html                        |   1 +
 docs/genindex.html                            |   1 +
 docs/index.html                               |   2 +
 docs/modules.html                             |   1 +
 docs/objects.inv                              | Bin 1193 -> 1210 bytes
 docs/py-modindex.html                         |   1 +
 docs/search.html                              |   1 +
 docs/searchindex.js                           |   2 +-
 docs/test_web.html                            |   1 +
 scripts/generate_documentation.sh             |   6 +-
 sphinx/source/About this Documentation.rst    |  27 ++
 sphinx/source/Build & Deploy.rst              |   6 +-
 sphinx/source/index.rst                       |   1 +
 28 files changed, 334 insertions(+), 9 deletions(-)
 create mode 100644 docs/About this Documentation.html
 create mode 100644 docs/_sources/About this Documentation.rst.txt
 create mode 100644 sphinx/source/About this Documentation.rst
diff --git a/docs/About this Documentation.html b/docs/About this Documentation.html
new file mode 100644
index 0000000..2f6fbfe
--- /dev/null
+++ b/docs/About this Documentation.html	
@@ -0,0 +1,236 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  
+  <title>About this Documentation &mdash; Neural Network Enablement  documentation</title>
+  
+
+  
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+
+  
+  
+
+  
+  
+
+  
+
+  
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+  
+    
+      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/jquery.js"></script>
+        <script src="_static/underscore.js"></script>
+        <script src="_static/doctools.js"></script>
+    
+    <script type="text/javascript" src="_static/js/theme.js"></script>
+
+    
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="License" href="License.html" />
+    <link rel="prev" title="colorization.atlas_utils.lib package" href="colorization.atlas_utils.lib.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+   
+  <div class="wy-grid-for-nav">
+    
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+          
+
+          
+            <a href="index.html" class="icon icon-home"> Neural Network Enablement
+          
+
+          
+          </a>
+
+          
+            
+            
+          
+
+          
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+          
+        </div>
+
+        
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+          
+            
+            
+              
+            
+            
+              <p class="caption"><span class="caption-text">Table Of Contents:</span></p>
+<ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="Description.html">Neural Network Enablement</a></li>
+<li class="toctree-l1"><a class="reference internal" href="User%20Documentation.html">User Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">About this Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
+</ul>
+
+            
+          
+        </div>
+        
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      
+      <nav class="wy-nav-top" aria-label="top navigation">
+        
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">Neural Network Enablement</a>
+        
+      </nav>
+
+
+      <div class="wy-nav-content">
+        
+        <div class="rst-content">
+        
+          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+    
+      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
+        
+      <li>About this Documentation</li>
+    
+    
+      <li class="wy-breadcrumbs-aside">
+        
+          
+            <a href="_sources/About this Documentation.rst.txt" rel="nofollow"> View page source</a>
+          
+        
+      </li>
+    
+  </ul>
+
+  
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+            
+  <div class="section" id="about-this-documentation">
+<h1>About this Documentation<a class="headerlink" href="#about-this-documentation" title="Permalink to this headline">¶</a></h1>
+<p><strong>Generating the documentation</strong></p>
+<p>We use sphinx to generate the documenation. It extracts doc-strings from the relevant python-files and combines them with the documentation from sphinx/source.</p>
+<p>The result is saved in the docs-folder. Don’t change anything here, as it will be overwritten when running the script.</p>
+<p>To generate the documentation run <cite>scripts/generate_documentation.sh</cite>.</p>
+<p><strong>Limitations</strong></p>
+<p>There are multiple errors that can occur during generating the documentation:</p>
+<ol class="arabic simple">
+<li><p>libatlasutil.so not found</p></li>
+</ol>
+<p>This error can be ignored.</p>
+<ol class="arabic simple" start="2">
+<li><p>modules.rst: WARNING: document isn’t included in any toctree</p></li>
+</ol>
+<p>This error can be ignored.</p>
+<ol class="arabic simple" start="3">
+<li><p>The extraction of the documentation for app.py fails</p></li>
+</ol>
+<p>Sphinx sometimes gets confused about relative imports. Removing the dots from the import-statements in all relevant python-files might help. (Only apply this change for generating the documentation)</p>
+</div>
+
+
+           </div>
+           
+          </div>
+          <footer>
+    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+        <a href="License.html" class="btn btn-neutral float-right" title="License" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="colorization.atlas_utils.lib.html" class="btn btn-neutral float-left" title="colorization.atlas_utils.lib package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &#169; Copyright 2021, Susmitha, Wolfgang, Xiangxiang, Emma, Yilin, Maximilian, Philipp.
+
+    </p>
+  </div>
+    
+    
+    
+    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    
+    provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+  
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+  
+  
+    
+   
+
+</body>
+</html>
\ No newline at end of file
diff --git a/docs/Architecture.html b/docs/Architecture.html
index dcb08ff..07a4cfa 100644
--- a/docs/Architecture.html
+++ b/docs/Architecture.html
@@ -94,6 +94,7 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/Backend.html b/docs/Backend.html
index b288503..2d3cea2 100644
--- a/docs/Backend.html
+++ b/docs/Backend.html
@@ -101,6 +101,7 @@
 </li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/Build & Deploy.html b/docs/Build & Deploy.html
index 97ef871..f48ab7b 100644
--- a/docs/Build & Deploy.html	
+++ b/docs/Build & Deploy.html	
@@ -94,6 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
@@ -203,7 +204,9 @@ <h1>Build &amp; Deploy<a class="headerlink" href="#build-deploy" title="Permalin
 <p><strong>OpenCV</strong></p>
 <p>OpenCV is automatically installed into the virtual environment, it doesn’t have to be available system-wide.</p>
 <p><strong>Setup</strong></p>
-<p>The script <cite>scripts/setup.sh</cite> sets up a virtual environment for python initially.</p>
+<p>The first step is to clone the repository from github:</p>
+<p><cite>git clone https://github.com/amosproj/amos-ss2021-neural-network-enablement</cite></p>
+<p>Then the script <cite>scripts/setup.sh</cite> sets up a virtual environment for python.</p>
 <p>If the environment is set up already, it updates the dependencies.</p>
 <p><strong>Build</strong></p>
 <p>There is no explicit build step. It can be run directly after a successful setup.</p>
diff --git a/docs/Description.html b/docs/Description.html
index c441a91..170b888 100644
--- a/docs/Description.html
+++ b/docs/Description.html
@@ -94,6 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/License.html b/docs/License.html
index f17e942..2aa3da0 100644
--- a/docs/License.html
+++ b/docs/License.html
@@ -41,7 +41,7 @@
     
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="colorization.atlas_utils.lib package" href="colorization.atlas_utils.lib.html" /> 
+    <link rel="prev" title="About this Documentation" href="About%20this%20Documentation.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -93,6 +93,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">License</a></li>
 </ul>
 
@@ -188,7 +189,7 @@ <h1>License<a class="headerlink" href="#license" title="Permalink to this headli
           </div>
           <footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-        <a href="colorization.atlas_utils.lib.html" class="btn btn-neutral float-left" title="colorization.atlas_utils.lib package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="About%20this%20Documentation.html" class="btn btn-neutral float-left" title="About this Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
 
   <hr/>
diff --git a/docs/Source Code Documentation.html b/docs/Source Code Documentation.html
index 7847fbc..1d26a2f 100644
--- a/docs/Source Code Documentation.html	
+++ b/docs/Source Code Documentation.html	
@@ -98,6 +98,7 @@
 <li class="toctree-l2"><a class="reference internal" href="Backend.html">Backend colorization</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/User Documentation.html b/docs/User Documentation.html
index 32dd86d..762e21f 100644
--- a/docs/User Documentation.html	
+++ b/docs/User Documentation.html	
@@ -94,6 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/Webservice.html b/docs/Webservice.html
index df837c4..50c8ca5 100644
--- a/docs/Webservice.html
+++ b/docs/Webservice.html
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="Backend.html">Backend colorization</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/_sources/About this Documentation.rst.txt b/docs/_sources/About this Documentation.rst.txt
new file mode 100644
index 0000000..061f241
--- /dev/null
+++ b/docs/_sources/About this Documentation.rst.txt	
@@ -0,0 +1,27 @@
+About this Documentation
+========================
+
+**Generating the documentation**
+
+We use sphinx to generate the documenation. It extracts doc-strings from the relevant python-files and combines them with the documentation from sphinx/source.
+
+The result is saved in the docs-folder. Don't change anything here, as it will be overwritten when running the script.
+
+To generate the documentation run `scripts/generate_documentation.sh`.
+
+
+**Limitations**
+
+There are multiple errors that can occur during generating the documentation:
+
+1. libatlasutil.so not found
+
+This error can be ignored.
+
+2. modules.rst: WARNING: document isn't included in any toctree
+
+This error can be ignored.
+
+3. The extraction of the documentation for app.py fails
+
+Sphinx sometimes gets confused about relative imports. Removing the dots from the import-statements in all relevant python-files might help. (Only apply this change for generating the documentation)
diff --git a/docs/_sources/Build & Deploy.rst.txt b/docs/_sources/Build & Deploy.rst.txt
index af6f72d..d79e14e 100644
--- a/docs/_sources/Build & Deploy.rst.txt	
+++ b/docs/_sources/Build & Deploy.rst.txt	
@@ -64,7 +64,11 @@ OpenCV is automatically installed into the virtual environment, it doesn't have
 
 **Setup**
 
-The script `scripts/setup.sh` sets up a virtual environment for python initially.
+The first step is to clone the repository from github:
+
+`git clone https://github.com/amosproj/amos-ss2021-neural-network-enablement`
+
+Then the script `scripts/setup.sh` sets up a virtual environment for python.
 
 If the environment is set up already, it updates the dependencies.
 
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
index 0a6a534..a24aed0 100644
--- a/docs/_sources/index.rst.txt
+++ b/docs/_sources/index.rst.txt
@@ -14,6 +14,7 @@ Welcome to Neural Network Enablement's documentation!
    Architecture
    Build & Deploy
    Source Code Documentation
+   About this Documentation
    License
 
 
diff --git a/docs/app.html b/docs/app.html
index d6aaf52..3c2eba0 100644
--- a/docs/app.html
+++ b/docs/app.html
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="Backend.html">Backend colorization</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/colorization.atlas_utils.html b/docs/colorization.atlas_utils.html
index 11e7b94..cdf8948 100644
--- a/docs/colorization.atlas_utils.html
+++ b/docs/colorization.atlas_utils.html
@@ -94,6 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/colorization.atlas_utils.lib.html b/docs/colorization.atlas_utils.lib.html
index 75d5347..f0087e5 100644
--- a/docs/colorization.atlas_utils.lib.html
+++ b/docs/colorization.atlas_utils.lib.html
@@ -41,7 +41,7 @@
     
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="License" href="License.html" />
+    <link rel="next" title="About this Documentation" href="About%20this%20Documentation.html" />
     <link rel="prev" title="colorization.atlas_utils package" href="colorization.atlas_utils.html" /> 
 </head>
 
@@ -94,6 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
@@ -192,7 +193,7 @@ <h2>colorization.atlas_utils.lib.libatlasutil module<a class="headerlink" href="
           </div>
           <footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-        <a href="License.html" class="btn btn-neutral float-right" title="License" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="About%20this%20Documentation.html" class="btn btn-neutral float-right" title="About this Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
         <a href="colorization.atlas_utils.html" class="btn btn-neutral float-left" title="colorization.atlas_utils package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
 
diff --git a/docs/colorization.html b/docs/colorization.html
index 524520b..fb2d11a 100644
--- a/docs/colorization.html
+++ b/docs/colorization.html
@@ -94,6 +94,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/genindex.html b/docs/genindex.html
index c693ce9..02804fa 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -92,6 +92,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/index.html b/docs/index.html
index ee55419..bfbb2fc 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -93,6 +93,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
@@ -176,6 +177,7 @@ <h1>Welcome to Neural Network Enablement’s documentation!<a class="headerlink"
 <li class="toctree-l2"><a class="reference internal" href="Backend.html">Backend colorization</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 </div>
diff --git a/docs/modules.html b/docs/modules.html
index 8ddb0fc..70ecbe4 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -92,6 +92,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/objects.inv b/docs/objects.inv
index 1e1c39cedfd454e89cbb88fe44ba24e923c98deb..df4f31a7771c651c14822fda9b07c46437d21ede 100644
GIT binary patch
delta 1079
zcmV-71jzfT3Azc8l7AIVdRrseLl3#_W*Z<twpd`3=19=g*d~@D339ZKd+KZS_4*_w
zMM<VC%lfdDlWg)ozacpzjzm$d6TSbCsWcamyi2Io%PnT&*U)nFCb?PoHY$YIt#iqc
zE1A4MC@Tq5LK*%y^yyL%fW4{>Ab}qU(t5!Fv7}iqbW3F_fPa87%JgZuOyNhL$biiS
z_Nj6$6itVzASG)qdS~)V1rN%;d6!|KSgvCo>bRp7^F}8{K`qIV3)@YIM1yHd$^_vV
z-N0Pj<sB2BD+kO8tXrS+{E^@#Augi{DP{n;Rp}faIK$wAA{xHR-3@eoFI;k*c_JZr
z^G{_5^u@q>c7I1)TBMQzS?$RxU$4Q;xqPv=qOaa7euhVxXL?VlF?2tpOQyUNOQilO
zo=~~l_m#6bS23kX=fs0Wqvl*GRI5FLy_N^2imbwGR};Zk!-!6Jo?1Q25N#9#YbO@Y
zV~l&Ka61G@c3iRB$bObq7Ng-^N;5DS=BDo|U}+wntbZmf))8g-=>I>((3ACh(2$N`
z!z$`Ta$gmlh#gcpC$fiC%SmvTSAMC-E{EnC1eY)|mn!o^p4U&A<5If~dgUpo@gTQ-
z;?!-Vuw8yC{ZaAN{U3QhoI+fdR40iR@S7eR>ysn|Y97>1UI}KA)Dgtp*>XRbTW7|#
zxS95E%73Jt!{Z%1m3jQNO2g5)(;!?Ub(+8nGN%c;EOCxmE)Et!Uq1#BJ1XR};OokM
z3H@0Mj(0MB1hWY)J}L88mGPsqsT+5V)H*}IAkWTFFH5?!;3|xn?<6!&xgu1im+Ur!
z{8=w5{jH74W_MWdZ`X!qU`e>#PV!k8)$d&6%YSWczdRnrxRQV1bjEHfusb+YiSg<W
z;uL|~LGz8PYHTfV-EmJXXRRvKwCgZ9voj2{Z{PdF>`va@LrtS6gsJw26Z0w7Tq0~t
z5xo-yU?Qk}V~zl2luM#77|G#4{fzb9O68c~mfPe(u{;Bb;Sk(n`XN;;xp|)ynzy&_
zyno7F8oGkyIfiXH0>j)u!!~NKwD**~fJ|dq*%TC2e|$?V?sG2E<hSGj+_d%$Ti@fx
z_4f96Kf0p7a`ga~8Lp3K6g3CspO72sFSt|YCHX_rl>k4<#TWM&ENx>>WmDzjS>?t(
zDt~mZblqzhL~eXu*0qS=ESPSD@9nbu4u31xTb$5E7KheKN41Ux)i)6TBMI9^^HWHq
zZEbK#^P`CinoHL1Zz5f&<3p^Z`>RTii{fZ&h@0wUD>;8iR=V4O44=6?TF?~;53gDS
z=(GR1ILOKoM2hbq+`9@SsJfHwzkmL<NgBuZmxYVU3GaG;Q*{LVV<;|R93hg8B``0W
x+S6V{s2(3rd$*0qrYq}qeYR~HhPGhy9QvR9Le|AF8dqaSs{d8F_&@#1;$%YO7FqxR

delta 1062
zcmV+>1ljw#38@K?l7ALWdRrseLl3#_W*Z<twpd`3=19=g*d~@D36fgJJ@qyEdVP|T
zq9jw6^=;+i5Ar|1Avr^iK8R9C9Y3Tp$vB{Qh$yw*+m!zrT5jH;o0V@PoO|6i6Vx&(
z(EF3Jlu*f~W`9GUE&&d<SG5C+;fDobykLM>khB-NCnDj1L4Rwh`?O3X@S{(p!DQU_
zsWQbSNrtH)!CS_AXYxuo3(CHE7hxf`SjQ^VaYrNOwN7F=F*vh~n|4AZ8cbUg$}vmH
z4wmAs?<oIVI-pKq-1>C$M}pTFyNt#-p8?ptOqTG#s0}WNwVG`*w}Gzjg$ZUCo=6DZ
z@>4kgdC{<4+<y@h#u7mRZ;p7AZMUG8T)x;_-dCL!Kf|NQQgy^cYjRxBC6(TZ!9x8M
zPgc6^`^xB&tC$c=mc)axS}wU#R&I_K%(XmFnP-)~b~WK_GmPkj-PH101}iNo7&EbO
zo@3lag*zcY(DRDjME0|kG&UOET$+Z-FgJZy0SohRWq&ncvCb&#NB{pRhF+}SgNAel
z8&**#lKZOYMC_o-IgvfAT26wyyz)yub~zMNz?p!Fxm22;^1Qmr9GBWn&?`$ojt9Bp
z(@s4`a@+N%!XM#Z-T#sM;SyqAQe7k(u;0|!SYISrAo@Wb#Fb#i;wpmn&{^&$bF0j_
z7B^M?PJbCUb9lUiry`HPmT5RTcWQ)dq)r_;BXjDYd5Lq*a&a&g)b(Q!v7<u12)?T9
zbLh{CGkYhJN6@?A;*->Wl^H)eo7!>LNUaX~j6Cb0&P%#Za2dwbcVdzyOkyIEIj7Aa
zf5wXne_Jin#U1AS+pQ)k7#zNCC;7~cs(Y^S<$t!aU!RX+T**IiT4OgA*dCmz#CY`w
zaq_?&pnk_yHZ~Tx>bNI{(MA=j+qD>UoD9S4n|ptl-NoHK)HJ$6m}-A|Vm`&12@5-&
zNAE%bm<Vca%n_iJFoD&Kk(?f=cUa$Px@Q)s%`_lmlMjic=;l3&+jF(k-V^!)B8g>1
zQ-4sD{qa^<-Div^=r{BLZaBx9t?zkz`|j=S@9s17m#!YbP|Z}nw<43MIVk^xOcVcQ
z4^qFNKLpuuNI}@u7kBw8Ol?j@Q|aSbX4+liess5D=t0uVn~`&mLFC5gWqz2kuq1sm
zpxY6?x6Sf9Y+P^tWG%8dwU#=fR4gdpU4Qr=C~WuoD~w3nIG9lVWrquzOS1NN8EvTZ
zhfk>eZAg!c{E^fUH{}y4)ctU)aJK^yUQc;6CmY}%UbY6%Xa93`k`*I}6yJfndkjEU
zwkO+v|NLuE636$Km5a&+@9KC{b_D!mC<<X5A(FKvFPfUuUPY)LA5TZO{YBlCaUZ8O
g-Pa96Td;W!{ZD=&t0ESSt9Fu9|H@qaA0D&GNhr(`WB>pF

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
index f6ac4ea..00013d0 100644
--- a/docs/py-modindex.html
+++ b/docs/py-modindex.html
@@ -95,6 +95,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/search.html b/docs/search.html
index 6f6ab2c..d01402c 100644
--- a/docs/search.html
+++ b/docs/search.html
@@ -95,6 +95,7 @@
 <li class="toctree-l1"><a class="reference internal" href="Architecture.html">Architecture</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Build%20%26%20Deploy.html">Build &amp; Deploy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Source%20Code%20Documentation.html">Source Code Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/docs/searchindex.js b/docs/searchindex.js
index 5d19f4f..4bdc59e 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["Architecture","Backend","Build & Deploy","Description","License","Source Code Documentation","User Documentation","Webservice","app","colorization","colorization.atlas_utils","colorization.atlas_utils.lib","index","modules","test_web"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["Architecture.rst","Backend.rst","Build & Deploy.rst","Description.rst","License.rst","Source Code Documentation.rst","User Documentation.rst","Webservice.rst","app.rst","colorization.rst","colorization.atlas_utils.rst","colorization.atlas_utils.lib.rst","index.rst","modules.rst","test_web.rst"],objects:{"":{app:[8,0,0,"-"],colorization:[9,0,0,"-"],test_web:[14,0,0,"-"]},"colorization.atlas_utils":{acl_image:[10,0,0,"-"],constants:[10,0,0,"-"],lib:[11,0,0,"-"]},"colorization.atlas_utils.acl_image":{AclImage:[10,2,1,""]},"colorization.atlas_utils.acl_image.AclImage":{__del__:[10,3,1,""],__dict__:[10,4,1,""],__init__:[10,3,1,""],__module__:[10,4,1,""],__weakref__:[10,4,1,""],_instance_by_buffer:[10,3,1,""],_instance_by_image_file:[10,3,1,""],_instance_by_numpy_array:[10,3,1,""],copy_as_nparray:[10,3,1,""],copy_to_device:[10,3,1,""],data:[10,3,1,""],destroy:[10,3,1,""],tobytes:[10,3,1,""]},"colorization.colorize_process":{inference:[9,1,1,""],postprocess:[9,1,1,""],preprocess:[9,1,1,""]},"colorization.model_processor":{ModelProcessor:[9,2,1,""]},"colorization.model_processor.ModelProcessor":{__dict__:[9,4,1,""],__init__:[9,3,1,""],__module__:[9,4,1,""],__weakref__:[9,4,1,""],predict:[9,3,1,""]},"colorization.pipeline":{colorize_image:[9,1,1,""],colorize_video:[9,1,1,""]},"colorization.tests":{FunctionalTest:[9,2,1,""],PipelineTests:[9,2,1,""],SplitAndMergeTestsForVideo:[9,2,1,""]},"colorization.tests.FunctionalTest":{__module__:[9,4,1,""],setUp:[9,3,1,""],tearDown:[9,3,1,""],test_colorize_twice:[9,3,1,""],test_colorize_video:[9,3,1,""],test_complete_colorize_image:[9,3,1,""]},"colorization.tests.PipelineTests":{__module__:[9,4,1,""],setUp:[9,3,1,""],tearDown:[9,3,1,""],test_step_colorize_image:[9,3,1,""],test_step_postprocess_image:[9,3,1,""],test_step_preprocess_image:[9,3,1,""]},"colorization.tests.SplitAndMergeTestsForVideo":{__module__:[9,4,1,""],setUp:[9,3,1,""],tearDown:[9,3,1,""],test_step_merge_audio_and_video:[9,3,1,""],test_step_split_audio_from_video:[9,3,1,""],test_step_video2frames_frames2video:[9,3,1,""]},"colorization.videodata":{frames2video:[9,1,1,""],merge_audio_and_video:[9,1,1,""],split_audio_from_video:[9,1,1,""],video2frames:[9,1,1,""]},"test_web.BasicTests":{__module__:[14,4,1,""],setUp:[14,3,1,""],tearDown:[14,3,1,""],test_colorize:[14,3,1,""],test_delete:[14,3,1,""],test_integration_image:[14,3,1,""],test_integration_video:[14,3,1,""],test_main_page:[14,3,1,""],test_upload:[14,3,1,""]},app:{"delete":[8,1,1,""],all:[8,1,1,""],colorize:[8,1,1,""],get_extension:[8,1,1,""],get_name:[8,1,1,""],handle_error:[8,1,1,""],index:[8,1,1,""],result:[8,1,1,""],upload:[8,1,1,""],uploaded_file:[8,1,1,""],valid_filename:[8,1,1,""]},colorization:{atlas_utils:[10,0,0,"-"],colorize_process:[9,0,0,"-"],model_processor:[9,0,0,"-"],pipeline:[9,0,0,"-"],tests:[9,0,0,"-"],videodata:[9,0,0,"-"]},test_web:{BasicTests:[14,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0":[9,10],"04":10,"06":10,"1":[2,6,9],"103":2,"119":2,"12":10,"13":10,"14":10,"2":6,"20":10,"200":3,"200dk":[2,3],"2020":10,"2021":4,"3":[2,6,9],"4":[2,6],"45":10,"5":[2,6],"50":9,"6":10,"7":2,"8":10,"case":[9,14],"class":[9,10,14],"default":2,"do":[4,6],"export":2,"function":[3,6,8,9,10],"import":6,"int":9,"return":[8,9,14],"static":2,"while":6,A:4,AND:4,AS:4,BE:4,BUT:4,FOR:4,IN:4,IS:4,If:[2,6],It:[2,6,9],NO:4,NOT:4,OF:4,OR:4,One:2,THE:4,TO:4,That:2,The:[2,3,4,6,9],There:2,To:[2,6],WITH:4,__annotations__:[9,10],__del__:10,__dict__:[9,10],__doc__:[9,10],__init__:[9,10],__module__:[9,10,14],__weakref__:[9,10],_instance_by_buff:10,_instance_by_image_fil:10,_instance_by_numpy_arrai:10,ab:9,abov:4,accept:8,accur:[9,10],acl_imag:[1,9,13],acl_model:[1,5,13],acl_resourc:[1,5,13],aclimag:10,action:[4,6],activ:9,add:9,addit:2,ae03d92b:2,after:[2,6,9],again:6,all:[2,4,8,9,10],allow:3,alreadi:[2,9],also:2,amo:4,an:[2,4,6,9],ani:4,anoth:6,app:[5,7,14],applic:[3,14],approx:6,apt:2,ar:[2,6],architectur:[2,12],arg:9,aris:4,arm:2,arrai:9,ascend_ddk:2,associ:4,atla:[2,3],atlas_util:[1,5,9,13],atlasutil_so:[9,10],attach:3,attribut:[9,10],audio:[2,9],audio_input_path:9,audio_output_path:9,author:4,automat:2,avail:[2,14],avoid:6,back:9,backend:[5,12],base:[9,10,14],basictest:14,befor:[6,9],below:[2,6],bgr:9,bin:2,black:[3,6],blog:2,board:2,browser:2,build:12,buttom:6,button:6,c:4,call:[6,9],can:[2,6,9],caus:6,cd:2,center:9,cflag:2,channel:9,charg:4,check:[2,8,14],check_acl_libari:2,claim:4,click:6,clone:2,close:6,code:[2,10,12],codec:2,color:[3,5,6,8,12,14],colorize_imag:9,colorize_process:[1,5,13],colorize_video:9,com:10,combin:9,comparison:6,complet:9,comput:2,condit:4,config:8,configur:[2,3],connect:4,consist:9,constant:[1,9,13],constraint:3,contain:9,content:[1,5,13],continu:6,contract:4,convert:9,copi:4,copy_as_nparrai:10,copy_to_devic:10,copyright:[4,10],core:3,corner:6,could:6,creat:[10,14],current:6,da:2,damag:4,data:10,deal:4,deconstruct:9,dedic:3,defin:[9,10],delet:[6,8,14],depend:2,deploi:12,descript:3,destroi:10,dev:2,differ:2,directli:[2,9],directori:9,disabl:2,displai:[3,8],distribut:4,dk:3,doc:9,document:4,doe:9,doesn:2,done:2,down:14,downsiz:9,drag:6,drop:6,e:[8,9],each:[6,9],enabl:2,endpoint:8,enjoi:6,environ:2,eu:2,event:4,execut:2,exercis:9,exist:[3,9],explicit:2,express:4,extract:9,fail:[9,14],failur:9,few:6,ffmpeg:2,file:[4,8,9],filenam:[8,9],fit:4,fixtur:9,flag:2,folder:[8,9,14],follow:[2,4,6],format:6,fpath:8,frames2video:9,framework:3,free:4,from:[2,4,6,9],fun:6,functionaltest:9,furnish:4,further:[3,8],germani:3,get:[6,9],get_extens:8,get_nam:8,git:2,given:[8,9],goal:3,gpl:2,grai:9,grant:4,guid:2,ha:[2,9],handle_error:8,hardwar:3,have:[2,3,6],height:10,heiko:3,help:[9,10],herebi:4,holder:4,home:[2,9],hook:9,html:[8,9],http:[2,9],huawei:[3,10],hwhiaiuser:2,i:[2,9],id:8,imag:[3,6,8,9,10,14],image_buff:10,image_fil:9,image_input_folder_path:9,image_input_path:9,image_output_folder_path:9,image_output_path:9,image_path:10,impli:4,includ:[2,4],index:[8,12],industri:3,infer:9,inference_result:9,inform:9,initi:[2,9,10],input:[3,9],input_imag:9,instal:2,integr:14,interpret:2,issu:6,item:6,its:8,j8:2,javascript:8,jpeg:6,jpg:[6,9],json:8,just:6,kind:4,l:[2,9],l_channel:9,lab:9,ldflag:2,left:6,liabil:4,liabl:4,lib:[2,9,10],libatlasutil:[9,10],libmp3lam:2,libopu:2,librari:[2,9],libtheora:2,libvorbi:2,libvpx:2,libx264:2,licens:12,like:6,limit:4,linux:3,list:[8,9,10],load:9,local:2,locat:[2,8],lot:6,main:[3,8,14],make:2,mappingproxi:[9,10],mean:9,mediat:3,memory_typ:10,merchant:4,merg:[4,9],merge_audio_and_video:9,method:9,methodnam:[9,14],mge:9,min:6,minut:6,mit:4,model:9,model_input:9,model_path:9,model_processor:[1,5,13],modelheight:9,modelprocessor:9,modelwidth:9,modifi:[4,10],modul:[1,5,7,12,13],more:[6,9],mp4:6,name:8,need:[2,3,6],netella:6,network:2,neural:2,none:[9,10],noninfring:4,notic:[4,6],npy:9,numpi:9,object:[9,10],obtain:[4,9],offlin:9,om:9,onc:6,one:[2,6],onli:6,onto:3,open:[2,6],opencv:2,oper:14,org:[2,9],origin:[6,9],other:4,otherwis:4,our:6,out:4,output:[3,9],packag:[1,5,13],page:[2,6,12,14],param:9,paramet:9,part:9,particular:4,partner:3,path:[8,9],patient:6,pdf:2,permiss:4,permit:4,person:4,pic1:9,pic1_color:9,pic:2,pictur:[9,14],pipelin:[1,5,13],pipelinetest:9,pleas:6,png:6,portion:4,postprocess:9,predict:9,prefix:2,preprocess:9,prerequisit:2,print:2,process:[2,6,8,9],product:6,project:[3,4],provid:[3,4,8],publish:4,purpos:4,pyacl:2,python3:2,python:[2,3,9],r:10,recommend:6,refer:[9,10],remov:14,repeat:6,reserv:10,resiz:9,resourc:3,rest:6,restrict:4,result:[6,8,9],right:[4,6,10],run:2,run_mod:10,runtest:[9,14],s:6,same:6,scalabl:2,scaleabl:2,schick:3,schihei:2,script:2,search:12,sec:6,second:6,see:[2,6,9,10],self:[9,10],sell:4,servic:3,session:9,set:[2,9,14],setup:[2,9,14],sh:2,shall:[3,4],share:2,signatur:[9,10],sinc:2,singl:[8,9],situat:14,size:10,so:[4,6],softwar:[2,3,4],some:[2,6],somewhat:2,sourc:[2,9,12],specifi:[8,9],split:9,split_audio_from_video:9,splitandmergetestsforvideo:9,start:[2,8],step:[2,6],store:8,str:9,student:3,subject:4,sublicens:4,submodul:[1,5,13],subpackag:[1,5,13],substanti:4,subtask:9,subtract:9,success:[2,9],sudo:2,support:[2,6],system:[2,3],t:2,take:6,team:6,tear:14,teardown:[9,14],technolog:3,temporari:14,test:[1,2,5,13,14],test_color:14,test_colorize_twic:9,test_colorize_video:9,test_complete_colorize_imag:9,test_delet:14,test_integration_imag:14,test_integration_video:14,test_main_pag:14,test_step_colorize_imag:9,test_step_merge_audio_and_video:9,test_step_postprocess_imag:9,test_step_preprocess_imag:9,test_step_split_audio_from_video:9,test_step_video2frames_frames2video:9,test_upload:14,test_web:[5,7],testcas:[9,14],thi:[2,4,8,9],those:3,tobyt:10,togeth:9,tort:4,transfer:3,turn:3,twice:6,two:[6,9],type:[8,9,10],unit:[9,14],unittest:[9,14],up:[2,9,14],updat:2,upload:[3,6,8,14],upload_fold:8,uploaded_fil:8,upper:6,url:[2,8,14],us:[2,3,4,6,9],user:[9,12],usr:2,utf:10,util:[1,9,13],v6:2,valid:8,valid_filenam:8,valu:9,verifi:2,version:[2,8],via:8,video2fram:9,video:[2,3,6,8,9,14],video_input_path:9,video_output_path:9,videodata:[1,5,13],videolan:2,vinci:2,virtual:2,voic:9,wait:6,want:6,warranti:4,we:[2,6],weak:[9,10],web:[3,6,14],webm:6,webservic:[2,5,9,12,14],when:[2,6],whether:4,which:2,white:[3,6],whom:4,wide:2,width:10,window:6,wish:6,without:4,workstat:3,written:9,www:2,x264:2,xyz:9,yasm:2,you:6,your:6},titles:["Architecture","Backend colorization","Build &amp; Deploy","Neural Network Enablement","License","Source Code Documentation","User Documentation","Webservice","app module","colorization package","colorization.atlas_utils package","colorization.atlas_utils.lib package","Welcome to Neural Network Enablement\u2019s documentation!","colorization","test_web module"],titleterms:{Of:12,acl_imag:10,acl_model:9,acl_resourc:9,app:8,architectur:0,atlas_util:[10,11],atlasutil_so:11,backend:1,build:2,code:5,color:[1,9,10,11,13],colorize_process:9,constant:10,content:[9,10,11,12],deploi:2,document:[5,6,12],enabl:[3,12],indic:12,lib:11,libatlasutil:11,licens:4,model_processor:9,modul:[8,9,10,11,14],network:[3,12],neural:[3,12],packag:[9,10,11],pipelin:9,s:12,sourc:5,submodul:[9,10,11],subpackag:[9,10],tabl:12,test:9,test_web:14,user:6,util:10,videodata:9,webservic:7,welcom:12}})
\ No newline at end of file
+Search.setIndex({docnames:["About this Documentation","Architecture","Backend","Build & Deploy","Description","License","Source Code Documentation","User Documentation","Webservice","app","colorization","colorization.atlas_utils","colorization.atlas_utils.lib","index","modules","test_web"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["About this Documentation.rst","Architecture.rst","Backend.rst","Build & Deploy.rst","Description.rst","License.rst","Source Code Documentation.rst","User Documentation.rst","Webservice.rst","app.rst","colorization.rst","colorization.atlas_utils.rst","colorization.atlas_utils.lib.rst","index.rst","modules.rst","test_web.rst"],objects:{"":{app:[9,0,0,"-"],colorization:[10,0,0,"-"],test_web:[15,0,0,"-"]},"colorization.atlas_utils":{acl_image:[11,0,0,"-"],constants:[11,0,0,"-"],lib:[12,0,0,"-"]},"colorization.atlas_utils.acl_image":{AclImage:[11,2,1,""]},"colorization.atlas_utils.acl_image.AclImage":{__del__:[11,3,1,""],__dict__:[11,4,1,""],__init__:[11,3,1,""],__module__:[11,4,1,""],__weakref__:[11,4,1,""],_instance_by_buffer:[11,3,1,""],_instance_by_image_file:[11,3,1,""],_instance_by_numpy_array:[11,3,1,""],copy_as_nparray:[11,3,1,""],copy_to_device:[11,3,1,""],data:[11,3,1,""],destroy:[11,3,1,""],tobytes:[11,3,1,""]},"colorization.colorize_process":{inference:[10,1,1,""],postprocess:[10,1,1,""],preprocess:[10,1,1,""]},"colorization.model_processor":{ModelProcessor:[10,2,1,""]},"colorization.model_processor.ModelProcessor":{__dict__:[10,4,1,""],__init__:[10,3,1,""],__module__:[10,4,1,""],__weakref__:[10,4,1,""],predict:[10,3,1,""]},"colorization.pipeline":{colorize_image:[10,1,1,""],colorize_video:[10,1,1,""]},"colorization.tests":{FunctionalTest:[10,2,1,""],PipelineTests:[10,2,1,""],SplitAndMergeTestsForVideo:[10,2,1,""]},"colorization.tests.FunctionalTest":{__module__:[10,4,1,""],setUp:[10,3,1,""],tearDown:[10,3,1,""],test_colorize_twice:[10,3,1,""],test_colorize_video:[10,3,1,""],test_complete_colorize_image:[10,3,1,""]},"colorization.tests.PipelineTests":{__module__:[10,4,1,""],setUp:[10,3,1,""],tearDown:[10,3,1,""],test_step_colorize_image:[10,3,1,""],test_step_postprocess_image:[10,3,1,""],test_step_preprocess_image:[10,3,1,""]},"colorization.tests.SplitAndMergeTestsForVideo":{__module__:[10,4,1,""],setUp:[10,3,1,""],tearDown:[10,3,1,""],test_step_merge_audio_and_video:[10,3,1,""],test_step_split_audio_from_video:[10,3,1,""],test_step_video2frames_frames2video:[10,3,1,""]},"colorization.videodata":{frames2video:[10,1,1,""],merge_audio_and_video:[10,1,1,""],split_audio_from_video:[10,1,1,""],video2frames:[10,1,1,""]},"test_web.BasicTests":{__module__:[15,4,1,""],setUp:[15,3,1,""],tearDown:[15,3,1,""],test_colorize:[15,3,1,""],test_delete:[15,3,1,""],test_integration_image:[15,3,1,""],test_integration_video:[15,3,1,""],test_main_page:[15,3,1,""],test_upload:[15,3,1,""]},app:{"delete":[9,1,1,""],all:[9,1,1,""],colorize:[9,1,1,""],get_extension:[9,1,1,""],get_name:[9,1,1,""],handle_error:[9,1,1,""],index:[9,1,1,""],result:[9,1,1,""],upload:[9,1,1,""],uploaded_file:[9,1,1,""],valid_filename:[9,1,1,""]},colorization:{atlas_utils:[11,0,0,"-"],colorize_process:[10,0,0,"-"],model_processor:[10,0,0,"-"],pipeline:[10,0,0,"-"],tests:[10,0,0,"-"],videodata:[10,0,0,"-"]},test_web:{BasicTests:[15,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method","4":"py:attribute"},terms:{"0":[10,11],"04":11,"06":11,"1":[3,7,10],"103":3,"119":3,"12":11,"13":11,"14":11,"2":7,"20":11,"200":4,"200dk":[3,4],"2020":11,"2021":5,"3":[3,7,10],"4":[3,7],"45":11,"5":[3,7],"50":10,"6":11,"7":3,"8":11,"case":[10,15],"class":[10,11,15],"default":3,"do":[5,7],"export":3,"function":[4,7,9,10,11],"import":[0,7],"int":10,"return":[9,10,15],"static":3,"while":7,A:5,AND:5,AS:5,BE:5,BUT:5,FOR:5,IN:5,IS:5,If:[3,7],It:[0,3,7,10],NO:5,NOT:5,OF:5,OR:5,One:3,THE:5,TO:5,That:3,The:[0,3,4,5,7,10],Then:3,There:[0,3],To:[0,3,7],WITH:5,__annotations__:[10,11],__del__:11,__dict__:[10,11],__doc__:[10,11],__init__:[10,11],__module__:[10,11,15],__weakref__:[10,11],_instance_by_buff:11,_instance_by_image_fil:11,_instance_by_numpy_arrai:11,ab:10,about:13,abov:5,accept:9,accur:[10,11],acl_imag:[2,10,14],acl_model:[2,6,14],acl_resourc:[2,6,14],aclimag:11,action:[5,7],activ:10,add:10,addit:3,ae03d92b:3,after:[3,7,10],again:7,all:[0,3,5,9,10,11],allow:4,alreadi:[3,10],also:3,amo:[3,5],amosproj:3,an:[3,5,7,10],ani:[0,5],anoth:7,anyth:0,app:[0,6,8,15],appli:0,applic:[4,15],approx:7,apt:3,ar:[0,3,7],architectur:[3,13],arg:10,aris:5,arm:3,arrai:10,ascend_ddk:3,associ:5,atla:[3,4],atlas_util:[2,6,10,14],atlasutil_so:[10,11],attach:4,attribut:[10,11],audio:[3,10],audio_input_path:10,audio_output_path:10,author:5,automat:3,avail:[3,15],avoid:7,back:10,backend:[6,13],base:[10,11,15],basictest:15,befor:[7,10],below:[3,7],bgr:10,bin:3,black:[4,7],blog:3,board:3,browser:3,build:13,buttom:7,button:7,c:5,call:[7,10],can:[0,3,7,10],caus:7,cd:3,center:10,cflag:3,chang:0,channel:10,charg:5,check:[3,9,15],check_acl_libari:3,claim:5,click:7,clone:3,close:7,code:[3,11,13],codec:3,color:[4,6,7,9,13,15],colorize_imag:10,colorize_process:[2,6,14],colorize_video:10,com:[3,11],combin:[0,10],comparison:7,complet:10,comput:3,condit:5,config:9,configur:[3,4],confus:0,connect:5,consist:10,constant:[2,10,14],constraint:4,contain:10,content:[2,6,14],continu:7,contract:5,convert:10,copi:5,copy_as_nparrai:11,copy_to_devic:11,copyright:[5,11],core:4,corner:7,could:7,creat:[11,15],current:7,da:3,damag:5,data:11,deal:5,deconstruct:10,dedic:4,defin:[10,11],delet:[7,9,15],depend:3,deploi:13,descript:4,destroi:11,dev:3,differ:3,directli:[3,10],directori:10,disabl:3,displai:[4,9],distribut:5,dk:4,doc:[0,10],documen:0,document:5,doe:10,doesn:3,don:0,done:3,dot:0,down:15,downsiz:10,drag:7,drop:7,dure:0,e:[9,10],each:[7,10],enabl:3,endpoint:9,enjoi:7,environ:3,error:0,eu:3,event:5,execut:3,exercis:10,exist:[4,10],explicit:3,express:5,extract:[0,10],fail:[0,10,15],failur:10,few:7,ffmpeg:3,file:[0,5,9,10],filenam:[9,10],first:3,fit:5,fixtur:10,flag:3,folder:[0,9,10,15],follow:[3,5,7],format:7,found:0,fpath:9,frames2video:10,framework:4,free:5,from:[0,3,5,7,10],fun:7,functionaltest:10,furnish:5,further:[4,9],gener:0,generate_document:0,germani:4,get:[0,7,10],get_extens:9,get_nam:9,git:3,github:3,given:[9,10],goal:4,gpl:3,grai:10,grant:5,guid:3,ha:[3,10],handle_error:9,hardwar:4,have:[3,4,7],height:11,heiko:4,help:[0,10,11],here:0,herebi:5,holder:5,home:[3,10],hook:10,html:[9,10],http:[3,10],huawei:[4,11],hwhiaiuser:3,i:[3,10],id:9,ignor:0,imag:[4,7,9,10,11,15],image_buff:11,image_fil:10,image_input_folder_path:10,image_input_path:10,image_output_folder_path:10,image_output_path:10,image_path:11,impli:5,includ:[0,3,5],index:[9,13],industri:4,infer:10,inference_result:10,inform:10,initi:[10,11],input:[4,10],input_imag:10,instal:3,integr:15,interpret:3,isn:0,issu:7,item:7,its:9,j8:3,javascript:9,jpeg:7,jpg:[7,10],json:9,just:7,kind:5,l:[3,10],l_channel:10,lab:10,ldflag:3,left:7,liabil:5,liabl:5,lib:[3,10,11],libatlasutil:[0,10,11],libmp3lam:3,libopu:3,librari:[3,10],libtheora:3,libvorbi:3,libvpx:3,libx264:3,licens:13,like:7,limit:[0,5],linux:4,list:[9,10,11],load:10,local:3,locat:[3,9],lot:7,main:[4,9,15],make:3,mappingproxi:[10,11],mean:10,mediat:4,memory_typ:11,merchant:5,merg:[5,10],merge_audio_and_video:10,method:10,methodnam:[10,15],mge:10,might:0,min:7,minut:7,mit:5,model:10,model_input:10,model_path:10,model_processor:[2,6,14],modelheight:10,modelprocessor:10,modelwidth:10,modifi:[5,11],modul:[0,2,6,8,13,14],more:[7,10],mp4:7,multipl:0,name:9,need:[3,4,7],netella:7,network:3,neural:3,none:[10,11],noninfring:5,notic:[5,7],npy:10,numpi:10,object:[10,11],obtain:[5,10],occur:0,offlin:10,om:10,onc:7,one:[3,7],onli:[0,7],onto:4,open:[3,7],opencv:3,oper:15,org:[3,10],origin:[7,10],other:5,otherwis:5,our:7,out:5,output:[4,10],overwritten:0,packag:[2,6,14],page:[3,7,13,15],param:10,paramet:10,part:10,particular:5,partner:4,path:[9,10],patient:7,pdf:3,permiss:5,permit:5,person:5,pic1:10,pic1_color:10,pic:3,pictur:[10,15],pipelin:[2,6,14],pipelinetest:10,pleas:7,png:7,portion:5,postprocess:10,predict:10,prefix:3,preprocess:10,prerequisit:3,print:3,process:[3,7,9,10],product:7,project:[4,5],provid:[4,5,9],publish:5,purpos:5,py:0,pyacl:3,python3:3,python:[0,3,4,10],r:11,recommend:7,refer:[10,11],rel:0,relev:0,remov:[0,15],repeat:7,repositori:3,reserv:11,resiz:10,resourc:4,rest:7,restrict:5,result:[0,7,9,10],right:[5,7,11],rst:0,run:[0,3],run_mod:11,runtest:[10,15],s:7,same:7,save:0,scalabl:3,scaleabl:3,schick:4,schihei:3,script:[0,3],search:13,sec:7,second:7,see:[3,7,10,11],self:[10,11],sell:5,servic:4,session:10,set:[3,10,15],setup:[3,10,15],sh:[0,3],shall:[4,5],share:3,signatur:[10,11],sinc:3,singl:[9,10],situat:15,size:11,so:[0,5,7],softwar:[3,4,5],some:[3,7],sometim:0,somewhat:3,sourc:[0,3,10,13],specifi:[9,10],sphinx:0,split:10,split_audio_from_video:10,splitandmergetestsforvideo:10,ss2021:3,start:[3,9],statement:0,step:[3,7],store:9,str:10,string:0,student:4,subject:5,sublicens:5,submodul:[2,6,14],subpackag:[2,6,14],substanti:5,subtask:10,subtract:10,success:[3,10],sudo:3,support:[3,7],system:[3,4],t:[0,3],take:7,team:7,tear:15,teardown:[10,15],technolog:4,temporari:15,test:[2,3,6,14,15],test_color:15,test_colorize_twic:10,test_colorize_video:10,test_complete_colorize_imag:10,test_delet:15,test_integration_imag:15,test_integration_video:15,test_main_pag:15,test_step_colorize_imag:10,test_step_merge_audio_and_video:10,test_step_postprocess_imag:10,test_step_preprocess_imag:10,test_step_split_audio_from_video:10,test_step_video2frames_frames2video:10,test_upload:15,test_web:[6,8],testcas:[10,15],them:0,thi:[3,5,9,10,13],those:4,tobyt:11,toctre:0,togeth:10,tort:5,transfer:4,turn:4,twice:7,two:[7,10],type:[9,10,11],unit:[10,15],unittest:[10,15],up:[3,10,15],updat:3,upload:[4,7,9,15],upload_fold:9,uploaded_fil:9,upper:7,url:[3,9,15],us:[0,3,4,5,7,10],user:[10,13],usr:3,utf:11,util:[2,10,14],v6:3,valid:9,valid_filenam:9,valu:10,verifi:3,version:[3,9],via:9,video2fram:10,video:[3,4,7,9,10,15],video_input_path:10,video_output_path:10,videodata:[2,6,14],videolan:3,vinci:3,virtual:3,voic:10,wait:7,want:7,warn:0,warranti:5,we:[0,3,7],weak:[10,11],web:[4,7,15],webm:7,webservic:[3,6,10,13,15],when:[0,3,7],whether:5,which:3,white:[4,7],whom:5,wide:3,width:11,window:7,wish:7,without:5,workstat:4,written:10,www:3,x264:3,xyz:10,yasm:3,you:7,your:7},titles:["About this Documentation","Architecture","Backend colorization","Build &amp; Deploy","Neural Network Enablement","License","Source Code Documentation","User Documentation","Webservice","app module","colorization package","colorization.atlas_utils package","colorization.atlas_utils.lib package","Welcome to Neural Network Enablement\u2019s documentation!","colorization","test_web module"],titleterms:{Of:13,about:0,acl_imag:11,acl_model:10,acl_resourc:10,app:9,architectur:1,atlas_util:[11,12],atlasutil_so:12,backend:2,build:3,code:6,color:[2,10,11,12,14],colorize_process:10,constant:11,content:[10,11,12,13],deploi:3,document:[0,6,7,13],enabl:[4,13],indic:13,lib:12,libatlasutil:12,licens:5,model_processor:10,modul:[9,10,11,12,15],network:[4,13],neural:[4,13],packag:[10,11,12],pipelin:10,s:13,sourc:6,submodul:[10,11,12],subpackag:[10,11],tabl:13,test:10,test_web:15,thi:0,user:7,util:11,videodata:10,webservic:8,welcom:13}})
\ No newline at end of file
diff --git a/docs/test_web.html b/docs/test_web.html
index b14e6d3..01ecc10 100644
--- a/docs/test_web.html
+++ b/docs/test_web.html
@@ -102,6 +102,7 @@
 <li class="toctree-l2"><a class="reference internal" href="Backend.html">Backend colorization</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="About%20this%20Documentation.html">About this Documentation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="License.html">License</a></li>
 </ul>
 
diff --git a/scripts/generate_documentation.sh b/scripts/generate_documentation.sh
index 59b9041..a549f1d 100755
--- a/scripts/generate_documentation.sh
+++ b/scripts/generate_documentation.sh
@@ -30,11 +30,15 @@ cd ..
 
 rm -r docs/*
 cp -r sphinx/build/html/* docs/
-cp -r sphinx/build/html/.buildinfo docs/
+
+cp sphinx/build/html/.buildinfo docs/
+cp sphinx/build/html/.nojekyll docs/
 
 # leave virtual environment
 deactivate
 
+echo "The HTML files were copied to the docs folder. The docs-folder is served by Github Pages."
+
 if [ $HOSTNAME != "davinci-mini" ]; then
     xdg-open docs/index.html
 fi
diff --git a/sphinx/source/About this Documentation.rst b/sphinx/source/About this Documentation.rst
new file mode 100644
index 0000000..061f241
--- /dev/null
+++ b/sphinx/source/About this Documentation.rst	
@@ -0,0 +1,27 @@
+About this Documentation
+========================
+
+**Generating the documentation**
+
+We use sphinx to generate the documenation. It extracts doc-strings from the relevant python-files and combines them with the documentation from sphinx/source.
+
+The result is saved in the docs-folder. Don't change anything here, as it will be overwritten when running the script.
+
+To generate the documentation run `scripts/generate_documentation.sh`.
+
+
+**Limitations**
+
+There are multiple errors that can occur during generating the documentation:
+
+1. libatlasutil.so not found
+
+This error can be ignored.
+
+2. modules.rst: WARNING: document isn't included in any toctree
+
+This error can be ignored.
+
+3. The extraction of the documentation for app.py fails
+
+Sphinx sometimes gets confused about relative imports. Removing the dots from the import-statements in all relevant python-files might help. (Only apply this change for generating the documentation)
diff --git a/sphinx/source/Build & Deploy.rst b/sphinx/source/Build & Deploy.rst
index af6f72d..d79e14e 100644
--- a/sphinx/source/Build & Deploy.rst	
+++ b/sphinx/source/Build & Deploy.rst	
@@ -64,7 +64,11 @@ OpenCV is automatically installed into the virtual environment, it doesn't have
 
 **Setup**
 
-The script `scripts/setup.sh` sets up a virtual environment for python initially.
+The first step is to clone the repository from github:
+
+`git clone https://github.com/amosproj/amos-ss2021-neural-network-enablement`
+
+Then the script `scripts/setup.sh` sets up a virtual environment for python.
 
 If the environment is set up already, it updates the dependencies.
 
diff --git a/sphinx/source/index.rst b/sphinx/source/index.rst
index 0a6a534..a24aed0 100644
--- a/sphinx/source/index.rst
+++ b/sphinx/source/index.rst
@@ -14,6 +14,7 @@ Welcome to Neural Network Enablement's documentation!
    Architecture
    Build & Deploy
    Source Code Documentation
+   About this Documentation
    License
 
 
