Skip to content

Commit

Permalink
Merge pull request #29 from fabiankueppers/develop
Browse files Browse the repository at this point in the history
Updates for new release 1.3.0
  • Loading branch information
fabiankueppers authored Oct 18, 2022
2 parents 40eb933 + 935faba commit cc19d1b
Show file tree
Hide file tree
Showing 407 changed files with 95,841 additions and 14,826 deletions.
955 changes: 955 additions & 0 deletions README.md

Large diffs are not rendered by default.

362 changes: 0 additions & 362 deletions README.rst

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/build/doctrees/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: e005a9a01c1ee86b9ab7af5d4e430bec
config: 1ac7d38d423f86275c5551f90dadb548
tags: 645f666f9bcd5a90fca523b33c5a78b7
492 changes: 225 additions & 267 deletions docs/build/html/_autosummary/_autosummary_binning/netcal.binning.BBQ.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

495 changes: 248 additions & 247 deletions docs/build/html/_autosummary/_autosummary_metric/netcal.metrics.ACE.html

Large diffs are not rendered by default.

496 changes: 248 additions & 248 deletions docs/build/html/_autosummary/_autosummary_metric/netcal.metrics.ECE.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

493 changes: 247 additions & 246 deletions docs/build/html/_autosummary/_autosummary_metric/netcal.metrics.MCE.html

Large diffs are not rendered by default.

375 changes: 235 additions & 140 deletions docs/build/html/_autosummary/_autosummary_metric/netcal.metrics.MMCE.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,262 @@
<!DOCTYPE html>




<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>netcal.metrics.NLL &mdash; net:cal API Reference</title>
<meta name="description" content="">
<meta name="author" content="">



<link rel="stylesheet" href="../../_static/css/basicstrap-base.css" type="text/css" />
<link rel="stylesheet" id="current-theme" href="../../_static/css/bootstrap3/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" id="current-adjust-theme" type="text/css" />

<link rel="stylesheet" href="../../_static/css/font-awesome.min.css">

<style type="text/css">
body {
padding-top: 60px;
padding-bottom: 40px;
}
</style>

<link rel="stylesheet" href="../../_static/css/basicstrap.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/basicstrap.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.3.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/js/jquery.min.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/sphinx_highlight.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script type="text/javascript" src="../../_static/js/bootstrap3.min.js"></script>
<script type="text/javascript" src="../../_static/js/jquery.cookie.min.js"></script>
<script type="text/javascript" src="../../_static/js/basicstrap.js"></script>
<script type="text/javascript">
</script>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="top" title="net:cal API Reference" href="../../index.html" />
<link rel="up" title="netcal.metrics" href="../netcal.metrics.html" />
<link rel="next" title="netcal.metrics.confidence" href="../_autosummary_metric_submodules/netcal.metrics.confidence.html" />
<link rel="prev" title="netcal.metrics.QCE" href="netcal.metrics.QCE.html" />
</head>
<body role="document">
<div id="navbar-top" class="navbar navbar-fixed-top navbar-default" role="navigation" aria-label="top navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">net:cal API Reference</a>
</div>
<div class="navbar-collapse collapse">
<ul class="nav navbar-nav navbar-right">
<li class="dropdown visible-xs">
<a role="button" id="localToc" data-toggle="dropdown" data-target="#" href="#">Table Of Contents <b class="caret"></b></a>
<ul class="dropdown-menu localtoc sp-localtoc" role="menu" aria-labelledby="localToc">
<ul>
<li><a class="reference internal" href="#">netcal.metrics.NLL</a><ul>
<li><a class="reference internal" href="#netcal.metrics.NLL"><code class="docutils literal notranslate"><span class="pre">NLL</span></code></a></li>
</ul>
</li>
</ul>

</ul>
</li>


<li><a href="netcal.metrics.QCE.html" title="netcal.metrics.QCE" accesskey="P">previous </a></li>
<li><a href="../_autosummary_metric_submodules/netcal.metrics.confidence.html" title="netcal.metrics.confidence" accesskey="N">next </a></li>
<li><a href="../../py-modindex.html" title="Python Module Index" >modules </a></li>
<li><a href="../../genindex.html" title="General Index" accesskey="I">index </a></li>
<li><a href="../netcal.metrics.html" accesskey="U">netcal.metrics</a></li>

<li class="visible-xs"><a href="../../_sources/_autosummary/_autosummary_metric/netcal.metrics.NLL.rst.txt" rel="nofollow">Show Source</a></li>

<li class="visible-xs">
<form class="search form-search form-inline navbar-form navbar-right sp-searchbox" action="../../search.html" method="get">
<div class="input-append input-group">
<input type="text" class="search-query form-control" name="q" placeholder="Search...">
<span class="input-group-btn">
<input type="submit" class="btn" value="Go" />
</span>
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</li>



</ul>

</div>
</div>
</div>


<!-- container -->
<div class="container-fluid">

<!-- row -->
<div class="row">

<div class="col-md-3 hidden-xs" id="sidebar-wrapper">
<div class="sidebar hidden-xs" role="navigation" aria-label="main navigation">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/logo200x200.png" alt="Logo"/>
</a></p>
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../netcal.binning.html">netcal.binning</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netcal.scaling.html">netcal.scaling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netcal.regularization.html">netcal.regularization</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../netcal.metrics.html">netcal.metrics</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../netcal.metrics.html#metrics-package-to-measure-miscalibration">Metrics Package to Measure Miscalibration</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../netcal.metrics.html#available-classes">Available classes</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="netcal.metrics.ACE.html">netcal.metrics.ACE</a></li>
<li class="toctree-l3"><a class="reference internal" href="netcal.metrics.ECE.html">netcal.metrics.ECE</a></li>
<li class="toctree-l3"><a class="reference internal" href="netcal.metrics.MCE.html">netcal.metrics.MCE</a></li>
<li class="toctree-l3"><a class="reference internal" href="netcal.metrics.MMCE.html">netcal.metrics.MMCE</a></li>
<li class="toctree-l3"><a class="reference internal" href="netcal.metrics.QuantileLoss.html">netcal.metrics.QuantileLoss</a></li>
<li class="toctree-l3"><a class="reference internal" href="netcal.metrics.PinballLoss.html">netcal.metrics.PinballLoss</a></li>
<li class="toctree-l3"><a class="reference internal" href="netcal.metrics.ENCE.html">netcal.metrics.ENCE</a></li>
<li class="toctree-l3"><a class="reference internal" href="netcal.metrics.UCE.html">netcal.metrics.UCE</a></li>
<li class="toctree-l3"><a class="reference internal" href="netcal.metrics.PICP.html">netcal.metrics.PICP</a></li>
<li class="toctree-l3"><a class="reference internal" href="netcal.metrics.QCE.html">netcal.metrics.QCE</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">netcal.metrics.NLL</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#netcal.metrics.NLL"><code class="docutils literal notranslate"><span class="pre">NLL</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../netcal.metrics.html#packages">Packages</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../netcal.presentation.html">netcal.presentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../netcal.regression.html">netcal.regression</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../_autosummary_abstract_calibration/netcal.AbstractCalibration.html">netcal.AbstractCalibration</a></li>
</ul>

<div id="searchbox" role="search">
<h3>Quick search</h3>
<form class="search form-inline" action="../../search.html" method="get">
<div class="input-append input-group">
<input type="text" class="search-query form-control" name="q" placeholder="Search...">
<span class="input-group-btn">
<input type="submit" class="btn" value="Go" />
</span>
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
</div>
</div>


<div class="col-md-9" id="content-wrapper">
<div class="document" role="main">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">

<section id="netcal-metrics-nll">
<h1>netcal.metrics.NLL<a class="headerlink" href="#netcal-metrics-nll" title="Permalink to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="netcal.metrics.NLL">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">netcal.metrics.</span></span><span class="sig-name descname"><span class="pre">NLL</span></span><a class="headerlink" href="#netcal.metrics.NLL" title="Permalink to this definition"></a></dt>
<dd><p>Negative log likelihood (NLL) for probabilistic regression models.
If a probabilistic forecaster outputs a probability density function (PDF) <span class="math notranslate nohighlight">\(f_Y(y)\)</span> targeting the ground-truth
<span class="math notranslate nohighlight">\(y\)</span>, the negative log likelihood is defined by</p>
<div class="math notranslate nohighlight">
\[\text{NLL} = -\sum^N_{n=1} \log\big(f_Y(y)\big) ,\]</div>
<p>with <span class="math notranslate nohighlight">\(N\)</span> as the number of samples within the examined data set.</p>
<p><strong>Note:</strong> the input field for the standard deviation might also be given as quadratic NumPy arrays of shape
(n, d, d) with d dimensions. In this case, this method asserts covariance matrices as input
for each sample and the NLL is calculated for multivariate distributions.</p>
<p class="rubric">Methods</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code>()</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">measure</span></code>(X, y, *[, kind, reduction])</p></td>
<td><p>Measures the negative log likelihood (NLL) for probabilistic regression models.</p></td>
</tr>
</tbody>
</table>
</dd></dl>

</section>


</div>
</div>
</div>
</div>
</div>


</div><!-- /row -->

<!-- row -->
<div class="row footer-relbar">
<div id="navbar-related" class=" related navbar navbar-default" role="navigation" aria-label="related navigation">
<div class="navbar-inner">
<ul class="nav navbar-nav ">
<li><a href="../../index.html">net:cal API Reference</a></li>
</ul>
<ul class="nav navbar-nav pull-right hidden-xs hidden-sm">

<li><a href="netcal.metrics.QCE.html" title="netcal.metrics.QCE" >previous</a></li>
<li><a href="../_autosummary_metric_submodules/netcal.metrics.confidence.html" title="netcal.metrics.confidence" >next</a></li>
<li><a href="../../py-modindex.html" title="Python Module Index" >modules</a></li>
<li><a href="../../genindex.html" title="General Index" >index</a></li>
<li><a href="../netcal.metrics.html" >netcal.metrics</a></li>
<li><a href="#">top</a></li>

</ul>
</div>
</div>
</div><!-- /row -->

<!-- footer -->
<footer role="contentinfo">
</footer>
<!-- /footer -->

</div>
<!-- /container -->

</body>
</html>
Loading

0 comments on commit cc19d1b

Please sign in to comment.