ml5 v0.4.0 (#638)

joeyklee · web-flow · commit e12df6c9587e · 2019-10-17T13:18:47.000-04:00
* updates ml5 version references to 0.4.0 * updates faq and readme * updates iframe in hello ml5 * adds general descriptions about categories * updates readme in docs * bump version number * changes update docs to development branch * changes docbase to gh-pages since this is what is rendered * adds sentiment to support preload (#639)
diff --git a/README.md b/README.md
@@ -25,18 +25,20 @@ There are several ways you can use the ml5.js library:
 
 
 
+
 <p id="latest-version">
 
-* You can use the latest version (0.3.1) by adding it to the head section of your HTML document:
+* You can use the latest version (0.4.0) by adding it to the head section of your HTML document:
 
-**v0.3.1**
+**v0.4.0**
 
-    <script src="https://unpkg.com/ml5@0.3.1/dist/ml5.min.js" type="text/javascript"></script>
+    <script src="https://unpkg.com/ml5@0.4.0/dist/ml5.min.js" type="text/javascript"></script>
 
 </p data-id="latest-version">
     
     
     
+    
 
 
 * If you need to use an earlier version for any reason, you can change the version number. The [previous versions of ml5 can be found here](https://www.npmjs.com/package/ml5). You can use those previous versions by replacing `<version>` with the ml5 version of interest:
diff --git a/docs/README.md b/docs/README.md
@@ -7,25 +7,25 @@ Welcome to the ml5.js documentation. Here you'll find everything you need to get
 
 Take a ride on the Coding Train to watch Dan Shiffman's ["A Beginner's Guide to Machine Learning with ml5.js"](https://www.youtube.com/watch?v=jmznx0Q1fP0). Here Dan explains what ml5.js is and where it all comes from.
 
-ml5.js is machine learning _for the web_ in your web browser. Through some clever and exciting advancements, the folks building [TensorFlow.js](https://www.tensorflow.org/js) figured out that it is possible to use the web browser's built in graphics processing unit (GPU) to do calculations that would otherwise run very slowly using central processing unit (CPU) based calculations. A really nice explantion of what is happening with GPUs can be found [here - Why are shaders fast?](https://thebookofshaders.com/01/). ml5 helps to make all these new developments in machine learning on the web more approachable for everyone.
+ml5.js is machine learning _for the web_ in your web browser. Through some clever and exciting advancements, the folks building [TensorFlow.js](https://www.tensorflow.org/js) figured out that it is possible to use the web browser's built in graphics processing unit (GPU) to do calculations that would otherwise run very slowly using central processing unit (CPU). A really nice explantion of what is happening with GPUs can be found [here - Why are shaders fast?](https://thebookofshaders.com/01/). ml5 strives to make all these new developments in machine learning on the web more approachable for everyone.
 
 
 ### Quickstart
 
 The fastest way to get started exploring the creative possibilities of ml5.js are to either:
 
 1. Download a ml5.js project boilerplate. You can download a zip file here: [ml5 project boilerplate](https://github.com/ml5js/ml5-boilerplate/releases). <br/> Or...
-2. Open this [p5 web editor sketch with ml5.js added](https://editor.p5js.org/joeyklee/sketches/5VbXAWaV6).
+2. Open this [p5 web editor sketch with ml5.js added](https://editor.p5js.org/ml5/sketches/oYweRi2H7).
 3. You can also copy and paste the cdn link to the ml5 library here:
 
   ```
-  <script src="https://unpkg.com/ml5@0.3.1/dist/ml5.min.js"></script>
+  <script src="https://unpkg.com/ml5@0.4.0/dist/ml5.min.js"></script>
   ```
 
 ***
 #### Quickstart: Plain JavaScript
 
-Reference the [latest version](https://unpkg.com/ml5@0.3.1/dist/ml5.min.js) of ml5.js using a script tag in an HTML file as below: 
+Reference the [latest version](https://unpkg.com/ml5@0.4.0/dist/ml5.min.js) of ml5.js using a script tag in an HTML file as below: 
 
 
 In an **index.html** file, copy and paste the following and open up that file in your web browser. 
@@ -36,13 +36,13 @@ In an **index.html** file, copy and paste the following and open up that file in
   <head>
     <title>Getting Started with ml5.js and p5.js</title>
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <script src="https://unpkg.com/ml5@0.3.1/dist/ml5.min.js"></script>
+    <script src="https://unpkg.com/ml5@0.4.0/dist/ml5.min.js"></script>
   </head>
 
   <body>
     <script>
       // Your code will go here
-      // open up your console - if everything loaded properly you should see 0.3.1
+      // open up your console - if everything loaded properly you should see 0.4.0
       console.log('ml5 version:', ml5.version);
 
     </script>
@@ -71,7 +71,7 @@ In an **index.html** file, copy and paste the following and open up that file in
     <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/0.9.0/addons/p5.dom.min.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/0.9.0/addons/p5.sound.min.js"></script>
     <!-- ml5 -->
-    <script src="https://unpkg.com/ml5@0.3.1/dist/ml5.min.js"></script>
+    <script src="https://unpkg.com/ml5@0.4.0/dist/ml5.min.js"></script>
   </head>
 
   <body>
@@ -108,8 +108,20 @@ Coming soon
 
 ## Contribute to ml5.js {docsify-ignore}
 
-Coming soon
+ml5 is an open source project that values all contributions. ml5 contributions often take the shape of workshops, design contributions, helping to answer people's questions on Github, flagging bugs in code, fixing bugs, adding new features, and more. 
+
+If you'd like to contribute, you're welcome to browse through the issues in our [Github](https://github.com/ml5js/ml5-library/issues) or create a new issue. If you're still unsure of where to start, feel free to ping us at [@ml5js on twitter](https://twitter.com/ml5js), <a href="mailto:hello@ml5js.org">hello@ml5js.org</a>
 
 ## Support {docsify-ignore}
 
-Coming soon
+ml5 is always on the look out for grants and funding to support the maintenance and development of the ml5 project (including our educational and community based initiatives). If you are an educational institution, grant funding organization, or otherwise interested in funding the ml5 community of students, researchers, artists, educators, designers, and developers, we'd love to hear from you. 
+
+Feel free to reach out at <a href="mailto:hello@ml5js.org">hello@ml5js.org</a>.
+
+## Acknowledgements {docsify-ignore}
+
+ml5.js is supported by the time and dedication of open source developers from all over the world. Funding and support is generously provided by a [Google Education grant](https://edu.google.com/why-google/our-commitment/?modal_active=none%2F) at [NYU's ITP/IMA program](https://itp.nyu.edu/).
+
+Many thanks [BrowserStack](https://www.browserstack.com/) for providing testing support.
+
+
diff --git a/docs/faq.md b/docs/faq.md
@@ -2,25 +2,29 @@
 
 ### Can I use ml5.js in the [p5 web editor](editor.p5js.org)?
 
-Sort of.
+Mostly.
 
 A number of the ml5 sketches don't currently work in the p5 web editor due to some of the ways that the editor handles data files and some of the network communication regarding making requests to external data (e.g. the big model files that allow ml5.js to run things like image detection, etc). 
 
-There are lots of developments in the p5 web editor as well as in ml5 to make sure these environments all play nicely together, but the best thing to do is to try and run things locally if possible. Thanks!
+There are lots of developments in the p5 web editor as well as in ml5 to make sure these environments all play nicely together. If something doesn't work in the web editor, the best thing to do is to try and run things locally if possible. See [running a local web server tutorial](/docs/tutorials/local-web-server.md).
+
+Thanks!
 
 ### Can I use ml5.js with node.js?
 
 No. Not at the moment.
 
-ml5.js uses TensorFlow.js which uses the browser's GPU to run all the calculations. As a result, all of the ml5.js functionality is based around using the browser GPU. We hope to have ml5.js run in node-js sometime in the near future (especially now that [node support for TensorFlow is a thing](https://www.tensorflow.org/js/guide/nodejs) but the current ml5 setup does not support node.js.
+ml5.js uses TensorFlow.js which uses the browser's GPU to run all the calculations. As a result, all of the ml5.js functionality is based around using the browser GPU. We hope to have ml5.js run in node-js sometime in the near future (especially now that [node support for TensorFlow is a thing](https://www.tensorflow.org/js/guide/nodejs) but the current ml5 setup does not support node.js. We hope to support this in the future.
 
 
 [For more discussion about node and ml5.js, visit this issue thread.](https://github.com/ml5js/ml5-library/issues/377)
 
 
 ### Can I contribute?
 
-Yes! Absolutely. We welcome all forms of socially and technically driven contributions. No contribution is too small. Please contact us at [@ml5js on twitter](https://twitter.com/ml5js) or <a href="mailto:hello@ml5js.org">hello@ml5js.org</a>.
+Yes! Absolutely. We welcome all forms of socially and technically driven contributions. No contribution is too small. 
+
+Please contact us at [@ml5js on twitter](https://twitter.com/ml5js), <a href="mailto:hello@ml5js.org">hello@ml5js.org</a>, or [Github](https://github.com/ml5js/ml5-library/issues).
 
 ### How can I contribute?
 
diff --git a/docs/index.html b/docs/index.html
@@ -106,7 +106,7 @@
     <script>
       const config = {
         editOnGithub: {
-          docBase: 'https://github.com/ml5js/ml5-library/tree/release/docs/',
+          docBase: 'https://github.com/ml5js/ml5-library/tree/gh-pages/docs/',
           docEditBase: 'https://ml5js.github.io/ml5-library',
           title: 'Edit document',
         },
diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -4,9 +4,13 @@ Welcome to the ml5.js reference page! Here you can browse the various categories
 
 We currently have 4 categories:
 
-* Image
-* Sound
-* Text
-* Helpers
+* **Helpers**:
+  *  The ml5 *helpers* category groups ml5 features that are broadly related to machine learning data, working with data, manipulating data, and training a model with data. Part of our helpers includes the [ml5.neuralNetwork](neural-network.md) which allows you to build and train your own neural network right in the browser. You can also explore the [ml5.featureExtractor](feature-extractor.md) to do [transfer learning](https://en.wikipedia.org/wiki/Transfer_learning).
+* **Image**:
+  * The ml5 *image* category groups ml5 features that are related to applying machine learning to images or video.  
+* **Sound**
+  * The ml5 *sound* category groups ml5 features that are related to applying machine learning to audio. 
+* **Text**
+  * The ml5 *text* category groups ml5 features that are related to applying machine learning to text.
 
 See the sidebar for more information.
diff --git a/docs/tutorials/hello-ml5.md b/docs/tutorials/hello-ml5.md
@@ -55,7 +55,7 @@ This example is built with p5.js. You can also find the same example without p5.
 </div> -->
 
 <!-- added inline height -->
-<div style="height:600px" class="iframe__container iframe__container--video"><iframe src="https://ml5js.github.io/ml5-examples/p5js/ImageClassification/ImageClassification" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>
+<div style="height:800px" class="iframe__container iframe__container--video"><iframe src="https://ml5js.github.io/ml5-examples/p5js/ImageClassification/ImageClassification" frameborder="0" height="800px" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>
 
 ## Code
 
@@ -70,9 +70,9 @@ Here you can see that we read in the javascript libraries. This includes our ml5
   <meta charset="UTF-8">
   <title>Image classification using MobileNet and p5.js</title>
 
-  <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/0.8.0/p5.min.js"></script>
-  <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/0.8.0/addons/p5.dom.min.js"></script>
-  <script src="https://unpkg.com/ml5@0.3.1/dist/ml5.min.js"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/0.9.0/p5.min.js"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/0.9.0/addons/p5.dom.min.js"></script>
+  <script src="https://unpkg.com/ml5@0.4.0/dist/ml5.min.js"></script>
 </head>
 
 <body>
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ml5",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "A friendly machine learning library for the web.",
   "main": "dist/ml5.min.js",
   "directories": {
diff --git a/src/index.js b/src/index.js
@@ -45,6 +45,7 @@ const withPreload = {
   word2vec,
   YOLO,
   uNet,
+  sentiment,
   bodyPix,
   faceApi,
 };
@@ -54,6 +55,5 @@ module.exports = Object.assign({p5Utils}, preloadRegister(withPreload), {
   ...imageUtils,
   tf,
   version,
-  sentiment,
   neuralNetwork,
 });

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "ml5",`
`3`		`- "version": "0.3.1",`
	`3`	`+ "version": "0.4.0",`
`4`	`4`	`"description": "A friendly machine learning library for the web.",`
`5`	`5`	`"main": "dist/ml5.min.js",`
`6`	`6`	`"directories": {`