Merge branch 'development' into release

Author: joeyklee

.all-contributorsrc

@@ -659,6 +659,15 @@
         "doc",
         "content"
       ]
+    },
+    {
+      "login": "badunit",
+      "name": "Fabio Corona",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/44651201?v=4",
+      "profile": "https://github.com/badunit",
+      "contributions": [
+        "bug"
+      ]
     }
   ],
   "contributorsPerLine": 7,

README.md

@@ -1,5 +1,5 @@
 # ![ml5](https://user-images.githubusercontent.com/10605821/41332516-2ee26714-6eac-11e8-83e4-a40b8761e764.png)
-[![All Contributors](https://img.shields.io/badge/all_contributors-61-orange.svg?style=flat-square)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-62-orange.svg?style=flat-square)](#contributors)
 
 
 [![BrowserStack Status](https://www.browserstack.com/automate/badge.svg?badge_key=QVNDdlkvMzNYSmhRRWlweXlIOTBENkd0MDBCOUJlbmFVZFRneFIzNlh4az0tLXA4S0loSGNlVUc2V2I3cVdLdXBKdGc9PQ==--8a5e5bfd3eafbba0702c02ec57ffec9d627a78ef)](https://www.browserstack.com/automate/public-build/QVNDdlkvMzNYSmhRRWlweXlIOTBENkd0MDBCOUJlbmFVZFRneFIzNlh4az0tLXA4S0loSGNlVUc2V2I3cVdLdXBKdGc9PQ==--8a5e5bfd3eafbba0702c02ec57ffec9d627a78ef)[![Version](https://img.shields.io/npm/v/ml5.svg?style=flat-square)](https://www.npmjs.com/package/ml5)
@@ -173,6 +173,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="http://yangyang.blog"><img src="https://avatars3.githubusercontent.com/u/9332910?v=4" width="100px;" alt="Yang"/><br /><sub><b>Yang</b></sub></a><br /><a href="https://github.com/ml5js/ml5-library/commits?author=EonYang" title="Code">💻</a> <a href="https://github.com/ml5js/ml5-library/issues?q=author%3AEonYang" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://github.com/lydiajessup"><img src="https://avatars3.githubusercontent.com/u/26204298?v=4" width="100px;" alt="Lydia Jessup"/><br /><sub><b>Lydia Jessup</b></sub></a><br /><a href="https://github.com/ml5js/ml5-library/commits?author=lydiajessup" title="Code">💻</a> <a href="#ideas-lydiajessup" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-lydiajessup" title="Examples">💡</a></td>
     <td align="center"><a href="https://coding.garden"><img src="https://avatars0.githubusercontent.com/u/14241866?v=4" width="100px;" alt="CJ R."/><br /><sub><b>CJ R.</b></sub></a><br /><a href="https://github.com/ml5js/ml5-library/commits?author=w3cj" title="Documentation">📖</a> <a href="#content-w3cj" title="Content">🖋</a></td>
+    <td align="center"><a href="https://github.com/badunit"><img src="https://avatars2.githubusercontent.com/u/44651201?v=4" width="100px;" alt="Fabio Corona"/><br /><sub><b>Fabio Corona</b></sub></a><br /><a href="https://github.com/ml5js/ml5-library/issues?q=author%3Abadunit" title="Bug reports">🐛</a></td>
   </tr>
 </table>
 

docs/reference/bodypix.md

@@ -197,7 +197,23 @@ bodyPix.segment(?input, ?options, callback)
 
 📤 **Outputs**
 
-* **Object**: Returns an Object. "{raw}", "{maskBackground}", and "{maskPerson}". The returns will either be a UInt8 array corresponding to the image array or a p5Image if p5.js is available.
+* **Object**: Returns an Object. The returns will either be a UInt8 array corresponding to the image array or a p5Image if p5.js is available.
+* 
+  ```js
+  {
+      segmentation,
+      raw: {
+          personMask: null,
+          backgroundMask: null,
+      },
+      tensor: {
+          personMask: null,
+          backgroundMask: null,
+      },
+      personMask: null,
+      backgroundMask: null,
+  };
+  ```
 
 ***
 
@@ -220,7 +236,27 @@ bodyPix.segmentWithParts(?input, ?options, callback)
 
 📤 **Outputs**
 
-* **Object**: Returns an Object. "{raw}". The returns will either be a UInt8 array corresponding to the image array or a p5Image if p5.js is available.
+* **Object**: Returns an Object. The returns will either be a UInt8 array corresponding to the image array or a p5Image if p5.js is available.
+
+    ```js
+    {
+        segmentation: *ImageData*,
+        raw: {
+            personMask: *ImageData*,
+            backgroundMask: *ImageData*,
+            partMask: *ImageData*
+        },
+        tensor: {
+            personMask: *Tensor*,
+            backgroundMask: *Tensor*,
+            partMask: *Tensor*,
+        },
+        personMask: *P5Image*,
+        backgroundMask: *P5Image*,
+        partMask: *P5Image*,
+        bodyParts: *JSONObject*
+    }
+    ```
 
 ***
 

docs/reference/unet.md

@@ -81,7 +81,28 @@ unet.segment(?video, ?callback);
 
 📤 **Outputs**
 
-* **Object**: Returns an array of objects. Each object contains `{something, anotherThing}`.
+* **Object**: Returns an Object.
+  ```js
+  {
+    segmentation:mask, 
+    blob: {
+      featureMask: *Blob*,
+      backgroundMask: *Blob*
+    },
+    tensor: {
+      featureMask: *Tensor*,
+      backgroundMask: *Tensor*,
+    },
+    raw: {
+      featureMask: *ImageData*,
+      backgroundMask: *ImageData*
+    },
+    // returns if p5 is available
+    featureMask: *p5Image*,
+    backgroundMask: *p5Image*,
+    mask: *p5Image*
+  };
+  ```
 
 ***
 

package-lock.json

@@ -18,6 +18,7 @@
     "test-travis": "./scripts/test-travis.sh",
     "serve:docs": "docsify serve docs",
     "update:readme": "node ./scripts/updateReadme.js",
+    "update:docs": "node ./scripts/updateDocVersions.js $oldversion",
     "publish:npm": "npm run build && npm publish"
   },
   "repository": {

package.json

@@ -0,0 +1,54 @@
+/**
+ * USAGE
+ * run:
+ *```
+ *$ oldversion=0.4.2 npm run update:docs
+ *```
+ */
+
+const fs = require('fs');
+
+
+// ------------------
+//  Helper functions
+// ------------------
+function readTextFile(fpath){
+  const readme = fs.readFileSync(fpath, 'utf8');
+  return readme;
+}
+
+function readPackageJson(fpath){
+  let output = fs.readFileSync(fpath);
+  output = JSON.parse(output);
+  return output;
+}
+
+function updateFileVersion(inputFilePath, regex, newUrl){
+  const readme = readTextFile(inputFilePath);
+  const updatedReadme = readme.replace(regex, newUrl) 
+  fs.writeFileSync(inputFilePath, updatedReadme);
+}
+
+const oldVersion = process.env.oldversion;
+const ml5Version = readPackageJson('./package.json').version || 'latest';
+const newUrl = `https://unpkg.com/ml5@${ml5Version}/dist/ml5.min.js`;
+const regex = new RegExp(`https://unpkg.com/ml5@${oldVersion}/dist/ml5.min.js`, "g");
+
+
+function make(){
+  if(!oldVersion) {
+    console.log("!!!old version needed!!! \n  oldversion=0.4.X npm run update:docs");
+    process.exit(1);
+  }
+
+  updateFileVersion('./docs/README.md', regex, newUrl);
+  updateFileVersion('./docs/tutorials/hello-ml5.md', regex, newUrl);
+  
+  console.log(`updated docs from version ${oldVersion} to ${ml5Version}`)
+}
+make();
+
+
+
+
+

scripts/updateDocVersions.js

@@ -0,0 +1,102 @@
+export default {
+  // "none": {
+  //     "id": -1,
+  //     "color": [0, 0, 0]
+  // },
+  "leftFace": {
+    "id": 0,
+    "color": [110, 64, 170]
+  },
+  "rightFace": {
+    "id": 1,
+    "color": [106, 72, 183]
+  },
+  "rightUpperLegFront": {
+    "id": 2,
+    "color": [100, 81, 196]
+  },
+  "rightLowerLegBack": {
+    "id": 3,
+    "color": [92, 91, 206]
+  },
+  "rightUpperLegBack": {
+    "id": 4,
+    "color": [84, 101, 214]
+  },
+  "leftLowerLegFront": {
+    "id": 5,
+    "color": [75, 113, 221]
+  },
+  "leftUpperLegFront": {
+    "id": 6,
+    "color": [66, 125, 224]
+  },
+  "leftUpperLegBack": {
+    "id": 7,
+    "color": [56, 138, 226]
+  },
+  "leftLowerLegBack": {
+    "id": 8,
+    "color": [48, 150, 224]
+  },
+  "rightFeet": {
+    "id": 9,
+    "color": [40, 163, 220]
+  },
+  "rightLowerLegFront": {
+    "id": 10,
+    "color": [33, 176, 214]
+  },
+  "leftFeet": {
+    "id": 11,
+    "color": [29, 188, 205]
+  },
+  "torsoFront": {
+    "id": 12,
+    "color": [26, 199, 194]
+  },
+  "torsoBack": {
+    "id": 13,
+    "color": [26, 210, 182]
+  },
+  "rightUpperArmFront": {
+    "id": 14,
+    "color": [28, 219, 169]
+  },
+  "rightUpperArmBack": {
+    "id": 15,
+    "color": [33, 227, 155]
+  },
+  "rightLowerArmBack": {
+    "id": 16,
+    "color": [41, 234, 141]
+  },
+  "leftLowerArmFront": {
+    "id": 17,
+    "color": [51, 240, 128]
+  },
+  "leftUpperArmFront": {
+    "id": 18,
+    "color": [64, 243, 116]
+  },
+  "leftUpperArmBack": {
+    "id": 19,
+    "color": [79, 246, 105]
+  },
+  "leftLowerArmBack": {
+    "id": 20,
+    "color": [96, 247, 97]
+  },
+  "rightHand": {
+    "id": 21,
+    "color": [115, 246, 91]
+  },
+  "rightLowerArmFront": {
+    "id": 22,
+    "color": [134, 245, 88]
+  },
+  "leftHand": {
+    "id": 23,
+    "color": [155, 243, 88]
+  }
+}