Skip to content

Commit

Permalink
Updating docstrings, to better render via sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
bjherger committed May 28, 2018
1 parent 2e11bb8 commit 8ac2248
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 17 deletions.
Binary file modified docs/_build/doctrees/automater.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/lib.doctree
Binary file not shown.
16 changes: 11 additions & 5 deletions docs/_build/html/automater.html
Original file line number Diff line number Diff line change
Expand Up @@ -197,9 +197,16 @@
<dl class="method">
<dt id="Automater.Automater._create_mappers">
<code class="descname">_create_mappers</code><span class="sig-paren">(</span><em>variable_type_dict</em><span class="sig-paren">)</span><a class="headerlink" href="#Automater.Automater._create_mappers" title="Permalink to this definition"></a></dt>
<dd><p>Creates two sklearn-pandas mappers, one for the input variables, and another for the output variable(s)
:param variable_type_dict: A dictionary, with keys describing variables types, and values listing particular
variables
<dd><p>Creates two sklearn-pandas mappers, one for the input variables, and another for the output variable(s)</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>variable_type_dict</strong> – A dictionary, with keys describing variables types, and values listing particular</td>
</tr>
</tbody>
</table>
<p>variables
:type variable_type_dict: {str:[str]}
:return: Two sklearn-pandas mappers, one for the input variables, and another for the output variable(s)
:rtype: (DataFrameMapper, DataFrameMapper)</p>
Expand All @@ -208,8 +215,7 @@
<dl class="method">
<dt id="Automater.Automater._create_output_nub">
<code class="descname">_create_output_nub</code><span class="sig-paren">(</span><em>variable_type_dict</em>, <em>output_variables_df</em>, <em>y</em><span class="sig-paren">)</span><a class="headerlink" href="#Automater.Automater._create_output_nub" title="Permalink to this definition"></a></dt>
<dd><p>
Generate a ‘nub’, appropriate for use as an output / final Keras layer.</p>
<dd><p>Generate a ‘nub’, appropriate for use as an output / final Keras layer.</p>
<p>The structure of this nub will depend on the y variable’s data type</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
Expand Down
40 changes: 30 additions & 10 deletions docs/_build/html/lib.html
Original file line number Diff line number Diff line change
Expand Up @@ -196,13 +196,25 @@
<dl class="function">
<dt id="lib.download_file">
<code class="descclassname">lib.</code><code class="descname">download_file</code><span class="sig-paren">(</span><em>url</em>, <em>local_file_path</em>, <em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#lib.download_file" title="Permalink to this definition"></a></dt>
<dd><p>Download the file at <cite>url</cite> in chunks, to the location at <cite>local_file_path</cite>
:param url: URL to a file to be downloaded
:type url: str
:param local_file_path: Path to download the file to
:type local_file_path: str
:return: The path to the file on the local machine (same as input <cite>local_file_path</cite>)
:rtype: str</p>
<dd><p>Download the file at <cite>url</cite> in chunks, to the location at <cite>local_file_path</cite></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>url</strong> (<em>str</em>) – URL to a file to be downloaded</li>
<li><strong>local_file_path</strong> (<em>str</em>) – Path to download the file to</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The path to the file on the local machine (same as input <cite>local_file_path</cite>)</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
Expand All @@ -224,9 +236,17 @@
<dl class="function">
<dt id="lib.load_titanic">
<code class="descclassname">lib.</code><code class="descname">load_titanic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#lib.load_titanic" title="Permalink to this definition"></a></dt>
<dd><p>Load the titanic data set, as a pandas DataFrame
:return: A DataFrame, containing the titanic dataset
:rtype: pandas.DataFrame</p>
<dd><p>Load the titanic data set, as a pandas DataFrame</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A DataFrame, containing the titanic dataset</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">pandas.DataFrame</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8ac2248

Please sign in to comment.