-
Notifications
You must be signed in to change notification settings - Fork 0
/
quick_start.html
162 lines (145 loc) · 8.86 KB
/
quick_start.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Quick Start — uncertainty-toolbox 0.1.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="shortcut icon" href="_static/square_logo_only.png"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API Reference" href="api_reference/index.html" />
<link rel="prev" title="Installation" href="installation.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: white" >
<a href="index.html" class="icon icon-home"> uncertainty-toolbox
<img src="_static/logo.svg" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Quick Start</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#minimal-example">Minimal example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_reference/index.html">API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_reference/data.html">data module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/data.html#module-uncertainty_toolbox.data">uncertainty_toolbox.data Module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/metrics.html">metrics module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/metrics.html#module-uncertainty_toolbox.metrics">uncertainty_toolbox.metrics Module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/metrics_calibration.html">metrics_calibration module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/metrics_calibration.html#module-uncertainty_toolbox.metrics_calibration">uncertainty_toolbox.metrics_calibration Module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/metrics_accuracy.html">metrics_accuracy module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/metrics_accuracy.html#module-uncertainty_toolbox.metrics_accuracy">uncertainty_toolbox.metrics_accuracy Module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/metrics_scoring_rule.html">metrics_scoring_rule module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/metrics_scoring_rule.html#module-uncertainty_toolbox.metrics_scoring_rule">uncertainty_toolbox.metrics_scoring_rule Module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/recalibration.html">recalibration module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/recalibration.html#module-uncertainty_toolbox.recalibration">uncertainty_toolbox.recalibration Module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/utils.html">utils module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/utils.html#module-uncertainty_toolbox.utils">uncertainty_toolbox.utils Module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="api_reference/viz.html">viz module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="api_reference/viz.html#module-uncertainty_toolbox.viz">uncertainty_toolbox.viz Module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: white" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">uncertainty-toolbox</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li>Quick Start</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/quick_start.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="quick-start">
<h1>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this heading"></a></h1>
<p>This is a quick start tutorial for Uncertainty Toolbox. For a longer tutorial, <a class="reference external" href="https://uncertainty-toolbox.github.io/tutorial">see here</a>.</p>
<section id="minimal-example">
<h2>Minimal example<a class="headerlink" href="#minimal-example" title="Permalink to this heading"></a></h2>
<p>This example computes a set of metrics for a vector of predicted values (<cite>predictions</cite>)
and associated uncertainties (<cite>predictions_std</cite>, a vector of standard deviations), taken
with respect to a corresponding set of observed values <cite>y</cite>.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">uncertainty_toolbox</span> <span class="k">as</span> <span class="nn">uct</span>
<span class="c1"># Load an example dataset of 100 predictions, uncertainties, and observations</span>
<span class="n">predictions</span><span class="p">,</span> <span class="n">predictions_std</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">x</span> <span class="o">=</span> <span class="n">uct</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">synthetic_sine_heteroscedastic</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span>
<span class="c1"># Compute all uncertainty metrics</span>
<span class="n">metrics</span> <span class="o">=</span> <span class="n">uct</span><span class="o">.</span><span class="n">metrics</span><span class="o">.</span><span class="n">get_all_metrics</span><span class="p">(</span><span class="n">predictions</span><span class="p">,</span> <span class="n">predictions_std</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
</pre></div>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="installation.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="api_reference/index.html" class="btn btn-neutral float-right" title="API Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2021, uncertainty-toolbox team.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>