Skip to content

Commit f1316bb

Browse files
bajo1207bajo1207
authored
Merge pull request #50 from MDAIceland/documentation_gen
 Documentation Generation
2 parents 8fb1cd3 + 915291b commit f1316bb

29 files changed

+328915
-1
lines changed

‎.docignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
WaterSecurity.data
2+
WaterSecurity.documentation
3+
WaterSecurity.run
4+
WaterSecurity.generate_documentation

‎__init__.py

Whitespace-only changes.

‎documentation/WaterSecurity/classification/classifier.html

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6+
<meta name="generator" content="pdoc 0.9.2" />
7+
<title>WaterSecurity.classification.classifier API documentation</title>
8+
<meta name="description" content="" />
9+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
10+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
11+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
12+
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
13+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
14+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
15+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
16+
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
17+
</head>
18+
<body>
19+
<main>
20+
<article id="content">
21+
<header>
22+
<h1 class="title">Module <code>WaterSecurity.classification.classifier</code></h1>
23+
</header>
24+
<section id="section-intro">
25+
<details class="source">
26+
<summary>
27+
<span>Expand source code</span>
28+
</summary>
29+
<pre><code class="python">from sklearn.base import BaseEstimator, RegressorMixin
30+
import numpy as np
31+
32+
33+
class Classifier(BaseEstimator, RegressorMixin):
34+
# @TODO implement
35+
def fit(self, x_data, y_data):
36+
&#34;&#34;&#34;
37+
x_data: the nxm features
38+
y_data: the n labels, with values 0,1,2 or 3
39+
&#34;&#34;&#34;
40+
return self
41+
42+
def predict(self, x_data):
43+
&#34;&#34;&#34;
44+
x_data: the nxm features
45+
Returns n predictions, which have values 0 to 3, they can be floats
46+
&#34;&#34;&#34;
47+
return np.zeros(x_data.shape[0])</code></pre>
48+
</details>
49+
</section>
50+
<section>
51+
</section>
52+
<section>
53+
</section>
54+
<section>
55+
</section>
56+
<section>
57+
<h2 class="section-title" id="header-classes">Classes</h2>
58+
<dl>
59+
<dt id="WaterSecurity.classification.classifier.Classifier"><code class="flex name class">
60+
<span>class <span class="ident">Classifier</span></span>
61+
</code></dt>
62+
<dd>
63+
<div class="desc"><p>Base class for all estimators in scikit-learn.</p>
64+
<h2 id="notes">Notes</h2>
65+
<p>All estimators should specify all the parameters that can be set
66+
at the class level in their <code>__init__</code> as explicit keyword
67+
arguments (no <code>*args</code> or <code>**kwargs</code>).</p></div>
68+
<details class="source">
69+
<summary>
70+
<span>Expand source code</span>
71+
</summary>
72+
<pre><code class="python">class Classifier(BaseEstimator, RegressorMixin):
73+
# @TODO implement
74+
def fit(self, x_data, y_data):
75+
&#34;&#34;&#34;
76+
x_data: the nxm features
77+
y_data: the n labels, with values 0,1,2 or 3
78+
&#34;&#34;&#34;
79+
return self
80+
81+
def predict(self, x_data):
82+
&#34;&#34;&#34;
83+
x_data: the nxm features
84+
Returns n predictions, which have values 0 to 3, they can be floats
85+
&#34;&#34;&#34;
86+
return np.zeros(x_data.shape[0])</code></pre>
87+
</details>
88+
<h3>Ancestors</h3>
89+
<ul class="hlist">
90+
<li>sklearn.base.BaseEstimator</li>
91+
<li>sklearn.base.RegressorMixin</li>
92+
</ul>
93+
<h3>Methods</h3>
94+
<dl>
95+
<dt id="WaterSecurity.classification.classifier.Classifier.fit"><code class="name flex">
96+
<span>def <span class="ident">fit</span></span>(<span>self, x_data, y_data)</span>
97+
</code></dt>
98+
<dd>
99+
<div class="desc"><p>x_data: the nxm features
100+
y_data: the n labels, with values 0,1,2 or 3</p></div>
101+
<details class="source">
102+
<summary>
103+
<span>Expand source code</span>
104+
</summary>
105+
<pre><code class="python">def fit(self, x_data, y_data):
106+
&#34;&#34;&#34;
107+
x_data: the nxm features
108+
y_data: the n labels, with values 0,1,2 or 3
109+
&#34;&#34;&#34;
110+
return self</code></pre>
111+
</details>
112+
</dd>
113+
<dt id="WaterSecurity.classification.classifier.Classifier.predict"><code class="name flex">
114+
<span>def <span class="ident">predict</span></span>(<span>self, x_data)</span>
115+
</code></dt>
116+
<dd>
117+
<div class="desc"><p>x_data: the nxm features
118+
Returns n predictions, which have values 0 to 3, they can be floats</p></div>
119+
<details class="source">
120+
<summary>
121+
<span>Expand source code</span>
122+
</summary>
123+
<pre><code class="python">def predict(self, x_data):
124+
&#34;&#34;&#34;
125+
x_data: the nxm features
126+
Returns n predictions, which have values 0 to 3, they can be floats
127+
&#34;&#34;&#34;
128+
return np.zeros(x_data.shape[0])</code></pre>
129+
</details>
130+
</dd>
131+
</dl>
132+
</dd>
133+
</dl>
134+
</section>
135+
</article>
136+
<nav id="sidebar">
137+
<h1>Index</h1>
138+
<div class="toc">
139+
<ul></ul>
140+
</div>
141+
<ul id="index">
142+
<li><h3>Super-module</h3>
143+
<ul>
144+
<li><code><a title="WaterSecurity.classification" href="index.html">WaterSecurity.classification</a></code></li>
145+
</ul>
146+
</li>
147+
<li><h3><a href="#header-classes">Classes</a></h3>
148+
<ul>
149+
<li>
150+
<h4><code><a title="WaterSecurity.classification.classifier.Classifier" href="#WaterSecurity.classification.classifier.Classifier">Classifier</a></code></h4>
151+
<ul class="">
152+
<li><code><a title="WaterSecurity.classification.classifier.Classifier.fit" href="#WaterSecurity.classification.classifier.Classifier.fit">fit</a></code></li>
153+
<li><code><a title="WaterSecurity.classification.classifier.Classifier.predict" href="#WaterSecurity.classification.classifier.Classifier.predict">predict</a></code></li>
154+
</ul>
155+
</li>
156+
</ul>
157+
</li>
158+
</ul>
159+
</nav>
160+
</main>
161+
<footer id="footer">
162+
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.9.2</a>.</p>
163+
</footer>
164+
</body>
165+
</html>

0 commit comments

Comments
 (0)