Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
raviqqe committed Dec 23, 2016
1 parent b53b7ad commit fe18bb2
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ $ pip3 install --user --upgrade tensorflow-qnd

```
def_run(batch_inputs=True, prepare_filename_queues=True)
Define run() function.
Define `run()` function.
See also `help(def_run())`.
Expand Down Expand Up @@ -53,7 +53,9 @@ run(model_fn, train_input_fn, eval_input_fn=None)
`Tensor, Tensor, Operation, eval_metrics=dict<str, Tensor>`
(predictions, loss, train_op, and eval_metrics (if any)),
`ModelFnOps`.
input_fn: A function to serve input Tensors fed into the model.
train_input_fn, eval_input_fn: Functions to serve input Tensors
fed into the model. If `eval_input_fn` is `None`,
`train_input_fn` will be used instead.
Types of its arguments must be one of the following:
`QueueBase` (a filename queue),
`None` (No argument).
Expand Down
14 changes: 9 additions & 5 deletions docs/qnd/run.m.html
Original file line number Diff line number Diff line change
Expand Up @@ -1002,7 +1002,7 @@ <h1 class="title"><span class="name">qnd.run</span> module</h1>


def def_run(batch_inputs=True, prepare_filename_queues=True):
"""Define run() function.
"""Define `run()` function.

See also `help(def_run())`.

Expand Down Expand Up @@ -1036,7 +1036,9 @@ <h1 class="title"><span class="name">qnd.run</span> module</h1>
`Tensor, Tensor, Operation, eval_metrics=dict<str, Tensor>`
(predictions, loss, train_op, and eval_metrics (if any)),
`ModelFnOps`.
input_fn: A function to serve input Tensors fed into the model.
train_input_fn, eval_input_fn: Functions to serve input Tensors
fed into the model. If `eval_input_fn` is `None`,
`train_input_fn` will be used instead.
Types of its arguments must be one of the following:
`QueueBase` (a filename queue),
`None` (No argument).
Expand Down Expand Up @@ -1072,7 +1074,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>



<div class="desc"><p>Define run() function.</p>
<div class="desc"><p>Define <code>run()</code> function.</p>
<p>See also <code>help(def_run())</code>.</p>
<p>Args:
batch_inputs: If <code>True</code>, create batches from Tensors
Expand All @@ -1087,7 +1089,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<p class="source_link"><a href="javascript:void(0);" onclick="toggle('source-qnd.run.def_run', this);">Show source &equiv;</a></p>
<div id="source-qnd.run.def_run" class="source">
<pre><code>def def_run(batch_inputs=True, prepare_filename_queues=True):
"""Define run() function.
"""Define `run()` function.

See also `help(def_run())`.

Expand Down Expand Up @@ -1121,7 +1123,9 @@ <h2 class="section-title" id="header-functions">Functions</h2>
`Tensor, Tensor, Operation, eval_metrics=dict<str, Tensor>`
(predictions, loss, train_op, and eval_metrics (if any)),
`ModelFnOps`.
input_fn: A function to serve input Tensors fed into the model.
train_input_fn, eval_input_fn: Functions to serve input Tensors
fed into the model. If `eval_input_fn` is `None`,
`train_input_fn` will be used instead.
Types of its arguments must be one of the following:
`QueueBase` (a filename queue),
`None` (No argument).
Expand Down

0 comments on commit fe18bb2

Please sign in to comment.