fix: update doc

Author: piercus

docs/AbstractAugmenter.html

@@ -190,7 +190,7 @@ <h4 class="name" id="read"><span class="type-signature"></span>read<span class="
     <p>Augment images and return the result in a pipeable format</p>
 <p>Can be used with different input format :</p>
 <ul>
-<li>Using String or array of strings will be considered as filenames</li>
+<li>Using <Images> or array will be considered as images</li>
 <li>Full input format is {images: <Images>, boxes: [[[x1, y1, w1, h1]]], points:[[[x1, y1]]] }</li>
 </ul>
 </div>
@@ -237,12 +237,6 @@ <h5>Parameters:</h5>
 <span class="param-type"><a href="global.html#AugmenterFormat">AugmenterFormat</a></span>
 |
 
-<span class="param-type">String</span>
-|
-
-<span class="param-type">Array.&lt;String></span>
-|
-
 <span class="param-type"><a href="global.html#Images">Images</a></span>
 
 
@@ -253,7 +247,7 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last"><p>{images, points}</p></td>
+            <td class="description last"></td>
         </tr>
 
 
@@ -321,7 +315,7 @@ <h5>Returns:</h5>
 
 
 <div class="param-desc">
-    <p>the output is pipeable into other augmenters</p>
+    <p>the output is pipeable into other augmenters (format is {images, points, boxes})</p>
 </div>
 
 
@@ -350,15 +344,15 @@ <h5>Returns:</h5>
 
 
 
-    <h4 class="name" id="toGrid"><span class="type-signature"></span>toGrid<span class="signature">(runOpts)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
+    <h4 class="name" id="toGrid"><span class="type-signature"></span>toGrid<span class="signature">(runOpts)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#AugmenterFormat">AugmenterFormat</a>>}</span></h4>
 
 
 
 
 
 
 <div class="description">
-    <p>Augment images</p>
+    <p>Get a grid image</p>
 </div>
 
 
@@ -419,7 +413,53 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last"><p>{images, points}</p></td>
+            <td class="description last"><p>{images}</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>gridOptions.gridShape</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;Number></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p><code>[n,m]</code> create a grid of n images per row, and m rows</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>gridOptions.imageShape</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;Number></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p><code>[w,h]</code> each image in the grid is reshaped to [w,h] size</p></td>
         </tr>
 
 
@@ -460,7 +500,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="abstract.js.html">abstract.js</a>, <a href="abstract.js.html#line85">line 85</a>
+        <a href="abstract.js.html">abstract.js</a>, <a href="abstract.js.html#line83">line 83</a>
     </li></ul></dd>
 
 
@@ -487,7 +527,7 @@ <h5>Returns:</h5>
 
 
 <div class="param-desc">
-    <p>the output is pipeable into other augmenters</p>
+    <p>grid a {images} object with only one grid image</p>
 </div>
 
 
@@ -498,7 +538,7 @@ <h5>Returns:</h5>
     </dt>
     <dd>
 
-<span class="param-type">Promise</span>
+<span class="param-type">Promise.&lt;<a href="global.html#AugmenterFormat">AugmenterFormat</a>></span>
 
 
     </dd>
@@ -532,7 +572,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 28 2019 18:26:11 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 19:17:25 GMT+0100 (CET)
 </footer>
 
 <script> prettyPrint(); </script>

docs/AddAugmenter.html

@@ -220,7 +220,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 28 2019 18:26:11 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 19:17:25 GMT+0100 (CET)
 </footer>
 
 <script> prettyPrint(); </script>

docs/AddWeightedAugmenter.html

@@ -321,7 +321,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 28 2019 18:26:11 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 19:17:25 GMT+0100 (CET)
 </footer>
 
 <script> prettyPrint(); </script>

docs/AdditiveGaussianNoiseAugmenter.html

@@ -422,7 +422,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 28 2019 18:26:11 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 19:17:25 GMT+0100 (CET)
 </footer>
 
 <script> prettyPrint(); </script>

docs/AdditiveNoiseAugmenter.html

@@ -424,7 +424,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 28 2019 18:26:11 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 19:17:25 GMT+0100 (CET)
 </footer>
 
 <script> prettyPrint(); </script>

docs/AdditivePoissonNoiseAugmenter.html

@@ -375,7 +375,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 28 2019 18:26:11 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 19:17:25 GMT+0100 (CET)
 </footer>
 
 <script> prettyPrint(); </script>

docs/AffineTransformAugmenter.html

@@ -539,7 +539,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 28 2019 18:26:11 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 19:17:25 GMT+0100 (CET)
 </footer>
 
 <script> prettyPrint(); </script>

docs/BackgroundAugmenter.html

@@ -270,7 +270,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 28 2019 18:26:11 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 19:17:25 GMT+0100 (CET)
 </footer>
 
 <script> prettyPrint(); </script>

docs/BlurAugmenter.html

@@ -274,7 +274,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 28 2019 18:26:11 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 19:17:25 GMT+0100 (CET)
 </footer>
 
 <script> prettyPrint(); </script>

docs/CropAugmenter.html

@@ -292,7 +292,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractA
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 28 2019 18:26:11 GMT+0100 (CET)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Mar 29 2019 19:17:25 GMT+0100 (CET)
 </footer>
 
 <script> prettyPrint(); </script>