You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorials/hello-ml5.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,7 +44,7 @@ Your project directory should look something like this:
44
44
45
45
## Demo
46
46
47
-
This example is built with p5.js. You can also find the same example without p5.js [here](https://github.com/ml5js/ml5-examples/tree/release/javascript/ImageClassification).
47
+
This example is built with p5.js. You can also find the same example without p5.js [here](https://github.com/ml5js/ml5-library/tree/development/examples/javascript/ImageClassification/ImageClassification).
48
48
49
49
<br/>
50
50
@@ -55,7 +55,7 @@ This example is built with p5.js. You can also find the same example without p5.
Copy file name to clipboardExpand all lines: docs/tutorials/local-web-server.md
+4-30Lines changed: 4 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,38 +4,12 @@ If you've looked at our [quickstart](/getting-started/) and [introduction to ml5
4
4
5
5
<br/>
6
6
7
-
A big part of the ml5 project is to create lots of examples as launching points for all your creative project ideas. You can find all of the ml5.js examples at out Github page: [ml5-examples](https://github.com/ml5js/ml5-examples). If you start to explore these examples you can see how the different ml5 functions are used to accomplish different outcomes. We try our best to keep the examples as simple as possible so you can easily start to build your ideas on top of them.
7
+
A big part of the ml5 project is to create lots of examples as launching points for all your creative project ideas. You can find all of the ml5.js examples at our Github page: [ml5-library](https://github.com/ml5js/ml5-library/tree/development/examples). If you start to explore these examples you can see how the different ml5 functions are used to accomplish different outcomes. We try our best to keep the examples as simple as possible so you can easily start to build your ideas on top of them.
8
8
9
9
You can check out all the examples running:
10
-
> -[on this massive list](https://github.com/ml5js/ml5-examples#examples-index)
10
+
> -[on this massive list](https://examples.ml5js.org/)
11
11
> -[on the p5 web editor](https://editor.p5js.org/ml5/sketches)
12
12
13
-
If you'd like to download the examples and run them locally, download the [ml5-examples github repo](https://github.com/ml5js/ml5-examples) and run a local web server at the root directory (if this sentence sounds foreign to you, see the How-To section below). The fastest way to do this is:
13
+
If you'd like to download the examples and run them locally, download the [ml5-library github repo](https://github.com/ml5js/ml5-library) and follow the instructions [here](https://github.com/ml5js/ml5-library/blob/development/examples/README.md#setup).
14
14
15
-
<br/>
16
-
17
-
with **python3** installed on your computer:
18
-
```bash
19
-
cd /path/to/ml5-examples
20
-
python -m http.server 8081
21
-
```
22
-
23
-
<br/>
24
-
25
-
with **python2.7** installed on your computer:
26
-
27
-
```bash
28
-
cd /path/to/ml5-examples
29
-
python -m SimpleHTTPServer 8081
30
-
```
31
-
32
-
Then open up your web browser to the url: **localhost:8081**
33
-
34
-
<br/>
35
-
36
-
Here we set the port number to **8081**, but you can change the port number to something else like **3000** (then: **localhost:3030**), **3001** (then: **localhost:3031**) for example.
37
-
38
-
39
-
## How to: Run examples and develop "locally"
40
-
41
-
Coming soon! In the meantime, you can watch [CodingTrain - getting set up](https://www.youtube.com/watch?v=UCHzlUiDD10) for a nice intro on getting set up with writing code for the web.
15
+
You may also be interested in watching [CodingTrain - getting set up](https://www.youtube.com/watch?v=UCHzlUiDD10) for a nice intro on getting set up with writing code for the web.
Copy file name to clipboardExpand all lines: examples/README.md
+6-23Lines changed: 6 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
## Description
4
4
5
-
This repository contains a collection of examples using [ml5.js](https://github.com/ml5js/ml5-library). The examples are meant to serve as an introduction to the library and machine learning concepts.
5
+
The examples are meant to serve as an introduction to the library and machine learning concepts.
6
6
7
7
Examples are organized into folders according to their integration with other JavaScript libraries.
8
8
9
-
For example, the `/p5js` folder holds examples of using [ml5.js](https://github.com/ml5js/ml5-library) with [p5.js](https://p5js.org/). All examples are self-contained and can be run independently. Libraries are loaded through a Content Delivery Network (CDN) and certain examples (indicated in code comments) download a machine learning model from a "cloud" url. This means that ml5 currently relies on an internet connection in order to retrieve pre-trained models (unless they are served locally).
9
+
For example, the `examples/p5js` folder holds examples of using [ml5.js](https://github.com/ml5js/ml5-library) with [p5.js](https://p5js.org/). All examples are self-contained and can be run independently. Libraries are loaded through a Content Delivery Network (CDN) and certain examples (indicated in code comments) download a machine learning model from a "cloud" url. This means that ml5 currently relies on an internet connection in order to retrieve pre-trained models (unless they are served locally).
10
10
11
11
Instead of using the CDN links to p5 and ml5, you can [download the p5.js libraries here](https://github.com/processing/p5.js/releases) and [ml5 library here](https://github.com/ml5js/ml5-library/releases).
If you don't know how to start a server, check [this guide on how to start a local web server](https://learn.ml5js.org/docs/#/tutorials/local-web-server?id=running-a-local-web-server).
43
43
44
44
45
-
## Usage
46
-
47
-
Open your terminal
48
-
49
-
```sh
50
-
# change directories
51
-
cd ml5-examples
52
-
53
-
# run the local web server
54
-
npm run develop
55
-
56
-
# you should be able to run the examples at:
57
-
# localhost:8082
58
-
59
-
```
60
-
61
-
62
45
## Examples Index
63
46
64
47
*[ml5 examples in the p5 web editor](https://editor.p5js.org/ml5/sketches)
65
48
* The best way to interact with our examples are using the [p5 web editor](https://editor.p5js.org/ml5/sketches). This is an interactive coding environment.
66
-
* Run the examples using the [example index](https://ml5js.github.io/ml5-examples/public)
49
+
* Run the examples using the [example index](https://examples.ml5js.org/)
67
50
* We have examples written in plain javascript, p5.js, and more.
0 commit comments