Update documentation

EFS-OpenSource · Mar 17, 2023 · cd591d5 · cd591d5
1 parent dcfe207
commit cd591d5
Show file tree

Hide file tree

Showing 134 changed files with 193 additions and 13,462 deletions.
diff --git a/.../build/doctrees/_autosummary/_autosummary_binning/netcal.binning.HistogramBinning.doctree b/.../build/doctrees/_autosummary/_autosummary_binning/netcal.binning.HistogramBinning.doctree
diff --git a/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.ACE.doctree b/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.ACE.doctree
diff --git a/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.ECE.doctree b/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.ECE.doctree
diff --git a/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.ENCE.doctree b/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.ENCE.doctree
diff --git a/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.MCE.doctree b/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.MCE.doctree
diff --git a/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.PICP.doctree b/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.PICP.doctree
diff --git a/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.UCE.doctree b/docs/build/doctrees/_autosummary/_autosummary_metric/netcal.metrics.UCE.doctree
diff --git a/.../_autosummary_metric_submodules/_autosummary_metric/netcal.metrics.confidence.ACE.doctree b/.../_autosummary_metric_submodules/_autosummary_metric/netcal.metrics.confidence.ACE.doctree
diff --git a/.../_autosummary_metric_submodules/_autosummary_metric/netcal.metrics.confidence.ECE.doctree b/.../_autosummary_metric_submodules/_autosummary_metric/netcal.metrics.confidence.ECE.doctree
diff --git a/.../_autosummary_metric_submodules/_autosummary_metric/netcal.metrics.confidence.MCE.doctree b/.../_autosummary_metric_submodules/_autosummary_metric/netcal.metrics.confidence.MCE.doctree
diff --git a/..._autosummary_metric_submodules/_autosummary_metric/netcal.metrics.regression.ENCE.doctree b/..._autosummary_metric_submodules/_autosummary_metric/netcal.metrics.regression.ENCE.doctree
diff --git a/..._autosummary_metric_submodules/_autosummary_metric/netcal.metrics.regression.PICP.doctree b/..._autosummary_metric_submodules/_autosummary_metric/netcal.metrics.regression.PICP.doctree
diff --git a/.../_autosummary_metric_submodules/_autosummary_metric/netcal.metrics.regression.UCE.doctree b/.../_autosummary_metric_submodules/_autosummary_metric/netcal.metrics.regression.UCE.doctree
diff --git a/...ld/doctrees/_autosummary/_autosummary_metric_submodules/netcal.metrics.confidence.doctree b/...ld/doctrees/_autosummary/_autosummary_metric_submodules/netcal.metrics.confidence.doctree
diff --git a/...ld/doctrees/_autosummary/_autosummary_metric_submodules/netcal.metrics.regression.doctree b/...ld/doctrees/_autosummary/_autosummary_metric_submodules/netcal.metrics.regression.doctree
diff --git a/...ees/_autosummary/_autosummary_presentation/netcal.presentation.ReliabilityDiagram.doctree b/...ees/_autosummary/_autosummary_presentation/netcal.presentation.ReliabilityDiagram.doctree
diff --git a/...octrees/_autosummary/_autosummary_presentation/netcal.presentation.ReliabilityQCE.doctree b/...octrees/_autosummary/_autosummary_presentation/netcal.presentation.ReliabilityQCE.doctree
diff --git a/.../_autosummary/_autosummary_presentation/netcal.presentation.ReliabilityRegression.doctree b/.../_autosummary/_autosummary_presentation/netcal.presentation.ReliabilityRegression.doctree
diff --git a/...osummary_regression_gp/_autosummary_regression_gp/netcal.regression.gp.AbstractGP.doctree b/...osummary_regression_gp/_autosummary_regression_gp/netcal.regression.gp.AbstractGP.doctree
diff --git a/...y_regression_gp/_autosummary_regression_gp_submodules/netcal.regression.gp.kernel.doctree b/...y_regression_gp/_autosummary_regression_gp_submodules/netcal.regression.gp.kernel.doctree
diff --git a/...gression_gp/_autosummary_regression_gp_submodules/netcal.regression.gp.likelihood.doctree b/...gression_gp/_autosummary_regression_gp_submodules/netcal.regression.gp.likelihood.doctree
diff --git a/docs/build/doctrees/_autosummary/_autosummary_regression_gp/netcal.regression.gp.doctree b/docs/build/doctrees/_autosummary/_autosummary_regression_gp/netcal.regression.gp.doctree
diff --git a/...osummary/_autosummary_regularization_func/netcal.regularization.ConfidencePenalty.doctree b/...osummary/_autosummary_regularization_func/netcal.regularization.ConfidencePenalty.doctree
diff --git a/...es/_autosummary/_autosummary_regularization_func/netcal.regularization.DCAPenalty.doctree b/...es/_autosummary/_autosummary_regularization_func/netcal.regularization.DCAPenalty.doctree
diff --git a/...s/_autosummary/_autosummary_regularization_func/netcal.regularization.MMCEPenalty.doctree b/...s/_autosummary/_autosummary_regularization_func/netcal.regularization.MMCEPenalty.doctree
diff --git a/...trees/_autosummary/_autosummary_scaling/netcal.scaling.AbstractLogisticRegression.doctree b/...trees/_autosummary/_autosummary_scaling/netcal.scaling.AbstractLogisticRegression.doctree
diff --git a/docs/build/doctrees/_autosummary/netcal.binning.doctree b/docs/build/doctrees/_autosummary/netcal.binning.doctree
diff --git a/docs/build/doctrees/_autosummary/netcal.metrics.doctree b/docs/build/doctrees/_autosummary/netcal.metrics.doctree
diff --git a/docs/build/doctrees/_autosummary/netcal.presentation.doctree b/docs/build/doctrees/_autosummary/netcal.presentation.doctree
diff --git a/docs/build/doctrees/_autosummary/netcal.regression.doctree b/docs/build/doctrees/_autosummary/netcal.regression.doctree
diff --git a/docs/build/doctrees/_autosummary/netcal.regularization.doctree b/docs/build/doctrees/_autosummary/netcal.regularization.doctree
diff --git a/docs/build/doctrees/_autosummary/netcal.scaling.doctree b/docs/build/doctrees/_autosummary/netcal.scaling.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.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: 30e32b1f0e22b69341c6c460af3ba0b8
+config: ab967bacde6db79c8967854a01375c2b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_autosummary/_autosummary_binning/netcal.binning.BBQ.html b/docs/build/html/_autosummary/_autosummary_binning/netcal.binning.BBQ.html
@@ -35,16 +35,13 @@
 <script type="text/javascript">
   var DOCUMENTATION_OPTIONS = {
             URL_ROOT:    '../../',
-            VERSION:     '1.3.3',
+            VERSION:     '1.3.4',
             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>

diff --git a/docs/build/html/_autosummary/_autosummary_binning/netcal.binning.ENIR.html b/docs/build/html/_autosummary/_autosummary_binning/netcal.binning.ENIR.html
@@ -35,16 +35,13 @@
 <script type="text/javascript">
   var DOCUMENTATION_OPTIONS = {
             URL_ROOT:    '../../',
-            VERSION:     '1.3.3',
+            VERSION:     '1.3.4',
             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>

diff --git a/docs/build/html/_autosummary/_autosummary_binning/netcal.binning.HistogramBinning.html b/docs/build/html/_autosummary/_autosummary_binning/netcal.binning.HistogramBinning.html
@@ -35,16 +35,13 @@
 <script type="text/javascript">
   var DOCUMENTATION_OPTIONS = {
             URL_ROOT:    '../../',
-            VERSION:     '1.3.3',
+            VERSION:     '1.3.4',
             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="../../_static/js/bootstrap3.min.js"></script>
@@ -181,7 +178,7 @@ <h3>Quick search</h3>
 <h1>netcal.binning.HistogramBinning<a class="headerlink" href="#netcal-binning-histogrambinning" title="Permalink to this heading">¶</a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="netcal.binning.HistogramBinning">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">netcal.binning.</span></span><span class="sig-name descname"><span class="pre">HistogramBinning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">equal_intervals</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">independent_probabilities</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#netcal.binning.HistogramBinning" title="Permalink to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">netcal.binning.</span></span><span class="sig-name descname"><span class="pre">HistogramBinning</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">equal_intervals</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">independent_probabilities</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#netcal.binning.HistogramBinning" title="Permalink to this definition">¶</a></dt>
 <dd><p>Simple Histogram Binning calibration method.
 This method has been proposed by <a class="footnote-reference brackets" href="#id4" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>.
 Each prediction is sorted into a bin

diff --git a/docs/build/html/_autosummary/_autosummary_binning/netcal.binning.IsotonicRegression.html b/docs/build/html/_autosummary/_autosummary_binning/netcal.binning.IsotonicRegression.html
@@ -35,16 +35,13 @@
 <script type="text/javascript">
   var DOCUMENTATION_OPTIONS = {
             URL_ROOT:    '../../',
-            VERSION:     '1.3.3',
+            VERSION:     '1.3.4',
             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="../../_static/js/bootstrap3.min.js"></script>

diff --git a/docs/build/html/_autosummary/_autosummary_metric/netcal.metrics.ACE.html b/docs/build/html/_autosummary/_autosummary_metric/netcal.metrics.ACE.html
@@ -35,16 +35,13 @@
 <script type="text/javascript">
   var DOCUMENTATION_OPTIONS = {
             URL_ROOT:    '../../',
-            VERSION:     '1.3.3',
+            VERSION:     '1.3.4',
             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>
@@ -190,7 +187,7 @@ <h3>Quick search</h3>
 <h1>netcal.metrics.ACE<a class="headerlink" href="#netcal-metrics-ace" title="Permalink to this heading">¶</a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="netcal.metrics.ACE">
-<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">ACE</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">equal_intervals</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#netcal.metrics.ACE" title="Permalink to this definition">¶</a></dt>
+<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">ACE</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bins</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">equal_intervals</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_threshold</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#netcal.metrics.ACE" title="Permalink to this definition">¶</a></dt>
 <dd><p>Average Calibration Error (ACE) for classification and Detection Average Calibration Error (D-ACE) for
 object detection or segmentation.
 This metric is used on classification <a class="footnote-reference brackets" href="#id3" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a> or as Detection Average Calibration Error (D-ACE)