Skip to content

Commit

Permalink
docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefan Maetschke committed May 1, 2017
1 parent bafbc7f commit 60e9610
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 9 deletions.
7 changes: 4 additions & 3 deletions docs/html/_sources/overview.rst.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Overview
========

Augment images using :class:`AugmentImage <nutsml.transformer.AugmentImage>`
and the :func:`by <nutsml.transformer.AugmentImage.by>` method
- :class:`AugmentImage <nutsml.transformer.AugmentImage>` :
augment images using random transformations, e.g. rotation.

How to build a batch :class:`nutsml.batcher.BuildBatch`
- :class:`TransformImage <nutsml.transformer.TransformImage>` :
transform images, e.g. translate, rotate.
9 changes: 6 additions & 3 deletions docs/html/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,12 @@

<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline"></a></h1>
<p>Augment images using <a class="reference internal" href="nutsml.html#nutsml.transformer.AugmentImage" title="nutsml.transformer.AugmentImage"><code class="xref py py-class docutils literal"><span class="pre">AugmentImage</span></code></a>
and the <a class="reference internal" href="nutsml.html#nutsml.transformer.AugmentImage.by" title="nutsml.transformer.AugmentImage.by"><code class="xref py py-func docutils literal"><span class="pre">by</span></code></a> method</p>
<p>How to build a batch <a class="reference internal" href="nutsml.html#nutsml.batcher.BuildBatch" title="nutsml.batcher.BuildBatch"><code class="xref py py-class docutils literal"><span class="pre">nutsml.batcher.BuildBatch</span></code></a></p>
<ul class="simple">
<li><a class="reference internal" href="nutsml.html#nutsml.transformer.AugmentImage" title="nutsml.transformer.AugmentImage"><code class="xref py py-class docutils literal"><span class="pre">AugmentImage</span></code></a> :
augment images using random transformations, e.g. rotation.</li>
<li><a class="reference internal" href="nutsml.html#nutsml.transformer.TransformImage" title="nutsml.transformer.TransformImage"><code class="xref py py-class docutils literal"><span class="pre">TransformImage</span></code></a> :
transform images, e.g. translate, rotate.</li>
</ul>
</div>


Expand Down
Loading

0 comments on commit 60e9610

Please sign in to comment.