Skip to content

Commit 23699d3

Browse files
joeykleejoeyklee
authored
[docs] Updates docs (#636)
* adds bodypix notes * updates docs with contributors and p5 web editor links if available * adds kmeans docs * updates sidebar highlight style
1 parent 8bc05aa commit 23699d3

23 files changed

+295
-161
lines changed

‎docs/_media/reference__header-kmeans.png‎

95.1 KB
Loading

‎docs/_sidebar.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,38 @@
11
<style>
22
.Sidebar__section-divider{
33
height:1px;
4-
width:95%;
4+
width:90%;
55
border-top:2px solid #A15FFB;
66
display:block;
7-
margin:0 auto;
7+
margin:0 0px 0 -2px;
88
box-shadow: 1px 1px 4px rgba(0,0,0,0.2);
99
}
1010
</style>
1111

1212
* **Welcome** 🌈
13+
<div class="Sidebar__section-divider">&nbsp;</div>
14+
1315
* [Getting Started](/)
1416
* [FAQ](/faq.md)
1517

16-
<div class="Sidebar__section-divider">&nbsp;</div>
18+
1719

1820
* **Tutorials** 🧠
21+
<div class="Sidebar__section-divider">&nbsp;</div>
22+
1923
* [Introduction to ml5.js](/tutorials/hello-ml5.md)
2024
* [Running a local web server](/tutorials/local-web-server)
2125
* [Promises and Callbacks in ml5](/tutorials/promises-and-callbacks.md)
2226

27+
* **Reference** 📝
2328
<div class="Sidebar__section-divider">&nbsp;</div>
2429

25-
* **Reference** 📝
2630
* [Overview](/reference/index.md)
2731
* **Helpers** ✨
2832
* [NeuralNetwork](/reference/neural-network.md)
2933
* [FeatureExtractor](/reference/feature-extractor.md)
3034
* [KNNClassifier](/reference/knn-classifier.md)
35+
* [kmeans](/reference/kmeans.md)
3136
* **Image** 🖼
3237
* [ImageClassifier](/reference/image-classifier.md)
3338
* [PoseNet](/reference/posenet.md)
@@ -49,9 +54,9 @@
4954
* [Word2Vec](/reference/word2vec.md)
5055
* [SketchRNN](/reference/sketchrnn.md)
5156

57+
* **Contributing** 🏗
5258
<div class="Sidebar__section-divider">&nbsp;</div>
5359

54-
* **Contributing** 🏗
5560
* [Contributor Notes](/styleguide/contributor-notes.md)
5661
* [Maintenance Notes](/styleguide/maintenance-notes.md)
5762
* Style Guide

‎docs/reference/bodypix.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ bodyPix.segment(?input, ?options, callback)
191191
192192
📥 **Inputs**
193193
194-
* **input**: HTMLImageElement | ImageData | HTMLCanvasElement. NOTE: Videos should be added in the constructor.
194+
* **input**: HTMLImageElement | | HTMLVideoElement | ImageData | HTMLCanvasElement. NOTE: Videos can be added in the constructor.
195195
* **options**: Object. You can change the `outputStride and `segmentationThreshold`
196196
* **callback**: Function. A function to handle the results of `.segment()`. Likely a function to do something with the segmented image.
197197

@@ -214,7 +214,7 @@ bodyPix.segmentWithParts(?input, ?options, callback)
214214
215215
📥 **Inputs**
216216
217-
* **input**: HTMLImageElement | ImageData | HTMLCanvasElement. NOTE: Videos should be added in the constructor.
217+
* **input**: HTMLImageElement | HTMLVideoElement | ImageData | HTMLCanvasElement. NOTE: Videos can be added in the constructor.
218218
* **options**: Object. You can change the `outputStride and `segmentationThreshold`
219219
* **callback**: Function. A function to handle the results of `.segment()`. Likely a function to do something with the segmented image.
220220
@@ -227,20 +227,19 @@ bodyPix.segmentWithParts(?input, ?options, callback)
227227
228228
## Examples
229229
230-
**plain javascript**
231-
* [BodyPix_Image](https://github.com/ml5js/ml5-examples/tree/development/javascript/BodyPix/BodyPix_Image)
232-
* [BodyPix_Webcam](https://github.com/ml5js/ml5-examples/tree/development/javascript/BodyPix/BodyPix_Webcam)
233-
* [BodyPix_Webcam_Parts](https://github.com/ml5js/ml5-examples/tree/development/javascript/BodyPix/BodyPix_Webcam_Parts)
234-
235230
**p5.js**
236231
* [BodyPix_Image](https://github.com/ml5js/ml5-examples/tree/development/p5js/BodyPix/BodyPix_Image)
237232
* [BodyPix_Webcam](https://github.com/ml5js/ml5-examples/tree/development/p5js/BodyPix/BodyPix_Webcam)
238233
* [BodyPix_Webcam_Parts](https://github.com/ml5js/ml5-examples/tree/development/p5js/BodyPix/BodyPix_Webcam_Parts)
239234
* [BodyPix_p5Instance](https://github.com/ml5js/ml5-examples/tree/development/p5js/BodyPix/BodyPix_p5Instance)
240235
241236
**p5 web editor**
242-
* [Example 1]()
243-
* [Example 2]()
237+
* none yet
238+
239+
**plain javascript**
240+
* [BodyPix_Image](https://github.com/ml5js/ml5-examples/tree/development/javascript/BodyPix/BodyPix_Image)
241+
* [BodyPix_Webcam](https://github.com/ml5js/ml5-examples/tree/development/javascript/BodyPix/BodyPix_Webcam)
242+
* [BodyPix_Webcam_Parts](https://github.com/ml5js/ml5-examples/tree/development/javascript/BodyPix/BodyPix_Webcam_Parts)
244243
245244
## Demo
246245
@@ -253,13 +252,14 @@ No tutorials yet - contribute one today!
253252
## Acknowledgements
254253
255254
**Contributors**:
256-
* Name 1
257-
* Name 2
255+
* Ported to ml5.js by [Joey Lee](https://jk-lee.com).
258256
259257
**Credits**:
260-
* Paper Reference | Website URL | Github Repo | Book reference | etc
258+
* The BodyPix model was developed by [Dan Oved](https://www.danioved.com/) and [Tyler Zhu](https://ai.google/research/people/TylerZhu) and their [additional contributors](https://github.com/tensorflow/tfjs-models/tree/master/body-pix#acknowledgement). Learn more about BodyPix:
259+
* [BodyPix on Github](https://github.com/tensorflow/tfjs-models/tree/master/body-pix#acknowledgement)
260+
* [BodyPix blog post release](https://medium.com/tensorflow/introducing-bodypix-real-time-person-segmentation-in-the-browser-with-tensorflow-js-f1948126c2a0)
261261
262262
263263
## Source Code
264264
265-
* [/src/BodyPix]()
265+
* [/src/BodyPix](https://github.com/ml5js/ml5-library/tree/development/src/BodyPix)

‎docs/reference/charrnn.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -152,20 +152,21 @@ charrnn.reset()
152152
153153
## Examples
154154
155-
**plain javascript**
156-
* [CharRNN_Interactive](https://github.com/ml5js/ml5-examples/tree/development/javascript/CharRNN/CharRNN_Interactive)
157-
* [CharRNN_Text](https://github.com/ml5js/ml5-examples/tree/development/javascript/CharRNN/CharRNN_Text)
158-
* [CharRNN_Text_Stateful](https://github.com/ml5js/ml5-examples/tree/development/javascript/CharRNN/CharRNN_Text_Stateful)
159-
160-
161155
**p5.js**
162156
* [CharRNN_Interactive](https://github.com/ml5js/ml5-examples/tree/development/p5js/CharRNN/CharRNN_Interactive)
163157
* [CharRNN_Text](https://github.com/ml5js/ml5-examples/tree/development/p5js/CharRNN/CharRNN_Text)
164158
* [CharRNN_Text_Stateful](https://github.com/ml5js/ml5-examples/tree/development/p5js/CharRNN/CharRNN_Text_Stateful)
165159
166160
**p5 web editor**
167-
* [Example 1]()
168-
* [Example 2]()
161+
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)
165+
166+
**plain javascript**
167+
* [CharRNN_Interactive](https://github.com/ml5js/ml5-examples/tree/development/javascript/CharRNN/CharRNN_Interactive)
168+
* [CharRNN_Text](https://github.com/ml5js/ml5-examples/tree/development/javascript/CharRNN/CharRNN_Text)
169+
* [CharRNN_Text_Stateful](https://github.com/ml5js/ml5-examples/tree/development/javascript/CharRNN/CharRNN_Text_Stateful)
169170
170171
## Demo
171172
@@ -178,8 +179,7 @@ No tutorials yet - contribute one today!
178179
## Acknowledgements
179180
180181
**Contributors**:
181-
* Name 1
182-
* Name 2
182+
* Cristobal Valenzuela and Memo Atken
183183
184184
**Credits**:
185185
* Paper Reference | Website URL | Github Repo | Book reference | etc

‎docs/reference/cvae.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,14 @@ cvae.generate(label, callback);
8484
8585
## Examples
8686
87-
**plain javascript**
88-
* [CVAE_QuickDraw](https://github.com/ml5js/ml5-examples/tree/development/javascript/CVAE/CVAE_QuickDraw)
89-
9087
**p5.js**
9188
* [CVAE_QuickDraw](https://github.com/ml5js/ml5-examples/tree/development/p5js/CVAE/CVAE_QuickDraw)
9289
9390
**p5 web editor**
9491
* [CVAE_QuickDraw]()
9592
93+
**plain javascript**
94+
* [CVAE_QuickDraw](https://github.com/ml5js/ml5-examples/tree/development/javascript/CVAE/CVAE_QuickDraw)
9695
9796
9897
## Demo
@@ -106,8 +105,7 @@ No tutorials yet - contribute one today!
106105
## Acknowledgements
107106
108107
**Contributors**:
109-
* Name 1
110-
* Name 2
108+
* Wenhe Li & Dingsu (Derek) Wang
111109
112110
**Credits**:
113111
* Paper Reference | Website URL | Github Repo | Book reference | etc

‎docs/reference/dcgan.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ No demos yet - contribute one today!
131131
## Acknowledgements
132132
133133
**Contributors**:
134-
* Name 1
135-
* Name 2
134+
* YG Zhang & Rui An
135+
* Additional contributions by Joey Lee
136136
137137
**Credits**:
138138
* Paper Reference | Website URL | Github Repo | Book reference | etc

‎docs/reference/face-api.md‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -141,20 +141,19 @@ faceapi.detectSingle(optionsOrCallback, configOrCallback, cb)
141141
142142
## Examples
143143
144-
**plain javascript**
145-
* [FaceApi_Image_Landmarks](https://github.com/ml5js/ml5-examples/tree/development/javascript/FaceApi/FaceApi_Image_Landmarks/)
146-
* [FaceApi_Video_Landmarks](https://github.com/ml5js/ml5-examples/tree/development/javascript/FaceApi/FaceApi_Video_Landmarks/)
147-
* [FaceApi_Video_Landmarks_LocalModels](https://github.com/ml5js/ml5-examples/tree/development/javascript/FaceApi/FaceApi_Video_Landmarks_LocalModels/)
148-
149-
150144
**p5.js**
151145
* [FaceApi_Image_Landmarks](https://github.com/ml5js/ml5-examples/tree/development/p5js/FaceApi/FaceApi_Image_Landmarks)
152146
* [FaceApi_Video_Landmarks](https://github.com/ml5js/ml5-examples/tree/development/p5js/FaceApi/FaceApi_Video_Landmarks)
153147
* [FaceApi_Video_Landmarks_LocalModels](https://github.com/ml5js/ml5-examples/tree/development/p5js/FaceApi/FaceApi_Video_Landmarks_LocalModels)
154148
155149
**p5 web editor**
156-
* [Example 1]()
157-
* [Example 2]()
150+
* [FaceApi_Image_Landmarks]() - coming soon
151+
* [FaceApi_Video_Landmarks]() - coming soon
152+
153+
**plain javascript**
154+
* [FaceApi_Image_Landmarks](https://github.com/ml5js/ml5-examples/tree/development/javascript/FaceApi/FaceApi_Image_Landmarks/)
155+
* [FaceApi_Video_Landmarks](https://github.com/ml5js/ml5-examples/tree/development/javascript/FaceApi/FaceApi_Video_Landmarks/)
156+
* [FaceApi_Video_Landmarks_LocalModels](https://github.com/ml5js/ml5-examples/tree/development/javascript/FaceApi/FaceApi_Video_Landmarks_LocalModels/)
158157
159158
## Demo
160159
@@ -168,11 +167,10 @@ No tutorials yet - contribute one today!
168167
## Acknowledgements
169168
170169
**Contributors**:
171-
* Name 1
172-
* Name 2
170+
* Ported by [Joey Lee](https://jk-lee.com)
173171
174172
**Credits**:
175-
* Paper Reference | Website URL | Github Repo | Book reference | etc
173+
* [Face-api.js](https://github.com/justadudewhohacks/face-api.js/blob/master/README.md) is an open source project built by [Vincent Mühler](https://github.com/justadudewhohacks).
176174
177175
## Source Code
178176

‎docs/reference/feature-extractor.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -220,18 +220,18 @@ featureExtractor.predict(input, ?callback)
220220
221221
## Examples
222222
223-
**plain javascript**
224-
* [FeatureExtractor_Image_Regression](https://github.com/ml5js/ml5-examples/tree/development/javascript/FeatureExtractor/FeatureExtractor_Image_Regression)
225-
* [FeatureExtractor_Image_Classification](https://github.com/ml5js/ml5-examples/tree/development/javascript/FeatureExtractor/FeatureExtractor_Image_Classification)
226-
227-
228223
**p5.js**
229224
* [FeatureExtractor_Image_Regression](https://github.com/ml5js/ml5-examples/tree/development/p5js/FeatureExtractor/FeatureExtractor_Image_Regression)
230225
* [FeatureExtractor_Image_Classification](https://github.com/ml5js/ml5-examples/tree/development/p5js/FeatureExtractor/FeatureExtractor_Image_Classification)
231226
232227
**p5 web editor**
233-
* [FeatureExtractor_Image_Regression]()
234-
* [FeatureExtractor_Image_Classification]()
228+
* [FeatureExtractor_Image_Classification](https://editor.p5js.org/ml5/sketches/4AWAKkeZBx)
229+
* [FeatureExtractor_Image_Regression](https://editor.p5js.org/ml5/sketches/AAA54W1ajd)
230+
231+
**plain javascript**
232+
* [FeatureExtractor_Image_Regression](https://github.com/ml5js/ml5-examples/tree/development/javascript/FeatureExtractor/FeatureExtractor_Image_Regression)
233+
* [FeatureExtractor_Image_Classification](https://github.com/ml5js/ml5-examples/tree/development/javascript/FeatureExtractor/FeatureExtractor_Image_Classification)
234+
235235
236236
237237
## Demo
@@ -252,8 +252,7 @@ No demos yet - contribute one today!
252252
## Acknowledgements
253253
254254
**Contributors**:
255-
* Name 1
256-
* Name 2
255+
* Yining Shi & Cristobal Valenzuela
257256
258257
**Credits**:
259258
* Paper Reference | Website URL | Github Repo | Book reference | etc

‎docs/reference/image-classifier.md‎

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -123,17 +123,6 @@ classifier.classify(?numberOfClasses ,?callback)
123123
124124
## Examples
125125
126-
**plain javascript**
127-
* [ImageClassification](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification)
128-
* [ImageClassification_DoodleNet_Canvas](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_DoodleNet_Canvas)
129-
* [ImageClassification_DoodleNet_Video](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_DoodleNet_Video)
130-
* [ImageClassification_MultipleImages](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_MultipleImages)
131-
* [ImageClassification_Video](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_Video)
132-
* [ImageClassification_VideoScavengerHunt](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_VideoScavengerHunt)
133-
* [ImageClassification_VideoSound](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_VideoSound)
134-
* [ImageClassification_VideoSoundTranslate](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_VideoSoundTranslate)
135-
* [ImageClassification_Video_Load](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_Video_Load)
136-
137126
**p5.js**
138127
* [ImageClassification](https://github.com/ml5js/ml5-examples/tree/development/p5js/ImageClassification/ImageClassification)
139128
* [ImageClassification_DoodleNet_Canvas](https://github.com/ml5js/ml5-examples/tree/development/p5js/ImageClassification/ImageClassification_DoodleNet_Canvas)
@@ -148,7 +137,25 @@ classifier.classify(?numberOfClasses ,?callback)
148137
149138
**p5.js Web Editor**
150139
151-
* coming soon!
140+
* [ImageClassification](https://editor.p5js.org/ml5/sketches/DUxe1Z0DXG)
141+
* [ImageClassification_DoodleNet_Canvas]() - coming soon
142+
* [ImageClassification_DoodleNet_Video]() - coming soon
143+
* [ImageClassification_MultipleImages](https://editor.p5js.org/ml5/sketches/f3rqIqNey5)
144+
* [ImageClassification_Teachable-Machine]() - coming soon
145+
* [ImageClassification_Video](https://editor.p5js.org/ml5/sketches/IlF1JFvWjc)
146+
* [ImageClassification_VideoScavengerHunt](https://editor.p5js.org/ml5/sketches/APzpeXOuEQ)
147+
* [ImageClassification_VideoSound](https://editor.p5js.org/ml5/sketches/Ry7EL4JvA3)
148+
149+
**plain javascript**
150+
* [ImageClassification](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification)
151+
* [ImageClassification_DoodleNet_Canvas](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_DoodleNet_Canvas)
152+
* [ImageClassification_DoodleNet_Video](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_DoodleNet_Video)
153+
* [ImageClassification_MultipleImages](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_MultipleImages)
154+
* [ImageClassification_Video](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_Video)
155+
* [ImageClassification_VideoScavengerHunt](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_VideoScavengerHunt)
156+
* [ImageClassification_VideoSound](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_VideoSound)
157+
* [ImageClassification_VideoSoundTranslate](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_VideoSoundTranslate)
158+
* [ImageClassification_Video_Load](https://github.com/ml5js/ml5-examples/tree/development/javascript/ImageClassification/ImageClassification_Video_Load)
152159
153160
## Demo
154161
@@ -166,8 +173,8 @@ No demos yet - contribute one today!
166173
## Acknowledgements
167174
168175
**Contributors**:
169-
* Name 1
170-
* Name 2
176+
* [Cristobal Valenzuela](https://cvalenzuelab.com/)
177+
* [Yining Shi](https://1023.io)
171178
172179
**Credits**:
173180
* Paper Reference | Website URL | Github Repo | Book reference | etc

0 commit comments

Comments
 (0)