Skip to content

Commit

Permalink
Clean up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
f0uriest committed Oct 11, 2020
1 parent 8e7bbe7 commit 91a91be
Show file tree
Hide file tree
Showing 16 changed files with 32 additions and 35 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ It can also be used with a python environment in the following manner:
from keras2c import k2c
k2c(model, function_name, malloc=False, num_tests=10, verbose=True)
For more information, see `Installation<https://keras2c.readthedocs.io/docs/_build/html/installation.html>`_ and `Usage<https://keras2c.readthedocs.io/docs/_build/html/usage.html>`_
For more information, see `Installation <https://f0uriest.github.io/keras2c/installation.html>`_ and `Usage <https://f0uriest.github.io/keras2c/usage.html>`_


Supported Layers
Expand Down Expand Up @@ -73,7 +73,7 @@ ToDo
Contribute
**********

- Documentation: `<https://keras2c.readthedocs.io>`_
- Documentation: `<https://f0uriest.github.io/keras2c/>`_
- Issue Tracker: `<https://github.com/f0uriest/keras2c/issues>`_
- Source Code: `<https://github.com/f0uriest/keras2c/>`_

Expand Down
5 changes: 3 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = source
BUILDDIR = ./
BUILDDIR = _build/
PDFBUILDDIR = /tmp
PDF = ./manual.pdf

Expand All @@ -20,4 +20,5 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
mv html/* .
rm -rf _modules/ _sources/ _static/
mv build/html/* ./
12 changes: 6 additions & 6 deletions docs/_sources/pyapi.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,25 @@ Writing Weights
:members:
:undoc-members:

Check Model
***********
Checking Model
**************
.. autofunction:: keras2c.check_model.is_valid_c_name
.. autofunction:: keras2c.check_model.name_check
.. autofunction:: keras2c.check_model.layers_supported_check
.. autofunction:: keras2c.check_model.activation_supported_check
.. autofunction:: keras2c.check_model.config_supported_check
.. autofunction:: keras2c.check_model.check_model

IO Parsing
**********
Graph Parsing
*************
.. autofunction:: keras2c.io_parsing.layer_type
.. autofunction:: keras2c.io_parsing.get_all_io_names
.. autofunction:: keras2c.io_parsing.get_layer_num_io
.. autofunction:: keras2c.io_parsing.get_layer_io_names
.. autofunction:: keras2c.io_parsing.get_model_io_names
.. autofunction:: keras2c.io_parsing.flatten

Test Suite
**********
Test Generation
***************
.. autofunction:: keras2c.make_test_suite.make_test_suite

Binary file removed docs/doctrees/capi.doctree
Binary file not shown.
Binary file removed docs/doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/doctrees/index.doctree
Binary file not shown.
Binary file removed docs/doctrees/installation.doctree
Binary file not shown.
Binary file removed docs/doctrees/proposal.doctree
Binary file not shown.
Binary file removed docs/doctrees/pyapi.doctree
Binary file not shown.
Binary file removed docs/doctrees/usage.doctree
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/html/.buildinfo

This file was deleted.

Empty file removed docs/html/.nojekyll
Empty file.
10 changes: 5 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this
<span class="n">k2c</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">function_name</span><span class="p">,</span> <span class="n">malloc</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">num_tests</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">verbose</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<p>For more information, see <a href="#id1"><span class="problematic" id="id2">`Installation&lt;https://keras2c.readthedocs.io/docs/_build/html/installation.html&gt;`_</span></a> and <a href="#id3"><span class="problematic" id="id4">`Usage&lt;https://keras2c.readthedocs.io/docs/_build/html/usage.html&gt;`_</span></a></p>
<p>For more information, see <a class="reference external" href="https://f0uriest.github.io/keras2c/installation.html">Installation</a> and <a class="reference external" href="https://f0uriest.github.io/keras2c/usage.html">Usage</a></p>
</div>
<div class="section" id="supported-layers">
<h2>Supported Layers<a class="headerlink" href="#supported-layers" title="Permalink to this headline"></a></h2>
Expand Down Expand Up @@ -216,7 +216,7 @@ <h2>ToDo<a class="headerlink" href="#todo" title="Permalink to this headline">¶
<div class="section" id="contribute">
<h2>Contribute<a class="headerlink" href="#contribute" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Documentation: <a class="reference external" href="https://keras2c.readthedocs.io">https://keras2c.readthedocs.io</a></p></li>
<li><p>Documentation: <a class="reference external" href="https://f0uriest.github.io/keras2c/">https://f0uriest.github.io/keras2c/</a></p></li>
<li><p>Issue Tracker: <a class="reference external" href="https://github.com/f0uriest/keras2c/issues">https://github.com/f0uriest/keras2c/issues</a></p></li>
<li><p>Source Code: <a class="reference external" href="https://github.com/f0uriest/keras2c/">https://github.com/f0uriest/keras2c/</a></p></li>
</ul>
Expand Down Expand Up @@ -246,9 +246,9 @@ <h2>License<a class="headerlink" href="#license" title="Permalink to this headli
<li class="toctree-l2"><a class="reference internal" href="pyapi.html#main">Main</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyapi.html#writing-layers">Writing Layers</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyapi.html#writing-weights">Writing Weights</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyapi.html#check-model">Check Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyapi.html#io-parsing">IO Parsing</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyapi.html#test-suite">Test Suite</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyapi.html#checking-model">Checking Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyapi.html#graph-parsing">Graph Parsing</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyapi.html#test-generation">Test Generation</a></li>
</ul>
</li>
</ul>
Expand Down
18 changes: 9 additions & 9 deletions docs/pyapi.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@
<li class="toctree-l2"><a class="reference internal" href="#main">Main</a></li>
<li class="toctree-l2"><a class="reference internal" href="#writing-layers">Writing Layers</a></li>
<li class="toctree-l2"><a class="reference internal" href="#writing-weights">Writing Weights</a></li>
<li class="toctree-l2"><a class="reference internal" href="#check-model">Check Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="#io-parsing">IO Parsing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#test-suite">Test Suite</a></li>
<li class="toctree-l2"><a class="reference internal" href="#checking-model">Checking Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="#graph-parsing">Graph Parsing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#test-generation">Test Generation</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -363,8 +363,8 @@ <h2>Writing Weights<a class="headerlink" href="#writing-weights" title="Permalin
</dd></dl>

</div>
<div class="section" id="check-model">
<h2>Check Model<a class="headerlink" href="#check-model" title="Permalink to this headline"></a></h2>
<div class="section" id="checking-model">
<h2>Checking Model<a class="headerlink" href="#checking-model" title="Permalink to this headline"></a></h2>
<dl class="py function">
<dt id="keras2c.check_model.is_valid_c_name">
<code class="sig-prename descclassname">keras2c.check_model.</code><code class="sig-name descname">is_valid_c_name</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span><a class="headerlink" href="#keras2c.check_model.is_valid_c_name" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -457,8 +457,8 @@ <h2>Check Model<a class="headerlink" href="#check-model" title="Permalink to thi
</dd></dl>

</div>
<div class="section" id="io-parsing">
<h2>IO Parsing<a class="headerlink" href="#io-parsing" title="Permalink to this headline"></a></h2>
<div class="section" id="graph-parsing">
<h2>Graph Parsing<a class="headerlink" href="#graph-parsing" title="Permalink to this headline"></a></h2>
<dl class="py function">
<dt id="keras2c.io_parsing.layer_type">
<code class="sig-prename descclassname">keras2c.io_parsing.</code><code class="sig-name descname">layer_type</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">layer</span></em><span class="sig-paren">)</span><a class="headerlink" href="#keras2c.io_parsing.layer_type" title="Permalink to this definition"></a></dt>
Expand Down Expand Up @@ -547,8 +547,8 @@ <h2>IO Parsing<a class="headerlink" href="#io-parsing" title="Permalink to this
</dd></dl>

</div>
<div class="section" id="test-suite">
<h2>Test Suite<a class="headerlink" href="#test-suite" title="Permalink to this headline"></a></h2>
<div class="section" id="test-generation">
<h2>Test Generation<a class="headerlink" href="#test-generation" title="Permalink to this headline"></a></h2>
<dl class="py function">
<dt id="keras2c.make_test_suite.make_test_suite">
<code class="sig-prename descclassname">keras2c.make_test_suite.</code><code class="sig-name descname">make_test_suite</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">function_name</span></em>, <em class="sig-param"><span class="n">malloc_vars</span></em>, <em class="sig-param"><span class="n">num_tests</span><span class="o">=</span><span class="default_value">10</span></em>, <em class="sig-param"><span class="n">stateful</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">verbose</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">tol</span><span class="o">=</span><span class="default_value">1e-05</span></em><span class="sig-paren">)</span><a class="headerlink" href="#keras2c.make_test_suite.make_test_suite" title="Permalink to this definition"></a></dt>
Expand Down

0 comments on commit 91a91be

Please sign in to comment.