Progress on sphinx markup

bjherger · May 24, 2018 · 4249823 · 4249823
1 parent 583afc3
commit 4249823
Show file tree

Hide file tree

Showing 16 changed files with 256 additions and 138 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/planning/POC_notes.doctree b/docs/_build/doctrees/planning/POC_notes.doctree
diff --git a/docs/_build/doctrees/planning/brainstorming.doctree b/docs/_build/doctrees/planning/brainstorming.doctree
diff --git a/docs/_build/doctrees/planning/interface.doctree b/docs/_build/doctrees/planning/interface.doctree
diff --git a/docs/_build/doctrees/planning/new_var_type.doctree b/docs/_build/doctrees/planning/new_var_type.doctree
diff --git a/docs/_build/html/_sources/planning/new_var_type.md.txt b/docs/_build/html/_sources/planning/new_var_type.md.txt
@@ -0,0 +1,5 @@
+Workflow for new variable type: 
+
+ - Add default transformation type
+ - Add input layer handler
+ - Add output layer handler
diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -38,17 +38,22 @@
         <div class="bodywrapper">
           <div class="body" role="main">
 
-  <div class="section" id="welcome-to-keras-pandas-s-documentation">
-<h1>Welcome to Keras-Pandas’s documentation!<a class="headerlink" href="#welcome-to-keras-pandas-s-documentation" title="Permalink to this headline">¶</a></h1>
-<div class="toctree-wrapper compound">
-</div>
+  <p>.. Keras-Pandas documentation master file, created by
+sphinx-quickstart on Thu May 17 13:42:05 2018.
+You can adapt this file completely to your liking, but it should at least
+contain the root <code class="docutils literal"><span class="pre">toctree</span></code> directive.</p>
+<div class="section" id="welcome-to-keras-pandas-s-documentation">
+<span id="welcome-to-keras-pandas-s-documentation"></span><h1>Welcome to Keras-Pandas’s documentation!<a class="headerlink" href="#welcome-to-keras-pandas-s-documentation" title="Permalink to this headline">¶</a></h1>
+<p>.. toctree::
+:maxdepth: 2
+:caption: Contents:</p>
 </div>
 <div class="section" id="indices-and-tables">
-<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
+<span id="indices-and-tables"></span><h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
 <ul class="simple">
-<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
-<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
-<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
+<li>:ref:<code class="docutils literal"><span class="pre">genindex</span></code></li>
+<li>:ref:<code class="docutils literal"><span class="pre">modindex</span></code></li>
+<li>:ref:<code class="docutils literal"><span class="pre">search</span></code></li>
 </ul>
 </div>
 

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/planning/POC_notes.html b/docs/_build/html/planning/POC_notes.html
@@ -5,7 +5,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>&lt;no title&gt; &#8212; Keras-Pandas 1.0 documentation</title>
+    <title>Backlog &#8212; Keras-Pandas 1.0 documentation</title>
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
@@ -38,166 +38,168 @@
         <div class="bodywrapper">
           <div class="body" role="main">
 
-  <p># Backlog</p>
-<blockquote>
-<div><ul class="simple">
+  <div class="section" id="backlog">
+<span id="backlog"></span><h1>Backlog<a class="headerlink" href="#backlog" title="Permalink to this headline">¶</a></h1>
+<ul class="simple">
 <li>Interface: Need to determine options (SKLearn transformer, custom interface, etc)</li>
 <li>Interface: Need to outline functionality</li>
 <li>Boolean: Need to determine if it’ll be handled as numerical or categorical</li>
 <li>Pip installable: Need to determine level of effort</li>
 </ul>
-</div></blockquote>
-<p># Interface: Need to determine options (SKLearn transformer, custom interface, etc)</p>
+</div>
+<div class="section" id="interface-need-to-determine-options-sklearn-transformer-custom-interface-etc">
+<span id="interface-need-to-determine-options-sklearn-transformer-custom-interface-etc"></span><h1>Interface: Need to determine options (SKLearn transformer, custom interface, etc)<a class="headerlink" href="#interface-need-to-determine-options-sklearn-transformer-custom-interface-etc" title="Permalink to this headline">¶</a></h1>
 <p>Options:</p>
-<blockquote>
-<div><ul class="simple">
+<ul class="simple">
 <li>SKLearn transformer</li>
 <li>Pandas-SKLearn style module</li>
 <li>Custom module</li>
 </ul>
-</div></blockquote>
 <p>Requirements:</p>
-<blockquote>
-<div><ul class="simple">
+<ul class="simple">
 <li>Be able to expand one column to many columns (datetime)</li>
 <li>Abilityt o use SKLearn transformers</li>
 </ul>
-</div></blockquote>
-<p>## SKLearn transformer</p>
-<blockquote>
-<div><ul class="simple">
+<div class="section" id="sklearn-transformer">
+<span id="sklearn-transformer"></span><h2>SKLearn transformer<a class="headerlink" href="#sklearn-transformer" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Inputs would have to be Numpy arrays</li>
 <li>Inputs can be Numpy arrays</li>
 <li>Tighter integration to SKLearn infrastructure</li>
 </ul>
-</div></blockquote>
-<p>## Pandas-SKLearn style module</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="pandas-sklearn-style-module">
+<span id="pandas-sklearn-style-module"></span><h2>Pandas-SKLearn style module<a class="headerlink" href="#pandas-sklearn-style-module" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Can have pandas dataframe inputs</li>
 <li>Can have multipel column inputs</li>
 <li>Can apply multiple transformations to the same column (many to one relationship)</li>
 <li>Can not apply transformations to some columns</li>
 <li>Can use default transformer</li>
 </ul>
-</div></blockquote>
-<p>## Custom module</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="custom-module">
+<span id="custom-module"></span><h2>Custom module<a class="headerlink" href="#custom-module" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Can sit on top of Pandas-SKLearn</li>
-<li>Can mimic SKLearn <cite>fit</cite> and <cite>transform</cite> interface</li>
+<li>Can mimic SKLearn <code class="docutils literal"><span class="pre">fit</span></code> and <code class="docutils literal"><span class="pre">transform</span></code> interface</li>
 </ul>
-</div></blockquote>
-<p>#  Need to determine if it’ll be handled as numerical or categorical</p>
-<p>## Numerical</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+</div>
+<div class="section" id="need-to-determine-if-it-ll-be-handled-as-numerical-or-categorical">
+<span id="need-to-determine-if-it-ll-be-handled-as-numerical-or-categorical"></span><h1>Need to determine if it’ll be handled as numerical or categorical<a class="headerlink" href="#need-to-determine-if-it-ll-be-handled-as-numerical-or-categorical" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="numerical">
+<span id="numerical"></span><h2>Numerical<a class="headerlink" href="#numerical" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Less compute time</li>
 <li>Reduced complexity</li>
 </ul>
-</div></blockquote>
-<p>## Categorical</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="categorical">
+<span id="categorical"></span><h2>Categorical<a class="headerlink" href="#categorical" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Embedding representing different values</li>
 </ul>
-</div></blockquote>
-<p># Pip installable: Need to determine level of effort</p>
-<p>## Lit review</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+</div>
+<div class="section" id="pip-installable-need-to-determine-level-of-effort">
+<span id="pip-installable-need-to-determine-level-of-effort"></span><h1>Pip installable: Need to determine level of effort<a class="headerlink" href="#pip-installable-need-to-determine-level-of-effort" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="lit-review">
+<span id="lit-review"></span><h2>Lit review<a class="headerlink" href="#lit-review" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>PMOTW: Setuptools</li>
 <li>Common library: setuptools</li>
 <li>PMOTW: distutils</li>
 <li>Common library: distutils</li>
 <li>Blog review</li>
 </ul>
-</div></blockquote>
-<p>## PMOTW: Setuptools</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="pmotw-setuptools">
+<span id="pmotw-setuptools"></span><h2>PMOTW: Setuptools<a class="headerlink" href="#pmotw-setuptools" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Unavailable</li>
 </ul>
-</div></blockquote>
-<p>## [Common library: setuptools](<a class="reference external" href="https://setuptools.readthedocs.io/en/latest/">https://setuptools.readthedocs.io/en/latest/</a>)</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="common-library-setuptools">
+<span id="common-library-setuptools"></span><h2><a class="reference external" href="https://setuptools.readthedocs.io/en/latest/">Common library: setuptools</a><a class="headerlink" href="#common-library-setuptools" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Designed to facilitate packaging Python projects</li>
 <li>Enhancement to distutils</li>
 </ul>
-</div></blockquote>
 <p>Highlights</p>
-<blockquote>
-<div><ul class="simple">
+<ul class="simple">
 <li>Dependency resolution &amp; downloading</li>
 <li>Create eggs</li>
 <li>Automatically create wrapper scripts &amp; .exe files</li>
-<li>[Decent getting started guide](<a class="reference external" href="https://setuptools.readthedocs.io/en/latest/setuptools.html#basic-use">https://setuptools.readthedocs.io/en/latest/setuptools.html#basic-use</a>)</li>
+<li><a class="reference external" href="https://setuptools.readthedocs.io/en/latest/setuptools.html#basic-use">Decent getting started guide</a></li>
 </ul>
-</div></blockquote>
 <p>Superset of of distutils</p>
-<p>## PMOTW: distutils</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="pmotw-distutils">
+<span id="pmotw-distutils"></span><h2>PMOTW: distutils<a class="headerlink" href="#pmotw-distutils" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Unavailable</li>
 </ul>
-</div></blockquote>
-<p>## [Common library: distutils](<a class="reference external" href="https://docs.python.org/2/distutils/">https://docs.python.org/2/distutils/</a>)</p>
-<p>[Intro](<a class="reference external" href="https://docs.python.org/2/distutils/introduction.html">https://docs.python.org/2/distutils/introduction.html</a>)</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="common-library-distutils">
+<span id="common-library-distutils"></span><h2><a class="reference external" href="https://docs.python.org/2/distutils/">Common library: distutils</a><a class="headerlink" href="#common-library-distutils" title="Permalink to this headline">¶</a></h2>
+<p><a class="reference external" href="https://docs.python.org/2/distutils/introduction.html">Intro</a></p>
+<ul class="simple">
 <li>Setup script</li>
 <li>Source distribution</li>
 <li>Binary distributions</li>
 </ul>
-</div></blockquote>
 <p>Setup script</p>
-<blockquote>
-<div><ul class="simple">
+<ul class="simple">
 <li>Handles packaging</li>
 <li>Not aware of package managers</li>
 </ul>
-</div></blockquote>
-<p>[PyPi](<a class="reference external" href="https://docs.python.org/2/distutils/packageindex.html#pypi-overview">https://docs.python.org/2/distutils/packageindex.html#pypi-overview</a>)</p>
-<blockquote>
-<div><ul class="simple">
+<p><a class="reference external" href="https://docs.python.org/2/distutils/packageindex.html#pypi-overview">PyPi</a></p>
+<ul class="simple">
 <li>Registering</li>
 <li>Upload</li>
 </ul>
-</div></blockquote>
-<p>## Blogs</p>
-<blockquote>
-<div><ul class="simple">
-<li>[Marthall](<a class="reference external" href="https://marthall.github.io/blog/how-to-package-a-python-app/">https://marthall.github.io/blog/how-to-package-a-python-app/</a>)</li>
-<li>[so](<a class="reference external" href="https://stackoverflow.com/questions/9411494/how-do-i-create-a-pip-installable-project">https://stackoverflow.com/questions/9411494/how-do-i-create-a-pip-installable-project</a>)</li>
-</ul>
-</div></blockquote>
-<p>## [Marthall](<a class="reference external" href="https://marthall.github.io/blog/how-to-package-a-python-app/">https://marthall.github.io/blog/how-to-package-a-python-app/</a>)</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="blogs">
+<span id="blogs"></span><h2>Blogs<a class="headerlink" href="#blogs" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
+<li><a class="reference external" href="https://marthall.github.io/blog/how-to-package-a-python-app/">Marthall</a></li>
+<li><a class="reference external" href="https://stackoverflow.com/questions/9411494/how-do-i-create-a-pip-installable-project">so</a></li>
+</ul>
+</div>
+<div class="section" id="marthall">
+<span id="marthall"></span><h2><a class="reference external" href="https://marthall.github.io/blog/how-to-package-a-python-app/">Marthall</a><a class="headerlink" href="#marthall" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Strong, convenient walk through</li>
 </ul>
-</div></blockquote>
-<p>## [so](<a class="reference external" href="https://stackoverflow.com/questions/9411494/how-do-i-create-a-pip-installable-project">https://stackoverflow.com/questions/9411494/how-do-i-create-a-pip-installable-project</a>)</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="so">
+<span id="so"></span><h2><a class="reference external" href="https://stackoverflow.com/questions/9411494/how-do-i-create-a-pip-installable-project">so</a><a class="headerlink" href="#so" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Rambling</li>
 </ul>
-</div></blockquote>
-<p>## [Scott Torborg](<a class="reference external" href="http://python-packaging.readthedocs.io/en/latest/">http://python-packaging.readthedocs.io/en/latest/</a>)</p>
+</div>
+<div class="section" id="scott-torborg">
+<span id="scott-torborg"></span><h2><a class="reference external" href="http://python-packaging.readthedocs.io/en/latest/">Scott Torborg</a><a class="headerlink" href="#scott-torborg" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li>Strong advanced discussion</li>
 <li>How to declare dependencies</li>
 </ul>
-<p>## [PyPI docs](<a class="reference external" href="https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi">https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi</a>)</p>
-<p>## [twine quickstart](<a class="reference external" href="https://packaging.python.org/tutorials/distributing-packages/">https://packaging.python.org/tutorials/distributing-packages/</a>)</p>
-<p># Decisions</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="pypi-docs">
+<span id="pypi-docs"></span><h2><a class="reference external" href="https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi">PyPI docs</a><a class="headerlink" href="#pypi-docs" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="twine-quickstart">
+<span id="twine-quickstart"></span><h2><a class="reference external" href="https://packaging.python.org/tutorials/distributing-packages/">twine quickstart</a><a class="headerlink" href="#twine-quickstart" title="Permalink to this headline">¶</a></h2>
+</div>
+</div>
+<div class="section" id="decisions">
+<span id="decisions"></span><h1>Decisions<a class="headerlink" href="#decisions" title="Permalink to this headline">¶</a></h1>
+<ul class="simple">
 <li>Interface: Will use custom interface, similar to SKLearn, with Pandas-SKLearn under the hood.</li>
 <li>Pip installable: Will move forward w/ setuptools</li>
 </ul>
-</div></blockquote>
+</div>
 
 
           </div>

diff --git a/docs/_build/html/planning/brainstorming.html b/docs/_build/html/planning/brainstorming.html
@@ -5,7 +5,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>&lt;no title&gt; &#8212; Keras-Pandas 1.0 documentation</title>
+    <title>Elevator pitch &#8212; Keras-Pandas 1.0 documentation</title>
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <script type="text/javascript">
@@ -38,29 +38,32 @@
         <div class="bodywrapper">
           <div class="body" role="main">
 
-  <p># Elevator pitch</p>
-<p># Audience</p>
-<blockquote>
-<div><ul class="simple">
+  <div class="section" id="elevator-pitch">
+<span id="elevator-pitch"></span><h1>Elevator pitch<a class="headerlink" href="#elevator-pitch" title="Permalink to this headline">¶</a></h1>
+</div>
+<div class="section" id="audience">
+<span id="audience"></span><h1>Audience<a class="headerlink" href="#audience" title="Permalink to this headline">¶</a></h1>
+<ul class="simple">
 <li>Semi-technical</li>
 <li>ML background, new to deep learning</li>
 <li>Familiarity with Python data ecosystem (Pandas, SKLearn, numpy)</li>
 <li>Interested in getting started in deep learning</li>
 <li>Interested in quickly prototyping models</li>
 </ul>
-</div></blockquote>
-<p># Goals</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="goals">
+<span id="goals"></span><h1>Goals<a class="headerlink" href="#goals" title="Permalink to this headline">¶</a></h1>
+<ul class="simple">
 <li>Easy to use interface</li>
 <li>Sensible default actions</li>
 <li>Low barrier to entry to create Keras input / output layers</li>
 </ul>
-</div></blockquote>
-<p># Requirements</p>
-<p>## Backlog</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="requirements">
+<span id="requirements"></span><h1>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="backlog">
+<span id="backlog"></span><h2>Backlog<a class="headerlink" href="#backlog" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Numerical inputs: Null handling, Z score normalizaiton</li>
 <li>Categorical inputs: Create embedding, handle unseen levels</li>
 <li>Boolean inputs: Handle appropriately</li>
@@ -72,10 +75,10 @@
 <li>Appropriate exceptions</li>
 <li>Pip installable</li>
 </ul>
-</div></blockquote>
-<p>## Prioritized backlog</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="prioritized-backlog">
+<span id="prioritized-backlog"></span><h2>Prioritized backlog<a class="headerlink" href="#prioritized-backlog" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Unit tests</li>
 <li>Logging</li>
 <li>Numerical inputs: Null handling, Z score normalizaiton</li>
@@ -85,16 +88,17 @@
 <li>Appropriate exceptions</li>
 <li>Pip installable</li>
 </ul>
-</div></blockquote>
-<p>## POC items</p>
-<blockquote>
-<div><ul class="simple">
+</div>
+<div class="section" id="poc-items">
+<span id="poc-items"></span><h2>POC items<a class="headerlink" href="#poc-items" title="Permalink to this headline">¶</a></h2>
+<ul class="simple">
 <li>Interface: Need to determine options (SKLearn transformer, custom interface, etc)</li>
 <li>Interface: Need to outline functionality</li>
 <li>Boolean: Need to determine if it’ll be handled as numerical or categorical</li>
 <li>Pip installable: Need to determine level of effort</li>
 </ul>
-</div></blockquote>
+</div>
+</div>
 
 
           </div>