Skip to content

Commit 26945e0

Browse files
committed
Merge branch 'development' into release
2 parents d5c838d + 0681602 commit 26945e0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+392
-238
lines changed

.all-contributorsrc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -649,6 +649,16 @@
649649
"ideas",
650650
"example"
651651
]
652+
},
653+
{
654+
"login": "w3cj",
655+
"name": "CJ R.",
656+
"avatar_url": "https://avatars0.githubusercontent.com/u/14241866?v=4",
657+
"profile": "https://coding.garden",
658+
"contributions": [
659+
"doc",
660+
"content"
661+
]
652662
}
653663
],
654664
"contributorsPerLine": 7,

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ We’re still rolling out all of our unit tests, but if you want to contribute t
249249
```npm run test:single```
250250

251251
- To run a test on a single model
252-
```npm run test -- --model:YourModelNameHere```
252+
```npm run test -- --model=YourModelNameHere```
253253

254254
This last one is case sensitive!
255255

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ![ml5](https://user-images.githubusercontent.com/10605821/41332516-2ee26714-6eac-11e8-83e4-a40b8761e764.png)
2-
[![All Contributors](https://img.shields.io/badge/all_contributors-60-orange.svg?style=flat-square)](#contributors)
2+
[![All Contributors](https://img.shields.io/badge/all_contributors-61-orange.svg?style=flat-square)](#contributors)
33

44

55
[![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)
@@ -26,19 +26,21 @@ There are several ways you can use the ml5.js library:
2626

2727

2828

29+
2930
<p id="latest-version">
3031

31-
* You can use the latest version (0.4.0) by adding it to the head section of your HTML document:
32+
* You can use the latest version (0.4.1) by adding it to the head section of your HTML document:
3233

33-
**v0.4.0**
34+
**v0.4.1**
3435

35-
<script src="https://unpkg.com/[email protected].0/dist/ml5.min.js" type="text/javascript"></script>
36+
<script src="https://unpkg.com/[email protected].1/dist/ml5.min.js" type="text/javascript"></script>
3637

3738
</p data-id="latest-version">
3839

3940

4041

4142

43+
4244

4345

4446
* 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:
@@ -49,7 +51,7 @@ There are several ways you can use the ml5.js library:
4951

5052
For example:
5153
```js
52-
<script src="https://unpkg.com/ml5@0.3.1/dist/ml5.min.js" type="text/javascript"></script>
54+
<script src="https://unpkg.com/ml5@0.4.1/dist/ml5.min.js" type="text/javascript"></script>
5355
```
5456

5557
* You can also reference "latest", but we do not recommend this as your code may break as we update ml5.
@@ -170,6 +172,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
170172
<td align="center"><a href="https://github.com/EmmaGoodliffe"><img src="https://avatars1.githubusercontent.com/u/32788926?v=4" width="100px;" alt="Emma Goodliffe"/><br /><sub><b>Emma Goodliffe</b></sub></a><br /><a href="#ideas-EmmaGoodliffe" title="Ideas, Planning, & Feedback">🤔</a> <a href="#question-EmmaGoodliffe" title="Answering Questions">💬</a> <a href="#maintenance-EmmaGoodliffe" title="Maintenance">🚧</a></td>
171173
<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>
172174
<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>
175+
<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>
173176
</tr>
174177
</table>
175178

docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ The fastest way to get started exploring the creative possibilities of ml5.js ar
1919
3. You can also copy and paste the cdn link to the ml5 library here:
2020

2121
```
22-
<script src="https://unpkg.com/[email protected].0/dist/ml5.min.js"></script>
22+
<script src="https://unpkg.com/[email protected].1/dist/ml5.min.js"></script>
2323
```
2424

2525
***
2626
#### Quickstart: Plain JavaScript
2727

28-
Reference the [latest version](https://unpkg.com/[email protected].0/dist/ml5.min.js) of ml5.js using a script tag in an HTML file as below:
28+
Reference the [latest version](https://unpkg.com/[email protected].1/dist/ml5.min.js) of ml5.js using a script tag in an HTML file as below:
2929

3030

3131
In an **index.html** file, copy and paste the following and open up that file in your web browser.
@@ -34,15 +34,15 @@ In an **index.html** file, copy and paste the following and open up that file in
3434
<!DOCTYPE html>
3535
<html lang="en">
3636
<head>
37-
<title>Getting Started with ml5.js and p5.js</title>
37+
<title>Getting Started with ml5.js</title>
3838
<meta name="viewport" content="width=device-width, initial-scale=1.0">
39-
<script src="https://unpkg.com/[email protected].0/dist/ml5.min.js"></script>
39+
<script src="https://unpkg.com/[email protected].1/dist/ml5.min.js"></script>
4040
</head>
4141

4242
<body>
4343
<script>
4444
// Your code will go here
45-
// open up your console - if everything loaded properly you should see 0.4.0
45+
// open up your console - if everything loaded properly you should see 0.4.1
4646
console.log('ml5 version:', ml5.version);
4747
4848
</script>
@@ -71,7 +71,7 @@ In an **index.html** file, copy and paste the following and open up that file in
7171
<script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/0.9.0/addons/p5.dom.min.js"></script>
7272
<script src="https://cdnjs.cloudflare.com/ajax/libs/p5.js/0.9.0/addons/p5.sound.min.js"></script>
7373
<!-- ml5 -->
74-
<script src="https://unpkg.com/[email protected].0/dist/ml5.min.js"></script>
74+
<script src="https://unpkg.com/[email protected].1/dist/ml5.min.js"></script>
7575
</head>
7676

7777
<body>

docs/_sidebar.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@
5252
* [CharRNN](/reference/charrnn.md)
5353
* [Sentiment](/reference/sentiment.md)
5454
* [Word2Vec](/reference/word2vec.md)
55-
* [SketchRNN](/reference/sketchrnn.md)
5655

5756
* **Contributing** 🏗
5857
<div class="Sidebar__section-divider">&nbsp;</div>
@@ -62,4 +61,4 @@
6261
* Style Guide
6362
* [Reference guidelines](/styleguide/reference-guidelines.md)
6463
* [Development guidelines](/styleguide/development-guidelines.md)
65-
* [Design guidelines](/styleguide/design-guidelines.md)
64+
* [Design guidelines](/styleguide/design-guidelines.md)

docs/reference/bodypix.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,10 @@ bodyPix.segmentWithParts(?input, ?options, callback)
234234
* [BodyPix_p5Instance](https://github.com/ml5js/ml5-examples/tree/development/p5js/BodyPix/BodyPix_p5Instance)
235235
236236
**p5 web editor**
237-
* none yet
237+
* [BodyPix_Image](https://editor.p5js.org/ml5/sketches/BodyPix_Image)
238+
* [BodyPix_Webcam](https://editor.p5js.org/ml5/sketches/BodyPix_Webcam)
239+
* [BodyPix_Webcam_Parts](https://editor.p5js.org/ml5/sketches/BodyPix_Webcam_Parts)
240+
* [BodyPix_p5Instance](https://editor.p5js.org/ml5/sketches/BodyPix_p5Instance)
238241
239242
**plain javascript**
240243
* [BodyPix_Image](https://github.com/ml5js/ml5-examples/tree/development/javascript/BodyPix/BodyPix_Image)

docs/reference/charrnn.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,9 @@ charrnn.reset()
159159
160160
**p5 web editor**
161161
162-
* [CharRNN_Interactive](https://editor.p5js.org/ml5/sketches/u7FVGffzX)
163-
* [CharRNN_Text](https://editor.p5js.org/ml5/sketches/fAzNrafbpa)
164-
* [CharRNN_Text_Stateful](https://editor.p5js.org/ml5/sketches/AmPtRcgoX7)
162+
* [CharRNN_Interactive](https://editor.p5js.org/ml5/sketches/CharRNN_Interactive)
163+
* [CharRNN_Text](https://editor.p5js.org/ml5/sketches/CharRNN_Text)
164+
* [CharRNN_Text_Stateful](https://editor.p5js.org/ml5/sketches/CharRNN_Text_Stateful)
165165
166166
**plain javascript**
167167
* [CharRNN_Interactive](https://github.com/ml5js/ml5-examples/tree/development/javascript/CharRNN/CharRNN_Interactive)

docs/reference/cvae.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ cvae.generate(label, callback);
8888
* [CVAE_QuickDraw](https://github.com/ml5js/ml5-examples/tree/development/p5js/CVAE/CVAE_QuickDraw)
8989
9090
**p5 web editor**
91-
* [CVAE_QuickDraw]()
91+
* [CVAE_QuickDraw](https://editor.p5js.org/ml5/sketches/CVAE_QuickDraw)
9292
9393
**plain javascript**
9494
* [CVAE_QuickDraw](https://github.com/ml5js/ml5-examples/tree/development/javascript/CVAE/CVAE_QuickDraw)

docs/reference/dcgan.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -101,24 +101,26 @@ dcgan.generate(callback, ?latentVector);
101101
102102
## Examples
103103
104-
**plain javascript**
105-
* [DCGAN_LatentVector](https://github.com/ml5js/ml5-examples/tree/development/javascript/DCGAN/DCGAN_LatentVector)
106-
* [DCGAN_LatentVector_RandomWalk](https://github.com/ml5js/ml5-examples/tree/development/javascript/DCGAN/DCGAN_LatentVector_RandomWalk)
107-
* [DCGAN_LatentVector_Slider](https://github.com/ml5js/ml5-examples/tree/development/javascript/DCGAN/DCGAN_LatentVector_Slider)
108-
* [DCGAN_Random](https://github.com/ml5js/ml5-examples/tree/development/javascript/DCGAN/DCGAN_Random)
109-
110-
111104
**p5.js**
112105
* [DCGAN_LatentVector](https://github.com/ml5js/ml5-examples/tree/development/p5js/DCGAN/DCGAN_LatentVector)
113106
* [DCGAN_LatentVector_RandomWalk](https://github.com/ml5js/ml5-examples/tree/development/p5js/DCGAN/DCGAN_LatentVector_RandomWalk)
114107
* [DCGAN_LatentVector_Slider](https://github.com/ml5js/ml5-examples/tree/development/p5js/DCGAN/DCGAN_LatentVector_Slider)
115108
* [DCGAN_Random](https://github.com/ml5js/ml5-examples/tree/development/p5js/DCGAN/DCGAN_Random)
116109
117110
**p5 web editor**
118-
* [DCGAN_LatentVector]()
119-
* [DCGAN_LatentVector_RandomWalk]()
120-
* [DCGAN_LatentVector_Slider]()
121-
* [DCGAN_Random]()
111+
* [DCGAN_LatentVector](https://editor.p5js.org/ml5/sketches/DCGAN_LatentVector)
112+
* [DCGAN_LatentVector_RandomWalk](https://editor.p5js.org/ml5/sketches/DCGAN_LatentVector_RandomWalk)
113+
* [DCGAN_LatentVector_Slider](https://editor.p5js.org/ml5/sketches/DCGAN_LatentVector_Slider)
114+
* [DCGAN_Random](https://editor.p5js.org/ml5/sketches/DCGAN_Random)
115+
116+
117+
**plain javascript**
118+
* [DCGAN_LatentVector](https://github.com/ml5js/ml5-examples/tree/development/javascript/DCGAN/DCGAN_LatentVector)
119+
* [DCGAN_LatentVector_RandomWalk](https://github.com/ml5js/ml5-examples/tree/development/javascript/DCGAN/DCGAN_LatentVector_RandomWalk)
120+
* [DCGAN_LatentVector_Slider](https://github.com/ml5js/ml5-examples/tree/development/javascript/DCGAN/DCGAN_LatentVector_Slider)
121+
* [DCGAN_Random](https://github.com/ml5js/ml5-examples/tree/development/javascript/DCGAN/DCGAN_Random)
122+
123+
122124
123125
## Demo
124126

docs/reference/face-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,8 @@ faceapi.detectSingle(optionsOrCallback, configOrCallback, cb)
147147
* [FaceApi_Video_Landmarks_LocalModels](https://github.com/ml5js/ml5-examples/tree/development/p5js/FaceApi/FaceApi_Video_Landmarks_LocalModels)
148148
149149
**p5 web editor**
150-
* [FaceApi_Image_Landmarks]() - coming soon
151-
* [FaceApi_Video_Landmarks]() - coming soon
150+
* [FaceApi_Image_Landmarks](https://editor.p5js.org/ml5/sketches/FaceApi_Image_Landmarks)
151+
* [FaceApi_Video_Landmarks](https://editor.p5js.org/ml5/sketches/FaceApi_Video_Landmarks)
152152
153153
**plain javascript**
154154
* [FaceApi_Image_Landmarks](https://github.com/ml5js/ml5-examples/tree/development/javascript/FaceApi/FaceApi_Image_Landmarks/)

0 commit comments

Comments
 (0)