Merge branch 'main' into posenet-examples

ml5js · Feb 16, 2021 · 45fda91 · 45fda91
2 parents d1fcb19 + ed32afb
commit 45fda91
Show file tree

Hide file tree

Showing 40 changed files with 76 additions and 195 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -85,7 +85,7 @@
       "login": "ellennickles",
       "name": "Ellen Nickles",
       "avatar_url": "https://avatars2.githubusercontent.com/u/31713501?v=4",
-      "profile": "https://ellennickles.site/",
+      "profile": "https://github.com/ellennickles/",
       "contributions": [
         "blog",
         "content",

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -1,13 +0,0 @@
-name: reviewdog
-on: [pull_request]
-jobs:
-  eslint:
-    name: runner / eslint
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - name: eslint
-        uses: reviewdog/action-eslint@v1
-        with:
-          github_token: ${{ secrets.github_token }}
-          reporter: github-pr-review # Change reporter.

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
diff --git a/README.md b/README.md
@@ -78,7 +78,7 @@ You can find a collection of standalone examples in this repository within the `
 These examples are meant to serve as an introduction to the library and machine learning concepts.
 
 ## Code of Conduct
-We believe in a friendly internet and community as much as we do in building friendly machine learning for the web. Please refer to our [CODE OF CONDUCT](CODE_OF_CONDUCT.md) for our rules for interacting with ml5 as a developer, contributor, or user.
+We believe in a friendly internet and community as much as we do in building friendly machine learning for the web. Please refer to our [Code of Conduct](https://github.com/ml5js/Code-of-Conduct/) for our rules for interacting with ml5 as a developer, contributor, or as a person using the library.
 
 ## Contributing
 Want to be a **contributor 🏗 to the ml5.js library**? If yes and you're interested to submit new features, fix bugs, or help develop the ml5.js ecosystem, please go to our [CONTRIBUTING](CONTRIBUTING.md) documentation to get started.
@@ -106,7 +106,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="http://www.hannahishere.com"><img src="https://avatars0.githubusercontent.com/u/1385308?v=4" width="100px;" alt=""/><br /><sub><b>Hannah Davis</b></sub></a><br /><a href="https://github.com/ml5js/ml5-library/commits?author=handav" title="Code">💻</a> <a href="#example-handav" title="Examples">💡</a></td>
     <td align="center"><a href="https://jk-lee.com/"><img src="https://avatars1.githubusercontent.com/u/3622055?v=4" width="100px;" alt=""/><br /><sub><b>Joey Lee</b></sub></a><br /><a href="https://github.com/ml5js/ml5-library/commits?author=joeyklee" title="Code">💻</a> <a href="#example-joeyklee" title="Examples">💡</a> <a href="https://github.com/ml5js/ml5-library/pulls?q=is%3Apr+reviewed-by%3Ajoeyklee" title="Reviewed Pull Requests">👀</a> <a href="#content-joeyklee" title="Content">🖋</a> <a href="https://github.com/ml5js/ml5-library/commits?author=joeyklee" title="Tests">⚠️</a></td>
     <td align="center"><a href="https://github.com/AshleyJaneLewis"><img src="https://avatars3.githubusercontent.com/u/43127855?v=4" width="100px;" alt=""/><br /><sub><b>AshleyJaneLewis</b></sub></a><br /><a href="#blog-AshleyJaneLewis" title="Blogposts">📝</a> <a href="#design-AshleyJaneLewis" title="Design">🎨</a> <a href="#eventOrganizing-AshleyJaneLewis" title="Event Organizing">📋</a> <a href="#content-AshleyJaneLewis" title="Content">🖋</a></td>
-    <td align="center"><a href="https://ellennickles.site/"><img src="https://avatars2.githubusercontent.com/u/31713501?v=4" width="100px;" alt=""/><br /><sub><b>Ellen Nickles</b></sub></a><br /><a href="#blog-ellennickles" title="Blogposts">📝</a> <a href="#content-ellennickles" title="Content">🖋</a> <a href="#ideas-ellennickles" title="Ideas, Planning, & Feedback">🤔</a> <a href="#tutorial-ellennickles" title="Tutorials">✅</a></td>
+    <td align="center"><a href="https://github.com/ellennickles/"><img src="https://avatars2.githubusercontent.com/u/31713501?v=4" width="100px;" alt=""/><br /><sub><b>Ellen Nickles</b></sub></a><br /><a href="#blog-ellennickles" title="Blogposts">📝</a> <a href="#content-ellennickles" title="Content">🖋</a> <a href="#ideas-ellennickles" title="Ideas, Planning, & Feedback">🤔</a> <a href="#tutorial-ellennickles" title="Tutorials">✅</a></td>
   </tr>
   <tr>
     <td align="center"><a href="http://www.itayniv.com"><img src="https://avatars1.githubusercontent.com/u/5209486?v=4" width="100px;" alt=""/><br /><sub><b>Itay Niv</b></sub></a><br /><a href="https://github.com/ml5js/ml5-library/commits?author=itayniv" title="Code">💻</a> <a href="#example-itayniv" title="Examples">💡</a></td>

diff --git a/docs/index.html b/docs/index.html
@@ -106,8 +106,8 @@
     <script>
       const config = {
         editOnGithub: {
-          docBase: 'https://github.com/ml5js/ml5-library/tree/gh-pages/docs/',
-          docEditBase: 'https://ml5js.github.io/ml5-library',
+          docBase: 'https://github.com/ml5js/ml5-library/tree/main/docs/',
+          docEditBase: 'https://learn.ml5js.org/',
           title: 'Edit document',
         },
       };

diff --git a/docs/reference/cvae.md b/docs/reference/cvae.md
@@ -103,7 +103,7 @@ No demos yet - contribute one today!
 No tutorials yet - contribute one today!
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/dcgan.md b/docs/reference/dcgan.md
@@ -134,7 +134,7 @@ No demos yet - contribute one today!
 No demos yet - contribute one today!
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/face-api.md b/docs/reference/face-api.md
@@ -162,7 +162,7 @@ No tutorials yet - contribute one today!
 
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/image-classifier.md b/docs/reference/image-classifier.md
@@ -172,7 +172,7 @@ No demos yet - contribute one today!
 
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/neural-network.md b/docs/reference/neural-network.md
@@ -31,6 +31,9 @@ const data = [
   {r:255, g:0, b:0, color:'red-ish'},
   {r:254, g:0, b:0, color:'red-ish'},
   {r:253, g:0, b:0, color:'red-ish'},
+  {r:0, g:255, b:0, color:'green-ish'},
+  {r:0, g:254, b:0, color:'green-ish'},
+  {r:0, g:253, b:0, color:'green-ish'},
   {r:0, g:0, b:255, color:'blue-ish'},
   {r:0, g:0, b:254, color:'blue-ish'},
   {r:0, g:0, b:253, color:'blue-ish'}

diff --git a/docs/reference/object-detector.md b/docs/reference/object-detector.md
@@ -16,7 +16,7 @@ Real-time object detection system using either [YOLO](https://pjreddie.com/darkn
 const video = document.getElementById('video');
 
 // Create a ObjectDetector method
-const objectDetector = ml5.ObjectDetector('cocossd', {}, modelLoaded);
+const objectDetector = ml5.objectDetector('cocossd', {}, modelLoaded);
 
 // When the model is loaded
 function modelLoaded() {
@@ -35,9 +35,9 @@ objectDetector.detect(video, (err, results) => {
 ### Initialize
 
 ```js
-const objectDetector = ml5.ObjectDetector(modelNameOrUrl);
+const objectDetector = ml5.objectDetector(modelNameOrUrl);
 // OR
-const objectDetector = ml5.ObjectDetector(modelNameOrUrl, ?options, ?callback);
+const objectDetector = ml5.objectDetector(modelNameOrUrl, ?options, ?callback);
 ```
 
 #### Parameters
@@ -100,7 +100,7 @@ No demos yet - contribute one today!
 <iframe width="560" height="315" src="https://www.youtube.com/embed/QEzRxnuaZCk"  frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/pitch-detection.md b/docs/reference/pitch-detection.md
@@ -127,7 +127,7 @@ No demos yet - contribute one today!
 No tutorials yet - contribute one today!
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/pix2pix.md b/docs/reference/pix2pix.md
@@ -105,7 +105,7 @@ No tutorials yet - contribute one today!
 
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/posenet.md b/docs/reference/posenet.md
@@ -267,7 +267,7 @@ No demos yet - contribute one today!
 
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/sentiment.md b/docs/reference/sentiment.md
@@ -33,7 +33,7 @@ console.log(prediction);
 ### Initialize
 
 ```js
-const magic = ml5.Sentiment(model, ?callback);
+const sentiment = ml5.sentiment(model, ?callback);
 ```
 
 #### Parameters
@@ -98,7 +98,7 @@ No tutorials yet - contribute one today!
 
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/sketchrnn.md b/docs/reference/sketchrnn.md
@@ -129,7 +129,7 @@ No tutorials yet - contribute one today!
 
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/sound-classifier.md b/docs/reference/sound-classifier.md
@@ -119,7 +119,7 @@ No demos yet - contribute one today!
 <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/cO4UP2dX944" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/style-transfer.md b/docs/reference/style-transfer.md
@@ -107,7 +107,7 @@ No tutorials yet - contribute one today!
 
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/unet.md b/docs/reference/unet.md
@@ -126,7 +126,7 @@ No demos yet - contribute one today!
 No tutorials yet - contribute one today!
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/docs/reference/word2vec.md b/docs/reference/word2vec.md
@@ -203,7 +203,7 @@ No demos yet - contribute one today!
 No tutorials yet - contribute one today!
 
 ## Model and Data Provenance
-> A project started by [Ellen Nickles](https://ellennickles.site/)
+> A project started by [Ellen Nickles](https://github.com/ellennickles/)
 
 ### Models Overview
 

diff --git a/examples/javascript/BodyPix/BodyPix_Image/index.html b/examples/javascript/BodyPix/BodyPix_Image/index.html
@@ -2,7 +2,7 @@
 
 <head>
   <meta charset="UTF-8">
-  <title>BodyPix with Webcam</title>
+  <title>BodyPix with Image</title>
   <script src="http://localhost:8080/ml5.js" type="text/javascript"></script>
 
   <style></style>

diff --git a/examples/javascript/BodyPix/BodyPix_Webcam/sketch.js b/examples/javascript/BodyPix/BodyPix_Webcam/sketch.js
@@ -18,15 +18,17 @@ async function setup() {
   video = await getVideo();
   // load bodyPix with video
   bodypix = await ml5.bodyPix(options)
-  // run the segmentation on the video, handle the results in a callback
-  bodypix.segment(video, gotImage, options);
 }
 
 // when the dom is loaded, call make();
 window.addEventListener('DOMContentLoaded', function() {
   setup();
 });
 
+function videoReady() {
+  // run the segmentation on the video, handle the results in a callback
+  bodypix.segment(video, gotImage, options);
+}
 
 function gotImage(err, result){
   if(err) {
@@ -48,6 +50,7 @@ async function getVideo(){
   videoElement.setAttribute("style", "display: none;"); 
   videoElement.width = width;
   videoElement.height = height;
+  videoElement.onloadeddata = videoReady;
   document.body.appendChild(videoElement);
 
   // Create a webcam capture

diff --git a/examples/javascript/ImageClassification/ImageClassification_VideoScavengerHunt/index.html b/examples/javascript/ImageClassification/ImageClassification_VideoScavengerHunt/index.html
@@ -2,7 +2,7 @@
 
 <head>
   <meta charset="UTF-8">
-  <title>Webcam Image Classification with Speech Output using MobileNet</title>
+  <title>Webcam Scavenger Hunt Game using MobileNet</title>
   <script src="http://localhost:8080/ml5.js" type="text/javascript"></script>
 
 </head>

diff --git a/examples/javascript/KNNClassification/KNNClassification_Video/index.html b/examples/javascript/KNNClassification/KNNClassification_Video/index.html
@@ -9,7 +9,7 @@
 </head>
 
 <body>
-  <h2>KNN Classification on Webcam Images with mobileNet. Built with p5.js</h2>
+  <h2>KNN Classification on Webcam Images with mobileNet.</h2>
   <div id="videoContainer">
     <video id="video" width="640" height="480" autoplay></video>
   </div>

diff --git a/examples/javascript/PitchDetection/PitchDetection_Game/index.html b/examples/javascript/PitchDetection/PitchDetection_Game/index.html
@@ -2,7 +2,7 @@
 
 <head>
   <meta charset="UTF-8">
-  <title>Pitch Tone Game</title>
+  <title>Pitch Detect Game</title>
   <script src="http://localhost:8080/ml5.js" type="text/javascript"></script>
 
 </head>