Deploying to gh-pages from @ 01694b6 🚀

_modules/deeprootgen/statistics/distance_metrics.html

@@ -118,30 +118,6 @@ <h1>Source code for deeprootgen.statistics.distance_metrics</h1><div class="high
 
 
 
-<div class="viewcode-block" id="L2Norm">
-<a class="viewcode-back" href="../../../api_reference/statistics.html#deeprootgen.statistics.distance_metrics.L2Norm">[docs]</a>
-<span class="k">class</span> <span class="nc">L2Norm</span><span class="p">(</span><span class="n">DistanceMetricBase</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;The L2 norm distance.&quot;&quot;&quot;</span>
-
-<div class="viewcode-block" id="L2Norm.calculate">
-<a class="viewcode-back" href="../../../api_reference/statistics.html#deeprootgen.statistics.distance_metrics.L2Norm.calculate">[docs]</a>
-    <span class="k">def</span> <span class="nf">calculate</span><span class="p">(</span>
-        <span class="bp">self</span><span class="p">,</span> <span class="n">observed</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">simulated</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span>
-    <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span> <span class="o">|</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Calculate the distance between observed and simulated data.</span>
-
-<span class="sd">        Args:</span>
-<span class="sd">            observed (np.ndarray):</span>
-<span class="sd">                The observed data.</span>
-<span class="sd">            simulated (np.ndarray):</span>
-<span class="sd">                The simulated data.</span>
-<span class="sd">        &quot;&quot;&quot;</span>
-        <span class="n">distance</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">linalg</span><span class="o">.</span><span class="n">norm</span><span class="p">(</span><span class="n">observed</span> <span class="o">-</span> <span class="n">simulated</span><span class="p">,</span> <span class="nb">ord</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
-        <span class="k">return</span> <span class="n">distance</span></div>
-</div>
-
-
-
 <div class="viewcode-block" id="L1Norm">
 <a class="viewcode-back" href="../../../api_reference/statistics.html#deeprootgen.statistics.distance_metrics.L1Norm">[docs]</a>
 <span class="k">class</span> <span class="nc">L1Norm</span><span class="p">(</span><span class="n">DistanceMetricBase</span><span class="p">):</span>
@@ -340,7 +316,6 @@ <h1>Source code for deeprootgen.statistics.distance_metrics</h1><div class="high
 <span class="sd">            A list of available distance metrics and labels.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">distance_metrics</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span>
-        <span class="s2">&quot;l2_norm&quot;</span><span class="p">,</span>
         <span class="s2">&quot;l1_norm&quot;</span><span class="p">,</span>
         <span class="s2">&quot;mean_squared_error&quot;</span><span class="p">,</span>
         <span class="s2">&quot;mean_absolute_error&quot;</span><span class="p">,</span>

api_reference/statistics.html

@@ -59,7 +59,6 @@
 <li class="toctree-l3"><a class="reference internal" href="#module-deeprootgen.statistics.distance_metrics">Distance Metrics</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#deeprootgen.statistics.distance_metrics.DistanceMetricBase"><code class="docutils literal notranslate"><span class="pre">DistanceMetricBase</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#deeprootgen.statistics.distance_metrics.L1Norm"><code class="docutils literal notranslate"><span class="pre">L1Norm</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="#deeprootgen.statistics.distance_metrics.L2Norm"><code class="docutils literal notranslate"><span class="pre">L2Norm</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#deeprootgen.statistics.distance_metrics.MeanAbsoluteError"><code class="docutils literal notranslate"><span class="pre">MeanAbsoluteError</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#deeprootgen.statistics.distance_metrics.MeanAbsolutePercentageError"><code class="docutils literal notranslate"><span class="pre">MeanAbsolutePercentageError</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#deeprootgen.statistics.distance_metrics.MeanPinballLoss"><code class="docutils literal notranslate"><span class="pre">MeanPinballLoss</span></code></a></li>
@@ -175,27 +174,6 @@ <h1>Statistics<a class="headerlink" href="#statistics" title="Link to this headi
 
 </dd></dl>
 
-<dl class="py class">
-<dt class="sig sig-object py" id="deeprootgen.statistics.distance_metrics.L2Norm">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">deeprootgen.statistics.distance_metrics.</span></span><span class="sig-name descname"><span class="pre">L2Norm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/deeprootgen/statistics/distance_metrics.html#L2Norm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#deeprootgen.statistics.distance_metrics.L2Norm" title="Link to this definition"></a></dt>
-<dd><p>The L2 norm distance.</p>
-<dl class="py method">
-<dt class="sig sig-object py" id="deeprootgen.statistics.distance_metrics.L2Norm.calculate">
-<span class="sig-name descname"><span class="pre">calculate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">observed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">simulated</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</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">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ndarray</span></span></span><a class="reference internal" href="../_modules/deeprootgen/statistics/distance_metrics.html#L2Norm.calculate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#deeprootgen.statistics.distance_metrics.L2Norm.calculate" title="Link to this definition"></a></dt>
-<dd><p>Calculate the distance between observed and simulated data.</p>
-<dl class="simple">
-<dt>Args:</dt><dd><dl class="simple">
-<dt>observed (np.ndarray):</dt><dd><p>The observed data.</p>
-</dd>
-<dt>simulated (np.ndarray):</dt><dd><p>The simulated data.</p>
-</dd>
-</dl>
-</dd>
-</dl>
-</dd></dl>
-
-</dd></dl>
-
 <dl class="py class">
 <dt class="sig sig-object py" id="deeprootgen.statistics.distance_metrics.MeanAbsoluteError">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">deeprootgen.statistics.distance_metrics.</span></span><span class="sig-name descname"><span class="pre">MeanAbsoluteError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/deeprootgen/statistics/distance_metrics.html#MeanAbsoluteError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#deeprootgen.statistics.distance_metrics.MeanAbsoluteError" title="Link to this definition"></a></dt>

genindex.html

@@ -159,8 +159,6 @@ <h2 id="C">C</h2>
 
       <ul>
         <li><a href="api_reference/statistics.html#deeprootgen.statistics.distance_metrics.L1Norm.calculate">(deeprootgen.statistics.distance_metrics.L1Norm method)</a>
-</li>
-        <li><a href="api_reference/statistics.html#deeprootgen.statistics.distance_metrics.L2Norm.calculate">(deeprootgen.statistics.distance_metrics.L2Norm method)</a>
 </li>
         <li><a href="api_reference/statistics.html#deeprootgen.statistics.distance_metrics.MeanAbsoluteError.calculate">(deeprootgen.statistics.distance_metrics.MeanAbsoluteError method)</a>
 </li>
@@ -446,8 +444,6 @@ <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api_reference/statistics.html#deeprootgen.statistics.distance_metrics.L1Norm">L1Norm (class in deeprootgen.statistics.distance_metrics)</a>
-</li>
-      <li><a href="api_reference/statistics.html#deeprootgen.statistics.distance_metrics.L2Norm">L2Norm (class in deeprootgen.statistics.distance_metrics)</a>
 </li>
       <li><a href="api_reference/calibration.html#deeprootgen.calibration.model_versioning.OptimisationModel.load_context">load_context() (deeprootgen.calibration.model_versioning.OptimisationModel method)</a>