Update from NeoMedSys/gingerbread@1dba802

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 0c54bceddabfec7b9c2f956dbee70bed
+config: 3175533fcf8c4dd3677bca3b0aa1ce6f
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.5.3',
+    VERSION: '0.5.8',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

genindex.html

@@ -4,7 +4,7 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
 
-    <!-- Generated with Sphinx 6.2.1 and Furo 2022.12.07 --><title>Index - Gingerbread 0.5.3 documentation</title>
+    <!-- Generated with Sphinx 6.2.1 and Furo 2022.12.07 --><title>Index - Gingerbread 0.5.8 documentation</title>
 <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -121,7 +121,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Gingerbread 0.5.3 documentation</div></a>
+      <a href="index.html"><div class="brand">Gingerbread 0.5.8 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -147,7 +147,7 @@
     <img class="sidebar-logo" src="_static/63ecff6168e0e.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Gingerbread 0.5.3 documentation</span>
+  <span class="sidebar-brand-text">Gingerbread 0.5.8 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -308,7 +308,7 @@ <h2>D</h2>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="gingerbread.central_processing_handler.utils.html#gingerbread.central_processing_handler.utils.helpers.decode_payload">decode_payload() (in module gingerbread.central_processing_handler.utils.helpers)</a>
 </li>
-        <li><a href="gingerbread.central_processing_handler.utils.html#gingerbread.central_processing_handler.utils.helpers.decode_weights">decode_weights() (in module gingerbread.central_processing_handler.utils.helpers)</a>
+        <li><a href="gingerbread.central_processing_handler.utils.html#gingerbread.central_processing_handler.utils.helpers.decode_weights_pickled">decode_weights_pickled() (in module gingerbread.central_processing_handler.utils.helpers)</a>
 </li>
         <li><a href="gingerbread.html#gingerbread.data_download.MedqueryDataDownloader.download_data">download_data() (gingerbread.data_download.MedqueryDataDownloader method)</a>
 </li>

gingerbread.analytics.html

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="gingerbread.central_processing_handler package" href="gingerbread.central_processing_handler.html" /><link rel="prev" title="gingerbread package" href="gingerbread.html" />
 
     <!-- Generated with Sphinx 6.2.1 and Furo 2022.12.07 -->
-        <title>gingerbread.analytics package - Gingerbread 0.5.3 documentation</title>
+        <title>gingerbread.analytics package - Gingerbread 0.5.8 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Gingerbread 0.5.3 documentation</div></a>
+      <a href="index.html"><div class="brand">Gingerbread 0.5.8 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -149,7 +149,7 @@
     <img class="sidebar-logo" src="_static/63ecff6168e0e.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Gingerbread 0.5.3 documentation</span>
+  <span class="sidebar-brand-text">Gingerbread 0.5.8 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">

gingerbread.central_processing_handler.config.html

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="gingerbread.central_processing_handler.sql package" href="gingerbread.central_processing_handler.sql.html" /><link rel="prev" title="gingerbread.central_processing_handler package" href="gingerbread.central_processing_handler.html" />
 
     <!-- Generated with Sphinx 6.2.1 and Furo 2022.12.07 -->
-        <title>gingerbread.central_processing_handler.config package - Gingerbread 0.5.3 documentation</title>
+        <title>gingerbread.central_processing_handler.config package - Gingerbread 0.5.8 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Gingerbread 0.5.3 documentation</div></a>
+      <a href="index.html"><div class="brand">Gingerbread 0.5.8 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -149,7 +149,7 @@
     <img class="sidebar-logo" src="_static/63ecff6168e0e.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Gingerbread 0.5.3 documentation</span>
+  <span class="sidebar-brand-text">Gingerbread 0.5.8 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">

gingerbread.central_processing_handler.html

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="gingerbread.central_processing_handler.config package" href="gingerbread.central_processing_handler.config.html" /><link rel="prev" title="gingerbread.analytics package" href="gingerbread.analytics.html" />
 
     <!-- Generated with Sphinx 6.2.1 and Furo 2022.12.07 -->
-        <title>gingerbread.central_processing_handler package - Gingerbread 0.5.3 documentation</title>
+        <title>gingerbread.central_processing_handler package - Gingerbread 0.5.8 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Gingerbread 0.5.3 documentation</div></a>
+      <a href="index.html"><div class="brand">Gingerbread 0.5.8 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -149,7 +149,7 @@
     <img class="sidebar-logo" src="_static/63ecff6168e0e.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Gingerbread 0.5.3 documentation</span>
+  <span class="sidebar-brand-text">Gingerbread 0.5.8 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -275,7 +275,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
 <li class="toctree-l2"><a class="reference internal" href="gingerbread.central_processing_handler.utils.html#module-gingerbread.central_processing_handler.utils.helpers">gingerbread.central_processing_handler.utils.helpers module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="gingerbread.central_processing_handler.utils.html#gingerbread.central_processing_handler.utils.helpers.copy_obj"><code class="docutils literal notranslate"><span class="pre">copy_obj()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="gingerbread.central_processing_handler.utils.html#gingerbread.central_processing_handler.utils.helpers.decode_payload"><code class="docutils literal notranslate"><span class="pre">decode_payload()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="gingerbread.central_processing_handler.utils.html#gingerbread.central_processing_handler.utils.helpers.decode_weights"><code class="docutils literal notranslate"><span class="pre">decode_weights()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="gingerbread.central_processing_handler.utils.html#gingerbread.central_processing_handler.utils.helpers.decode_weights_pickled"><code class="docutils literal notranslate"><span class="pre">decode_weights_pickled()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="gingerbread.central_processing_handler.utils.html#gingerbread.central_processing_handler.utils.helpers.encode_payload"><code class="docutils literal notranslate"><span class="pre">encode_payload()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="gingerbread.central_processing_handler.utils.html#gingerbread.central_processing_handler.utils.helpers.encode_weights"><code class="docutils literal notranslate"><span class="pre">encode_weights()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="gingerbread.central_processing_handler.utils.html#gingerbread.central_processing_handler.utils.helpers.get_img_info"><code class="docutils literal notranslate"><span class="pre">get_img_info()</span></code></a></li>
@@ -344,14 +344,14 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>data</strong> (<em>np.ndarray</em>) – The data to be processed.</p></li>
+<li><p><strong>data</strong> (<em>np.ndarray</em>) – The data to be processed. THIS NEEDS TO BE (C, D, H, W) or (C, H, W)</p></li>
 <li><p><strong>extras</strong> (<em>Dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – Any extra data that is needed for the processing.</p></li>
 <li><p><strong>montecarlo_loop</strong> (<em>int</em>) – The number of times the data should be processed. If not specified, it will be 1 by default which means the data will be processed only once.</p></li>
 <li><p><strong>weights_ensemble</strong> (<em>bool</em>) – The weights of the model to be used for processing. If not specified, the weights will be fetched from MQ.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><strong>result</strong> – The processed data.</p>
+<dd class="field-even"><p><strong>result</strong> – The processed data. (C, D, H, W) or (C, H, W)</p>
 </dd>
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
 <dd class="field-odd"><p>np.ndarray</p>

gingerbread.central_processing_handler.sql.html

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="gingerbread.central_processing_handler.utils package" href="gingerbread.central_processing_handler.utils.html" /><link rel="prev" title="gingerbread.central_processing_handler.config package" href="gingerbread.central_processing_handler.config.html" />
 
     <!-- Generated with Sphinx 6.2.1 and Furo 2022.12.07 -->
-        <title>gingerbread.central_processing_handler.sql package - Gingerbread 0.5.3 documentation</title>
+        <title>gingerbread.central_processing_handler.sql package - Gingerbread 0.5.8 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Gingerbread 0.5.3 documentation</div></a>
+      <a href="index.html"><div class="brand">Gingerbread 0.5.8 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -149,7 +149,7 @@
     <img class="sidebar-logo" src="_static/63ecff6168e0e.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Gingerbread 0.5.3 documentation</span>
+  <span class="sidebar-brand-text">Gingerbread 0.5.8 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">

gingerbread.central_processing_handler.utils.html

@@ -6,7 +6,7 @@
 <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="gingerbread.config package" href="gingerbread.config.html" /><link rel="prev" title="gingerbread.central_processing_handler.sql package" href="gingerbread.central_processing_handler.sql.html" />
 
     <!-- Generated with Sphinx 6.2.1 and Furo 2022.12.07 -->
-        <title>gingerbread.central_processing_handler.utils package - Gingerbread 0.5.3 documentation</title>
+        <title>gingerbread.central_processing_handler.utils package - Gingerbread 0.5.8 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=91d0f0d1c444bdcb17a68e833c7a53903343c195" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -123,7 +123,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Gingerbread 0.5.3 documentation</div></a>
+      <a href="index.html"><div class="brand">Gingerbread 0.5.8 documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -149,7 +149,7 @@
     <img class="sidebar-logo" src="_static/63ecff6168e0e.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Gingerbread 0.5.3 documentation</span>
+  <span class="sidebar-brand-text">Gingerbread 0.5.8 documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
   <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
@@ -573,10 +573,10 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 </dd></dl>
 
 <dl class="py function">
-<dt class="sig sig-object py" id="gingerbread.central_processing_handler.utils.helpers.decode_weights">
-<span class="sig-prename descclassname"><span class="pre">gingerbread.central_processing_handler.utils.helpers.</span></span><span class="sig-name descname"><span class="pre">decode_weights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">encoded_weights</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">OrderedDict</span></span></span><a class="headerlink" href="#gingerbread.central_processing_handler.utils.helpers.decode_weights" title="Permalink to this definition">#</a></dt>
+<dt class="sig sig-object py" id="gingerbread.central_processing_handler.utils.helpers.decode_weights_pickled">
+<span class="sig-prename descclassname"><span class="pre">gingerbread.central_processing_handler.utils.helpers.</span></span><span class="sig-name descname"><span class="pre">decode_weights_pickled</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">encoded_weights</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bytes</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">OrderedDict</span></span></span><a class="headerlink" href="#gingerbread.central_processing_handler.utils.helpers.decode_weights_pickled" title="Permalink to this definition">#</a></dt>
 <dd><p>the function decodes a encoded weights loaded from MQ.
-:param encoded_model: encoded weights loaded from MQ.
+:param encoded_model: encoded weights loaded from MQ as decompressed gzip bytes and then pickled.
 :type encoded_model: bytes</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
@@ -782,7 +782,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <li><a class="reference internal" href="#module-gingerbread.central_processing_handler.utils.helpers">gingerbread.central_processing_handler.utils.helpers module</a><ul>
 <li><a class="reference internal" href="#gingerbread.central_processing_handler.utils.helpers.copy_obj"><code class="docutils literal notranslate"><span class="pre">copy_obj()</span></code></a></li>
 <li><a class="reference internal" href="#gingerbread.central_processing_handler.utils.helpers.decode_payload"><code class="docutils literal notranslate"><span class="pre">decode_payload()</span></code></a></li>
-<li><a class="reference internal" href="#gingerbread.central_processing_handler.utils.helpers.decode_weights"><code class="docutils literal notranslate"><span class="pre">decode_weights()</span></code></a></li>
+<li><a class="reference internal" href="#gingerbread.central_processing_handler.utils.helpers.decode_weights_pickled"><code class="docutils literal notranslate"><span class="pre">decode_weights_pickled()</span></code></a></li>
 <li><a class="reference internal" href="#gingerbread.central_processing_handler.utils.helpers.encode_payload"><code class="docutils literal notranslate"><span class="pre">encode_payload()</span></code></a></li>
 <li><a class="reference internal" href="#gingerbread.central_processing_handler.utils.helpers.encode_weights"><code class="docutils literal notranslate"><span class="pre">encode_weights()</span></code></a></li>
 <li><a class="reference internal" href="#gingerbread.central_processing_handler.utils.helpers.get_img_info"><code class="docutils literal notranslate"><span class="pre">get_img_info()</span></code></a></li>