Skip to content

Commit a6eb19c

Browse files
ASvyatkovskiyASvyatkovskiy
committed
New sphinx documentation pages
1 parent bf52c6b commit a6eb19c

File tree

151 files changed

+24433
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

151 files changed

+24433
-0
lines changed

‎docs/_modules/index.html‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
4+
5+
<html xmlns="http://www.w3.org/1999/xhtml">
6+
<head>
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8+
9+
<title>Overview: module code &#8212; FRNN 0.0.2 documentation</title>
10+
11+
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />
12+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13+
14+
<script type="text/javascript">
15+
var DOCUMENTATION_OPTIONS = {
16+
URL_ROOT: '../',
17+
VERSION: '0.0.2',
18+
COLLAPSE_INDEX: false,
19+
FILE_SUFFIX: '.html',
20+
HAS_SOURCE: true,
21+
SOURCELINK_SUFFIX: '.txt'
22+
};
23+
</script>
24+
<script type="text/javascript" src="../_static/jquery.js"></script>
25+
<script type="text/javascript" src="../_static/underscore.js"></script>
26+
<script type="text/javascript" src="../_static/doctools.js"></script>
27+
<link rel="index" title="Index" href="../genindex.html" />
28+
<link rel="search" title="Search" href="../search.html" />
29+
</head>
30+
<body role="document">
31+
<div class="related" role="navigation" aria-label="related navigation">
32+
<h3>Navigation</h3>
33+
<ul>
34+
<li class="right" style="margin-right: 10px">
35+
<a href="../genindex.html" title="General Index"
36+
accesskey="I">index</a></li>
37+
<li class="nav-item nav-item-0"><a href="../index.html">FRNN 0.0.2 documentation</a> &#187;</li>
38+
</ul>
39+
</div>
40+
41+
<div class="document">
42+
<div class="documentwrapper">
43+
<div class="bodywrapper">
44+
<div class="body" role="main">
45+
46+
<h1>All modules for which code is available</h1>
47+
<ul><li><a href="plasma/models/builder.html">plasma.models.builder</a></li>
48+
<li><a href="plasma/models/loader.html">plasma.models.loader</a></li>
49+
<li><a href="plasma/models/mpi_runner.html">plasma.models.mpi_runner</a></li>
50+
<li><a href="plasma/models/runner.html">plasma.models.runner</a></li>
51+
<li><a href="plasma/models/targets.html">plasma.models.targets</a></li>
52+
<li><a href="plasma/preprocessor/normalize.html">plasma.preprocessor.normalize</a></li>
53+
<li><a href="plasma/preprocessor/preprocess.html">plasma.preprocessor.preprocess</a></li>
54+
<li><a href="plasma/primitives/shots.html">plasma.primitives.shots</a></li>
55+
<li><a href="plasma/utils/evaluation.html">plasma.utils.evaluation</a></li>
56+
<li><a href="plasma/utils/performance.html">plasma.utils.performance</a></li>
57+
<li><a href="plasma/utils/processing.html">plasma.utils.processing</a></li>
58+
</ul>
59+
60+
</div>
61+
</div>
62+
</div>
63+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
64+
<div class="sphinxsidebarwrapper">
65+
<div id="searchbox" style="display: none" role="search">
66+
<h3>Quick search</h3>
67+
<form class="search" action="../search.html" method="get">
68+
<div><input type="text" name="q" /></div>
69+
<div><input type="submit" value="Go" /></div>
70+
<input type="hidden" name="check_keywords" value="yes" />
71+
<input type="hidden" name="area" value="default" />
72+
</form>
73+
</div>
74+
<script type="text/javascript">$('#searchbox').show(0);</script>
75+
</div>
76+
</div>
77+
<div class="clearer"></div>
78+
</div>
79+
<div class="related" role="navigation" aria-label="related navigation">
80+
<h3>Navigation</h3>
81+
<ul>
82+
<li class="right" style="margin-right: 10px">
83+
<a href="../genindex.html" title="General Index"
84+
>index</a></li>
85+
<li class="nav-item nav-item-0"><a href="../index.html">FRNN 0.0.2 documentation</a> &#187;</li>
86+
</ul>
87+
</div>
88+
<div class="footer" role="contentinfo">
89+
&#169; Copyright 2017, FRNN group.
90+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
91+
</div>
92+
</body>
93+
</html>

‎docs/_modules/plasma/models/builder.html‎

Lines changed: 244 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_modules/plasma/models/loader.html‎

Lines changed: 557 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_modules/plasma/models/mpi_runner.html‎

Lines changed: 606 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_modules/plasma/models/runner.html‎

Lines changed: 351 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_modules/plasma/models/targets.html‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
4+
5+
<html xmlns="http://www.w3.org/1999/xhtml">
6+
<head>
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8+
9+
<title>plasma.models.targets &#8212; FRNN 0.0.2 documentation</title>
10+
11+
<link rel="stylesheet" href="../../../_static/classic.css" type="text/css" />
12+
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
13+
14+
<script type="text/javascript">
15+
var DOCUMENTATION_OPTIONS = {
16+
URL_ROOT: '../../../',
17+
VERSION: '0.0.2',
18+
COLLAPSE_INDEX: false,
19+
FILE_SUFFIX: '.html',
20+
HAS_SOURCE: true,
21+
SOURCELINK_SUFFIX: '.txt'
22+
};
23+
</script>
24+
<script type="text/javascript" src="../../../_static/jquery.js"></script>
25+
<script type="text/javascript" src="../../../_static/underscore.js"></script>
26+
<script type="text/javascript" src="../../../_static/doctools.js"></script>
27+
<link rel="index" title="Index" href="../../../genindex.html" />
28+
<link rel="search" title="Search" href="../../../search.html" />
29+
</head>
30+
<body role="document">
31+
<div class="related" role="navigation" aria-label="related navigation">
32+
<h3>Navigation</h3>
33+
<ul>
34+
<li class="right" style="margin-right: 10px">
35+
<a href="../../../genindex.html" title="General Index"
36+
accesskey="I">index</a></li>
37+
<li class="nav-item nav-item-0"><a href="../../../index.html">FRNN 0.0.2 documentation</a> &#187;</li>
38+
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>
39+
</ul>
40+
</div>
41+
42+
<div class="document">
43+
<div class="documentwrapper">
44+
<div class="bodywrapper">
45+
<div class="body" role="main">
46+
47+
<h1>Source code for plasma.models.targets</h1><div class="highlight"><pre>
48+
<span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
49+
<span class="kn">import</span> <span class="nn">abc</span>
50+
51+
52+
<span class="c1">#Requirement: larger value must mean disruption more likely.</span>
53+
<div class="viewcode-block" id="Target"><a class="viewcode-back" href="../../../plasma.models.targets.Target.html#plasma.models.targets.Target">[docs]</a><span class="k">class</span> <span class="nc">Target</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
54+
<span class="n">activation</span> <span class="o">=</span> <span class="s1">&#39;linear&#39;</span>
55+
<span class="n">loss</span> <span class="o">=</span> <span class="s1">&#39;mse&#39;</span>
56+
57+
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
58+
<span class="k">def</span> <span class="nf">remapper</span><span class="p">(</span><span class="n">ttd</span><span class="p">,</span><span class="n">T_warning</span><span class="p">):</span>
59+
<span class="k">return</span> <span class="o">-</span><span class="n">ttd</span>
60+
61+
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
62+
<span class="k">def</span> <span class="nf">threshold_range</span><span class="p">(</span><span class="n">T_warning</span><span class="p">):</span>
63+
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">logspace</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span><span class="mi">4</span><span class="p">,</span><span class="mi">100</span><span class="p">)</span></div>
64+
65+
66+
<div class="viewcode-block" id="BinaryTarget"><a class="viewcode-back" href="../../../plasma.models.targets.BinaryTarget.html#plasma.models.targets.BinaryTarget">[docs]</a><span class="k">class</span> <span class="nc">BinaryTarget</span><span class="p">(</span><span class="n">Target</span><span class="p">):</span>
67+
<span class="n">activation</span> <span class="o">=</span> <span class="s1">&#39;sigmoid&#39;</span>
68+
<span class="n">loss</span> <span class="o">=</span> <span class="s1">&#39;binary_crossentropy&#39;</span>
69+
70+
71+
<span class="nd">@staticmethod</span>
72+
<span class="k">def</span> <span class="nf">remapper</span><span class="p">(</span><span class="n">ttd</span><span class="p">,</span><span class="n">T_warning</span><span class="p">,</span><span class="n">as_array_of_shots</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
73+
<span class="n">binary_ttd</span> <span class="o">=</span> <span class="mi">0</span><span class="o">*</span><span class="n">ttd</span>
74+
<span class="n">mask</span> <span class="o">=</span> <span class="n">ttd</span> <span class="o">&lt;</span> <span class="n">np</span><span class="o">.</span><span class="n">log10</span><span class="p">(</span><span class="n">T_warning</span><span class="p">)</span>
75+
<span class="n">binary_ttd</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="mf">1.0</span>
76+
<span class="n">binary_ttd</span><span class="p">[</span><span class="o">~</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.0</span>
77+
<span class="k">return</span> <span class="n">binary_ttd</span>
78+
79+
<span class="nd">@staticmethod</span>
80+
<span class="k">def</span> <span class="nf">threshold_range</span><span class="p">(</span><span class="n">T_warning</span><span class="p">):</span>
81+
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">logspace</span><span class="p">(</span><span class="o">-</span><span class="mi">6</span><span class="p">,</span><span class="mi">0</span><span class="p">,</span><span class="mi">100</span><span class="p">)</span></div>
82+
83+
84+
<div class="viewcode-block" id="TTDTarget"><a class="viewcode-back" href="../../../plasma.models.targets.TTDTarget.html#plasma.models.targets.TTDTarget">[docs]</a><span class="k">class</span> <span class="nc">TTDTarget</span><span class="p">(</span><span class="n">Target</span><span class="p">):</span>
85+
<span class="n">activation</span> <span class="o">=</span> <span class="s1">&#39;linear&#39;</span>
86+
<span class="n">loss</span> <span class="o">=</span> <span class="s1">&#39;mse&#39;</span>
87+
88+
<span class="nd">@staticmethod</span>
89+
<span class="k">def</span> <span class="nf">remapper</span><span class="p">(</span><span class="n">ttd</span><span class="p">,</span><span class="n">T_warning</span><span class="p">):</span>
90+
<span class="n">mask</span> <span class="o">=</span> <span class="n">ttd</span> <span class="o">&lt;</span> <span class="n">np</span><span class="o">.</span><span class="n">log10</span><span class="p">(</span><span class="n">T_warning</span><span class="p">)</span>
91+
<span class="n">ttd</span><span class="p">[</span><span class="o">~</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">log10</span><span class="p">(</span><span class="n">T_warning</span><span class="p">)</span>
92+
<span class="k">return</span> <span class="o">-</span><span class="n">ttd</span>
93+
94+
<span class="nd">@staticmethod</span>
95+
<span class="k">def</span> <span class="nf">threshold_range</span><span class="p">(</span><span class="n">T_warning</span><span class="p">):</span>
96+
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="o">-</span><span class="n">np</span><span class="o">.</span><span class="n">log10</span><span class="p">(</span><span class="n">T_warning</span><span class="p">),</span><span class="mi">6</span><span class="p">,</span><span class="mi">100</span><span class="p">)</span></div>
97+
98+
99+
100+
<div class="viewcode-block" id="TTDLinearTarget"><a class="viewcode-back" href="../../../plasma.models.targets.TTDLinearTarget.html#plasma.models.targets.TTDLinearTarget">[docs]</a><span class="k">class</span> <span class="nc">TTDLinearTarget</span><span class="p">(</span><span class="n">Target</span><span class="p">):</span>
101+
<span class="n">activation</span> <span class="o">=</span> <span class="s1">&#39;linear&#39;</span>
102+
<span class="n">loss</span> <span class="o">=</span> <span class="s1">&#39;mse&#39;</span>
103+
104+
<span class="nd">@staticmethod</span>
105+
<span class="k">def</span> <span class="nf">remapper</span><span class="p">(</span><span class="n">ttd</span><span class="p">,</span><span class="n">T_warning</span><span class="p">):</span>
106+
<span class="n">ttd</span> <span class="o">=</span> <span class="mi">10</span><span class="o">**</span><span class="p">(</span><span class="n">ttd</span><span class="p">)</span>
107+
<span class="n">mask</span> <span class="o">=</span> <span class="n">ttd</span> <span class="o">&lt;</span> <span class="n">T_warning</span>
108+
<span class="n">ttd</span><span class="p">[</span><span class="o">~</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span><span class="c1">#T_warning</span>
109+
<span class="n">ttd</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="n">T_warning</span> <span class="o">-</span> <span class="n">ttd</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span><span class="c1">#T_warning</span>
110+
<span class="k">return</span> <span class="n">ttd</span>
111+
112+
<span class="nd">@staticmethod</span>
113+
<span class="k">def</span> <span class="nf">threshold_range</span><span class="p">(</span><span class="n">T_warning</span><span class="p">):</span>
114+
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">logspace</span><span class="p">(</span><span class="o">-</span><span class="mi">6</span><span class="p">,</span><span class="n">np</span><span class="o">.</span><span class="n">log10</span><span class="p">(</span><span class="n">T_warning</span><span class="p">),</span><span class="mi">100</span><span class="p">)</span></div>
115+
116+
117+
<div class="viewcode-block" id="HingeTarget"><a class="viewcode-back" href="../../../plasma.models.targets.HingeTarget.html#plasma.models.targets.HingeTarget">[docs]</a><span class="k">class</span> <span class="nc">HingeTarget</span><span class="p">(</span><span class="n">Target</span><span class="p">):</span>
118+
<span class="n">activation</span> <span class="o">=</span> <span class="s1">&#39;linear&#39;</span>
119+
<span class="n">loss</span> <span class="o">=</span> <span class="s1">&#39;squared_hinge&#39;</span>
120+
121+
<span class="nd">@staticmethod</span>
122+
<span class="k">def</span> <span class="nf">remapper</span><span class="p">(</span><span class="n">ttd</span><span class="p">,</span><span class="n">T_warning</span><span class="p">,</span><span class="n">as_array_of_shots</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
123+
<span class="n">binary_ttd</span> <span class="o">=</span> <span class="mi">0</span><span class="o">*</span><span class="n">ttd</span>
124+
<span class="n">mask</span> <span class="o">=</span> <span class="n">ttd</span> <span class="o">&lt;</span> <span class="n">np</span><span class="o">.</span><span class="n">log10</span><span class="p">(</span><span class="n">T_warning</span><span class="p">)</span>
125+
<span class="n">binary_ttd</span><span class="p">[</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="mf">1.0</span>
126+
<span class="n">binary_ttd</span><span class="p">[</span><span class="o">~</span><span class="n">mask</span><span class="p">]</span> <span class="o">=</span> <span class="o">-</span><span class="mf">1.0</span>
127+
<span class="k">return</span> <span class="n">binary_ttd</span>
128+
129+
<span class="nd">@staticmethod</span>
130+
<span class="k">def</span> <span class="nf">threshold_range</span><span class="p">(</span><span class="n">T_warning</span><span class="p">):</span>
131+
<span class="k">return</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">((</span><span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="o">-</span><span class="mi">2</span><span class="p">,</span><span class="o">-</span><span class="mf">1.06</span><span class="p">,</span><span class="mi">100</span><span class="p">),</span><span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="o">-</span><span class="mf">1.06</span><span class="p">,</span><span class="o">-</span><span class="mf">0.96</span><span class="p">,</span><span class="mi">100</span><span class="p">),</span><span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="o">-</span><span class="mf">0.96</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="mi">50</span><span class="p">)))</span></div>
132+
</pre></div>
133+
134+
</div>
135+
</div>
136+
</div>
137+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
138+
<div class="sphinxsidebarwrapper">
139+
<div id="searchbox" style="display: none" role="search">
140+
<h3>Quick search</h3>
141+
<form class="search" action="../../../search.html" method="get">
142+
<div><input type="text" name="q" /></div>
143+
<div><input type="submit" value="Go" /></div>
144+
<input type="hidden" name="check_keywords" value="yes" />
145+
<input type="hidden" name="area" value="default" />
146+
</form>
147+
</div>
148+
<script type="text/javascript">$('#searchbox').show(0);</script>
149+
</div>
150+
</div>
151+
<div class="clearer"></div>
152+
</div>
153+
<div class="related" role="navigation" aria-label="related navigation">
154+
<h3>Navigation</h3>
155+
<ul>
156+
<li class="right" style="margin-right: 10px">
157+
<a href="../../../genindex.html" title="General Index"
158+
>index</a></li>
159+
<li class="nav-item nav-item-0"><a href="../../../index.html">FRNN 0.0.2 documentation</a> &#187;</li>
160+
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
161+
</ul>
162+
</div>
163+
<div class="footer" role="contentinfo">
164+
&#169; Copyright 2017, FRNN group.
165+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
166+
</div>
167+
</body>
168+
</html>

0 commit comments

Comments
 (0)