Skip to content
This repository was archived by the owner on May 5, 2020. It is now read-only.

Commit a04f7a7

Browse files
author
__sp__
committed
Update dev docs
1 parent 8bb8989 commit a04f7a7

21 files changed

Lines changed: 2016 additions & 44 deletions

‎docs/genindex.html‎

Lines changed: 358 additions & 8 deletions
Large diffs are not rendered by default.

‎docs/index.html‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,22 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
5757
</pre></div>
5858
</div>
5959
</div>
60+
<div class="section" id="changes">
61+
<h1>Changes<a class="headerlink" href="#changes" title="Permalink to this headline"></a></h1>
62+
<div class="section" id="v0-0-2">
63+
<h2>v0.0.2<a class="headerlink" href="#v0-0-2" title="Permalink to this headline"></a></h2>
64+
<ul class="simple">
65+
<li>ELSIE spectrum matching algorithm.</li>
66+
<li>Improvements to NeuralNetwork and new LinearModel.</li>
67+
</ul>
68+
</div>
69+
<div class="section" id="v0-0-1">
70+
<h2>v0.0.1<a class="headerlink" href="#v0-0-1" title="Permalink to this headline"></a></h2>
71+
<ul class="simple">
72+
<li>Initial release of basic abstract models and implementation of neural net.</li>
73+
</ul>
74+
</div>
75+
</div>
6076
<div class="section" id="general-concepts">
6177
<h1>General concepts<a class="headerlink" href="#general-concepts" title="Permalink to this headline"></a></h1>
6278
<p>Veidt works by abstracting some common tasks to high-level classes. For example,
@@ -99,7 +115,13 @@ <h1>API docs<a class="headerlink" href="#api-docs" title="Permalink to this head
99115
<div class="toctree-wrapper compound">
100116
<ul>
101117
<li class="toctree-l1"><a class="reference internal" href="veidt.html">veidt package</a><ul>
102-
<li class="toctree-l2"><a class="reference internal" href="veidt.html#subpackages">Subpackages</a><ul class="simple">
118+
<li class="toctree-l2"><a class="reference internal" href="veidt.html#subpackages">Subpackages</a><ul>
119+
<li class="toctree-l3"><a class="reference internal" href="veidt.elsie.html">veidt.elsie package</a><ul>
120+
<li class="toctree-l4"><a class="reference internal" href="veidt.elsie.html#subpackages">Subpackages</a></li>
121+
<li class="toctree-l4"><a class="reference internal" href="veidt.elsie.html#submodules">Submodules</a></li>
122+
<li class="toctree-l4"><a class="reference internal" href="veidt.elsie.html#module-veidt.elsie">Module contents</a></li>
123+
</ul>
124+
</li>
103125
</ul>
104126
</li>
105127
<li class="toctree-l2"><a class="reference internal" href="veidt.html#submodules">Submodules</a><ul>

‎docs/modules.html‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,21 @@ <h1>veidt<a class="headerlink" href="#veidt" title="Permalink to this headline">
4444
<div class="toctree-wrapper compound">
4545
<ul>
4646
<li class="toctree-l1"><a class="reference internal" href="veidt.html">veidt package</a><ul>
47-
<li class="toctree-l2"><a class="reference internal" href="veidt.html#subpackages">Subpackages</a><ul class="simple">
47+
<li class="toctree-l2"><a class="reference internal" href="veidt.html#subpackages">Subpackages</a><ul>
48+
<li class="toctree-l3"><a class="reference internal" href="veidt.elsie.html">veidt.elsie package</a><ul>
49+
<li class="toctree-l4"><a class="reference internal" href="veidt.elsie.html#subpackages">Subpackages</a><ul class="simple">
50+
</ul>
51+
</li>
52+
<li class="toctree-l4"><a class="reference internal" href="veidt.elsie.html#submodules">Submodules</a><ul>
53+
<li class="toctree-l5"><a class="reference internal" href="veidt.elsie.ensemble.html">veidt.elsie.ensemble module</a></li>
54+
<li class="toctree-l5"><a class="reference internal" href="veidt.elsie.preprocessing.html">veidt.elsie.preprocessing module</a></li>
55+
<li class="toctree-l5"><a class="reference internal" href="veidt.elsie.similarity_measures.html">veidt.elsie.similarity_measures module</a></li>
56+
<li class="toctree-l5"><a class="reference internal" href="veidt.elsie.spectra_similarity.html">veidt.elsie.spectra_similarity module</a></li>
57+
</ul>
58+
</li>
59+
<li class="toctree-l4"><a class="reference internal" href="veidt.elsie.html#module-veidt.elsie">Module contents</a></li>
60+
</ul>
61+
</li>
4862
</ul>
4963
</li>
5064
<li class="toctree-l2"><a class="reference internal" href="veidt.html#submodules">Submodules</a><ul>

‎docs/objects.inv‎

1004 Bytes
Binary file not shown.

‎docs/py-modindex.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,31 @@ <h1>Python Module Index</h1>
6969
<td>&#160;&#160;&#160;
7070
<a href="veidt.descriptors.html#module-veidt.descriptors"><code class="xref">veidt.descriptors</code></a></td><td>
7171
<em></em></td></tr>
72+
<tr class="cg-1">
73+
<td></td>
74+
<td>&#160;&#160;&#160;
75+
<a href="veidt.elsie.html#module-veidt.elsie"><code class="xref">veidt.elsie</code></a></td><td>
76+
<em></em></td></tr>
77+
<tr class="cg-1">
78+
<td></td>
79+
<td>&#160;&#160;&#160;
80+
<a href="veidt.elsie.ensemble.html#module-veidt.elsie.ensemble"><code class="xref">veidt.elsie.ensemble</code></a></td><td>
81+
<em></em></td></tr>
82+
<tr class="cg-1">
83+
<td></td>
84+
<td>&#160;&#160;&#160;
85+
<a href="veidt.elsie.preprocessing.html#module-veidt.elsie.preprocessing"><code class="xref">veidt.elsie.preprocessing</code></a></td><td>
86+
<em></em></td></tr>
87+
<tr class="cg-1">
88+
<td></td>
89+
<td>&#160;&#160;&#160;
90+
<a href="veidt.elsie.similarity_measures.html#module-veidt.elsie.similarity_measures"><code class="xref">veidt.elsie.similarity_measures</code></a></td><td>
91+
<em></em></td></tr>
92+
<tr class="cg-1">
93+
<td></td>
94+
<td>&#160;&#160;&#160;
95+
<a href="veidt.elsie.spectra_similarity.html#module-veidt.elsie.spectra_similarity"><code class="xref">veidt.elsie.spectra_similarity</code></a></td><td>
96+
<em></em></td></tr>
7297
<tr class="cg-1">
7398
<td></td>
7499
<td>&#160;&#160;&#160;

‎docs/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/veidt.abstract.html‎

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
<link rel="index" title="Index" href="genindex.html" />
2626
<link rel="search" title="Search" href="search.html" />
2727
<link rel="next" title="veidt.descriptors module" href="veidt.descriptors.html" />
28-
<link rel="prev" title="veidt package" href="veidt.html" />
28+
<link rel="prev" title="veidt.elsie.spectra_similarity module" href="veidt.elsie.spectra_similarity.html" />
2929

3030
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
3131

@@ -62,18 +62,20 @@
6262
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj</strong> – Object</td>
6363
</tr>
6464
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Descriptor for a structure. Recommended format is a pandas
65-
Series or Dataframe object for easy manipulation. For example, a
66-
simple site descriptor of the fractional coordinates (this is
67-
usually a bad descriptor, so it is just for illustration purposes)
68-
can be generated as:<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">frac_coords</span><span class="p">,</span> <span class="n">columns</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;a&quot;</span><span class="p">,</span> <span class="s2">&quot;b&quot;</span><span class="p">,</span> <span class="s2">&quot;c&quot;</span><span class="p">]))</span>
65+
Dataframe object with the column names as intuitive names.
66+
For example, a simple site descriptor of the fractional coordinates
67+
(this is usually a bad descriptor, so it is just for illustration
68+
purposes) can be generated as:<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">frac_coords</span><span class="p">,</span> <span class="n">columns</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;a&quot;</span><span class="p">,</span> <span class="s2">&quot;b&quot;</span><span class="p">,</span> <span class="s2">&quot;c&quot;</span><span class="p">]))</span>
6969
<span class="n">a</span> <span class="n">b</span> <span class="n">c</span>
7070
<span class="mi">0</span> <span class="mf">0.000000</span> <span class="mf">0.000000</span> <span class="mf">0.000000</span>
7171
<span class="mi">1</span> <span class="mf">0.750178</span> <span class="mf">0.750178</span> <span class="mf">0.750178</span>
7272
<span class="mi">2</span> <span class="mf">0.249822</span> <span class="mf">0.249822</span> <span class="mf">0.249822</span>
7373
</pre></div>
7474
</div>
7575
<p>Pandas dataframes can be dumped to a variety of formats (json, csv,
76-
etc.) easily.</p>
76+
etc.) easily. Note that a dataframe should be used even if you have
77+
only one line, i.e., do not use Series objects unless you know
78+
what you are doing.</p>
7779
</td>
7880
</tr>
7981
</tbody>
@@ -92,7 +94,9 @@
9294
<tbody valign="top">
9395
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>objs</strong> – List of objects</td>
9496
</tr>
95-
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of descriptors</td>
97+
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Concatenated descriptions for all objects. Recommended format
98+
is a pandas DataFrame. Default implement returns a list of
99+
descriptors generated by a loop call to describe for each obj.</td>
96100
</tr>
97101
</tbody>
98102
</table>
@@ -109,15 +113,33 @@
109113
transparent conversion of arbitrary input and outputs.</p>
110114
<dl class="method">
111115
<dt id="veidt.abstract.Model.fit">
112-
<code class="descname">fit</code><span class="sig-paren">(</span><em>inputs</em>, <em>outputs</em><span class="sig-paren">)</span><a class="headerlink" href="#veidt.abstract.Model.fit" title="Permalink to this definition"></a></dt>
113-
<dd><p>Fit the model.</p>
116+
<code class="descname">fit</code><span class="sig-paren">(</span><em>features</em>, <em>targets</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#veidt.abstract.Model.fit" title="Permalink to this definition"></a></dt>
117+
<dd><table class="docutils field-list" frame="void" rules="none">
118+
<col class="field-name" />
119+
<col class="field-body" />
120+
<tbody valign="top">
121+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
122+
<li><strong>features</strong> – Numerical input feature list or numpy array with dim (m, n)
123+
where m is the number of data and n is the feature dimension</li>
124+
<li><strong>targets</strong> – Numerical output target list, or numpy array with dim (m, )</li>
125+
</ul>
126+
</td>
127+
</tr>
128+
</tbody>
129+
</table>
130+
</dd></dl>
131+
132+
<dl class="method">
133+
<dt id="veidt.abstract.Model.fit_object">
134+
<code class="descname">fit_object</code><span class="sig-paren">(</span><em>inputs</em>, <em>outputs</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#veidt.abstract.Model.fit_object" title="Permalink to this definition"></a></dt>
135+
<dd><p>Fit the model with objects as inputs and outputs</p>
114136
<table class="docutils field-list" frame="void" rules="none">
115137
<col class="field-name" />
116138
<col class="field-body" />
117139
<tbody valign="top">
118140
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
119141
<li><strong>inputs</strong> – List of input objects</li>
120-
<li><strong>outputs</strong> – List of output objects</li>
142+
<li><strong>outputs</strong> – List of output objects or target outputs</li>
121143
</ul>
122144
</td>
123145
</tr>
@@ -180,7 +202,7 @@ <h3>Related Topics</h3>
180202
<ul>
181203
<li><a href="index.html">Documentation overview</a><ul>
182204
<li><a href="veidt.html">veidt package</a><ul>
183-
<li>Previous: <a href="veidt.html" title="previous chapter">veidt package</a></li>
205+
<li>Previous: <a href="veidt.elsie.spectra_similarity.html" title="previous chapter">veidt.elsie.spectra_similarity module</a></li>
184206
<li>Next: <a href="veidt.descriptors.html" title="next chapter">veidt.descriptors module</a></li>
185207
</ul></li>
186208
</ul></li>

‎docs/veidt.descriptors.html‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,49 @@
5555
<code class="descname">describe</code><span class="sig-paren">(</span><em>structure</em><span class="sig-paren">)</span><a class="headerlink" href="#veidt.descriptors.DistinctSiteProperty.describe" title="Permalink to this definition"></a></dt>
5656
<dd></dd></dl>
5757

58+
<dl class="method">
59+
<dt id="veidt.descriptors.DistinctSiteProperty.describe_all">
60+
<code class="descname">describe_all</code><span class="sig-paren">(</span><em>objs</em><span class="sig-paren">)</span><a class="headerlink" href="#veidt.descriptors.DistinctSiteProperty.describe_all" title="Permalink to this definition"></a></dt>
61+
<dd></dd></dl>
62+
63+
</dd></dl>
64+
65+
<dl class="class">
66+
<dt id="veidt.descriptors.FuncGenerator">
67+
<em class="property">class </em><code class="descclassname">veidt.descriptors.</code><code class="descname">FuncGenerator</code><span class="sig-paren">(</span><em>func_dict</em>, <em>append=True</em><span class="sig-paren">)</span><a class="headerlink" href="#veidt.descriptors.FuncGenerator" title="Permalink to this definition"></a></dt>
68+
<dd><p>Bases: <a class="reference internal" href="veidt.abstract.html#veidt.abstract.Describer" title="veidt.abstract.Describer"><code class="xref py py-class docutils literal"><span class="pre">veidt.abstract.Describer</span></code></a></p>
69+
<p>General transformer for arrays. In principle, any numerical
70+
operations can be done as long as each involved function has a
71+
NumPy.ufunc implementation, e.g., np.sin, np.exp…</p>
72+
<dl class="method">
73+
<dt id="veidt.descriptors.FuncGenerator.describe">
74+
<code class="descname">describe</code><span class="sig-paren">(</span><em>df</em><span class="sig-paren">)</span><a class="headerlink" href="#veidt.descriptors.FuncGenerator.describe" title="Permalink to this definition"></a></dt>
75+
<dd><p>Returns description of an object based on all functions.</p>
76+
<table class="docutils field-list" frame="void" rules="none">
77+
<col class="field-name" />
78+
<col class="field-body" />
79+
<tbody valign="top">
80+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>df</strong> – DataFrame with input data.</td>
81+
</tr>
82+
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DataFrame with transformed data.</td>
83+
</tr>
84+
</tbody>
85+
</table>
86+
</dd></dl>
87+
88+
</dd></dl>
89+
90+
<dl class="class">
91+
<dt id="veidt.descriptors.MultiDescriber">
92+
<em class="property">class </em><code class="descclassname">veidt.descriptors.</code><code class="descname">MultiDescriber</code><span class="sig-paren">(</span><em>describers</em><span class="sig-paren">)</span><a class="headerlink" href="#veidt.descriptors.MultiDescriber" title="Permalink to this definition"></a></dt>
93+
<dd><p>Bases: <a class="reference internal" href="veidt.abstract.html#veidt.abstract.Describer" title="veidt.abstract.Describer"><code class="xref py py-class docutils literal"><span class="pre">veidt.abstract.Describer</span></code></a></p>
94+
<p>This is a generic multiple describer that allows one to combine multiple
95+
describers.</p>
96+
<dl class="method">
97+
<dt id="veidt.descriptors.MultiDescriber.describe">
98+
<code class="descname">describe</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#veidt.descriptors.MultiDescriber.describe" title="Permalink to this definition"></a></dt>
99+
<dd></dd></dl>
100+
58101
</dd></dl>
59102

60103
</div>

0 commit comments

Comments
 (0)