Documentation updated

This commit is contained in:
fjosw 2022-05-27 13:18:24 +00:00
parent ed884b4e6e
commit 055f158b6b

View file

@ -1765,22 +1765,22 @@
</span><span id="L-1452"><a href="#L-1452"><span class="linenos">1452</span></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">smooth</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span> </span><span id="L-1452"><a href="#L-1452"><span class="linenos">1452</span></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">smooth</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span>
</span><span id="L-1453"><a href="#L-1453"><span class="linenos">1453</span></a> <span class="n">corr</span> <span class="o">=</span> <span class="n">_smooth_eigenvalues</span><span class="p">(</span><span class="n">corr</span><span class="p">,</span> <span class="n">smooth</span><span class="p">)</span> </span><span id="L-1453"><a href="#L-1453"><span class="linenos">1453</span></a> <span class="n">corr</span> <span class="o">=</span> <span class="n">_smooth_eigenvalues</span><span class="p">(</span><span class="n">corr</span><span class="p">,</span> <span class="n">smooth</span><span class="p">)</span>
</span><span id="L-1454"><a href="#L-1454"><span class="linenos">1454</span></a> </span><span id="L-1454"><a href="#L-1454"><span class="linenos">1454</span></a>
</span><span id="L-1455"><a href="#L-1455"><span class="linenos">1455</span></a> <span class="n">errors</span> <span class="o">=</span> <span class="p">[</span><span class="n">o</span><span class="o">.</span><span class="n">dvalue</span> <span class="k">for</span> <span class="n">o</span> <span class="ow">in</span> <span class="n">obs</span><span class="p">]</span> </span><span id="L-1455"><a href="#L-1455"><span class="linenos">1455</span></a> <span class="k">if</span> <span class="n">visualize</span><span class="p">:</span>
</span><span id="L-1456"><a href="#L-1456"><span class="linenos">1456</span></a> <span class="n">cov</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</span><span class="p">(</span><span class="n">errors</span><span class="p">)</span> <span class="o">@</span> <span class="n">corr</span> <span class="o">@</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</span><span class="p">(</span><span class="n">errors</span><span class="p">)</span> </span><span id="L-1456"><a href="#L-1456"><span class="linenos">1456</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">matshow</span><span class="p">(</span><span class="n">corr</span><span class="p">,</span> <span class="n">vmin</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</span><span id="L-1457"><a href="#L-1457"><span class="linenos">1457</span></a> </span><span id="L-1457"><a href="#L-1457"><span class="linenos">1457</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">set_cmap</span><span class="p">(</span><span class="s1">&#39;RdBu&#39;</span><span class="p">)</span>
</span><span id="L-1458"><a href="#L-1458"><span class="linenos">1458</span></a> <span class="n">eigenvalues</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">eigh</span><span class="p">(</span><span class="n">cov</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> </span><span id="L-1458"><a href="#L-1458"><span class="linenos">1458</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">()</span>
</span><span id="L-1459"><a href="#L-1459"><span class="linenos">1459</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">all</span><span class="p">(</span><span class="n">eigenvalues</span> <span class="o">&gt;=</span> <span class="mi">0</span><span class="p">):</span> </span><span id="L-1459"><a href="#L-1459"><span class="linenos">1459</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">draw</span><span class="p">()</span>
</span><span id="L-1460"><a href="#L-1460"><span class="linenos">1460</span></a> <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">&quot;Covariance matrix is not positive semi-definite (Eigenvalues: &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">eigenvalues</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;)&quot;</span><span class="p">,</span> <span class="ne">RuntimeWarning</span><span class="p">)</span> </span><span id="L-1460"><a href="#L-1460"><span class="linenos">1460</span></a>
</span><span id="L-1461"><a href="#L-1461"><span class="linenos">1461</span></a> </span><span id="L-1461"><a href="#L-1461"><span class="linenos">1461</span></a> <span class="k">if</span> <span class="n">correlation</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
</span><span id="L-1462"><a href="#L-1462"><span class="linenos">1462</span></a> <span class="k">if</span> <span class="n">visualize</span><span class="p">:</span> </span><span id="L-1462"><a href="#L-1462"><span class="linenos">1462</span></a> <span class="k">return</span> <span class="n">corr</span>
</span><span id="L-1463"><a href="#L-1463"><span class="linenos">1463</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">matshow</span><span class="p">(</span><span class="n">corr</span><span class="p">,</span> <span class="n">vmin</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> </span><span id="L-1463"><a href="#L-1463"><span class="linenos">1463</span></a>
</span><span id="L-1464"><a href="#L-1464"><span class="linenos">1464</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">set_cmap</span><span class="p">(</span><span class="s1">&#39;RdBu&#39;</span><span class="p">)</span> </span><span id="L-1464"><a href="#L-1464"><span class="linenos">1464</span></a> <span class="n">errors</span> <span class="o">=</span> <span class="p">[</span><span class="n">o</span><span class="o">.</span><span class="n">dvalue</span> <span class="k">for</span> <span class="n">o</span> <span class="ow">in</span> <span class="n">obs</span><span class="p">]</span>
</span><span id="L-1465"><a href="#L-1465"><span class="linenos">1465</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">()</span> </span><span id="L-1465"><a href="#L-1465"><span class="linenos">1465</span></a> <span class="n">cov</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</span><span class="p">(</span><span class="n">errors</span><span class="p">)</span> <span class="o">@</span> <span class="n">corr</span> <span class="o">@</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</span><span class="p">(</span><span class="n">errors</span><span class="p">)</span>
</span><span id="L-1466"><a href="#L-1466"><span class="linenos">1466</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">draw</span><span class="p">()</span> </span><span id="L-1466"><a href="#L-1466"><span class="linenos">1466</span></a>
</span><span id="L-1467"><a href="#L-1467"><span class="linenos">1467</span></a> </span><span id="L-1467"><a href="#L-1467"><span class="linenos">1467</span></a> <span class="n">eigenvalues</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">eigh</span><span class="p">(</span><span class="n">cov</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
</span><span id="L-1468"><a href="#L-1468"><span class="linenos">1468</span></a> <span class="k">if</span> <span class="n">correlation</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span> </span><span id="L-1468"><a href="#L-1468"><span class="linenos">1468</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">all</span><span class="p">(</span><span class="n">eigenvalues</span> <span class="o">&gt;=</span> <span class="mi">0</span><span class="p">):</span>
</span><span id="L-1469"><a href="#L-1469"><span class="linenos">1469</span></a> <span class="k">return</span> <span class="n">corr</span> </span><span id="L-1469"><a href="#L-1469"><span class="linenos">1469</span></a> <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">&quot;Covariance matrix is not positive semi-definite (Eigenvalues: &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">eigenvalues</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;)&quot;</span><span class="p">,</span> <span class="ne">RuntimeWarning</span><span class="p">)</span>
</span><span id="L-1470"><a href="#L-1470"><span class="linenos">1470</span></a> <span class="k">else</span><span class="p">:</span> </span><span id="L-1470"><a href="#L-1470"><span class="linenos">1470</span></a>
</span><span id="L-1471"><a href="#L-1471"><span class="linenos">1471</span></a> <span class="k">return</span> <span class="n">cov</span> </span><span id="L-1471"><a href="#L-1471"><span class="linenos">1471</span></a> <span class="k">return</span> <span class="n">cov</span>
</span><span id="L-1472"><a href="#L-1472"><span class="linenos">1472</span></a> </span><span id="L-1472"><a href="#L-1472"><span class="linenos">1472</span></a>
</span><span id="L-1473"><a href="#L-1473"><span class="linenos">1473</span></a> </span><span id="L-1473"><a href="#L-1473"><span class="linenos">1473</span></a>
@ -5026,22 +5026,22 @@ Currently only works if ensembles are identical (this is not strictly necessary)
</span><span id="covariance-1453"><a href="#covariance-1453"><span class="linenos">1453</span></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">smooth</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span> </span><span id="covariance-1453"><a href="#covariance-1453"><span class="linenos">1453</span></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">smooth</span><span class="p">,</span> <span class="nb">int</span><span class="p">):</span>
</span><span id="covariance-1454"><a href="#covariance-1454"><span class="linenos">1454</span></a> <span class="n">corr</span> <span class="o">=</span> <span class="n">_smooth_eigenvalues</span><span class="p">(</span><span class="n">corr</span><span class="p">,</span> <span class="n">smooth</span><span class="p">)</span> </span><span id="covariance-1454"><a href="#covariance-1454"><span class="linenos">1454</span></a> <span class="n">corr</span> <span class="o">=</span> <span class="n">_smooth_eigenvalues</span><span class="p">(</span><span class="n">corr</span><span class="p">,</span> <span class="n">smooth</span><span class="p">)</span>
</span><span id="covariance-1455"><a href="#covariance-1455"><span class="linenos">1455</span></a> </span><span id="covariance-1455"><a href="#covariance-1455"><span class="linenos">1455</span></a>
</span><span id="covariance-1456"><a href="#covariance-1456"><span class="linenos">1456</span></a> <span class="n">errors</span> <span class="o">=</span> <span class="p">[</span><span class="n">o</span><span class="o">.</span><span class="n">dvalue</span> <span class="k">for</span> <span class="n">o</span> <span class="ow">in</span> <span class="n">obs</span><span class="p">]</span> </span><span id="covariance-1456"><a href="#covariance-1456"><span class="linenos">1456</span></a> <span class="k">if</span> <span class="n">visualize</span><span class="p">:</span>
</span><span id="covariance-1457"><a href="#covariance-1457"><span class="linenos">1457</span></a> <span class="n">cov</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</span><span class="p">(</span><span class="n">errors</span><span class="p">)</span> <span class="o">@</span> <span class="n">corr</span> <span class="o">@</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</span><span class="p">(</span><span class="n">errors</span><span class="p">)</span> </span><span id="covariance-1457"><a href="#covariance-1457"><span class="linenos">1457</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">matshow</span><span class="p">(</span><span class="n">corr</span><span class="p">,</span> <span class="n">vmin</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
</span><span id="covariance-1458"><a href="#covariance-1458"><span class="linenos">1458</span></a> </span><span id="covariance-1458"><a href="#covariance-1458"><span class="linenos">1458</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">set_cmap</span><span class="p">(</span><span class="s1">&#39;RdBu&#39;</span><span class="p">)</span>
</span><span id="covariance-1459"><a href="#covariance-1459"><span class="linenos">1459</span></a> <span class="n">eigenvalues</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">eigh</span><span class="p">(</span><span class="n">cov</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> </span><span id="covariance-1459"><a href="#covariance-1459"><span class="linenos">1459</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">()</span>
</span><span id="covariance-1460"><a href="#covariance-1460"><span class="linenos">1460</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">all</span><span class="p">(</span><span class="n">eigenvalues</span> <span class="o">&gt;=</span> <span class="mi">0</span><span class="p">):</span> </span><span id="covariance-1460"><a href="#covariance-1460"><span class="linenos">1460</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">draw</span><span class="p">()</span>
</span><span id="covariance-1461"><a href="#covariance-1461"><span class="linenos">1461</span></a> <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">&quot;Covariance matrix is not positive semi-definite (Eigenvalues: &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">eigenvalues</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;)&quot;</span><span class="p">,</span> <span class="ne">RuntimeWarning</span><span class="p">)</span> </span><span id="covariance-1461"><a href="#covariance-1461"><span class="linenos">1461</span></a>
</span><span id="covariance-1462"><a href="#covariance-1462"><span class="linenos">1462</span></a> </span><span id="covariance-1462"><a href="#covariance-1462"><span class="linenos">1462</span></a> <span class="k">if</span> <span class="n">correlation</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span>
</span><span id="covariance-1463"><a href="#covariance-1463"><span class="linenos">1463</span></a> <span class="k">if</span> <span class="n">visualize</span><span class="p">:</span> </span><span id="covariance-1463"><a href="#covariance-1463"><span class="linenos">1463</span></a> <span class="k">return</span> <span class="n">corr</span>
</span><span id="covariance-1464"><a href="#covariance-1464"><span class="linenos">1464</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">matshow</span><span class="p">(</span><span class="n">corr</span><span class="p">,</span> <span class="n">vmin</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> </span><span id="covariance-1464"><a href="#covariance-1464"><span class="linenos">1464</span></a>
</span><span id="covariance-1465"><a href="#covariance-1465"><span class="linenos">1465</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">set_cmap</span><span class="p">(</span><span class="s1">&#39;RdBu&#39;</span><span class="p">)</span> </span><span id="covariance-1465"><a href="#covariance-1465"><span class="linenos">1465</span></a> <span class="n">errors</span> <span class="o">=</span> <span class="p">[</span><span class="n">o</span><span class="o">.</span><span class="n">dvalue</span> <span class="k">for</span> <span class="n">o</span> <span class="ow">in</span> <span class="n">obs</span><span class="p">]</span>
</span><span id="covariance-1466"><a href="#covariance-1466"><span class="linenos">1466</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">colorbar</span><span class="p">()</span> </span><span id="covariance-1466"><a href="#covariance-1466"><span class="linenos">1466</span></a> <span class="n">cov</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</span><span class="p">(</span><span class="n">errors</span><span class="p">)</span> <span class="o">@</span> <span class="n">corr</span> <span class="o">@</span> <span class="n">np</span><span class="o">.</span><span class="n">diag</span><span class="p">(</span><span class="n">errors</span><span class="p">)</span>
</span><span id="covariance-1467"><a href="#covariance-1467"><span class="linenos">1467</span></a> <span class="n">plt</span><span class="o">.</span><span class="n">draw</span><span class="p">()</span> </span><span id="covariance-1467"><a href="#covariance-1467"><span class="linenos">1467</span></a>
</span><span id="covariance-1468"><a href="#covariance-1468"><span class="linenos">1468</span></a> </span><span id="covariance-1468"><a href="#covariance-1468"><span class="linenos">1468</span></a> <span class="n">eigenvalues</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">eigh</span><span class="p">(</span><span class="n">cov</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
</span><span id="covariance-1469"><a href="#covariance-1469"><span class="linenos">1469</span></a> <span class="k">if</span> <span class="n">correlation</span> <span class="ow">is</span> <span class="kc">True</span><span class="p">:</span> </span><span id="covariance-1469"><a href="#covariance-1469"><span class="linenos">1469</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">np</span><span class="o">.</span><span class="n">all</span><span class="p">(</span><span class="n">eigenvalues</span> <span class="o">&gt;=</span> <span class="mi">0</span><span class="p">):</span>
</span><span id="covariance-1470"><a href="#covariance-1470"><span class="linenos">1470</span></a> <span class="k">return</span> <span class="n">corr</span> </span><span id="covariance-1470"><a href="#covariance-1470"><span class="linenos">1470</span></a> <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s2">&quot;Covariance matrix is not positive semi-definite (Eigenvalues: &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">eigenvalues</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;)&quot;</span><span class="p">,</span> <span class="ne">RuntimeWarning</span><span class="p">)</span>
</span><span id="covariance-1471"><a href="#covariance-1471"><span class="linenos">1471</span></a> <span class="k">else</span><span class="p">:</span> </span><span id="covariance-1471"><a href="#covariance-1471"><span class="linenos">1471</span></a>
</span><span id="covariance-1472"><a href="#covariance-1472"><span class="linenos">1472</span></a> <span class="k">return</span> <span class="n">cov</span> </span><span id="covariance-1472"><a href="#covariance-1472"><span class="linenos">1472</span></a> <span class="k">return</span> <span class="n">cov</span>
</span></pre></div> </span></pre></div>