Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Advanced Topic Tutorial 'Abracadabra: Speak With Your Hands in p5.js and ml5.js' is out of date. #507

Closed
gracywhelihan opened this issue Sep 4, 2024 · 2 comments · Fixed by #613
Labels
Bug: Broken Link Bug Something isn't working

Comments

@gracywhelihan
Copy link

Most appropriate sections of the p5.js website?

Tutorials

What is your operating system?

Mac OS

Web browser and version

Google Chrome 127.0.6533.89

Actual Behavior

For this tutorial there are many broken links and all of the example sketches throw errors because they are out of date. They do not have the correct m5l.js library in the html file and the ml5.js library has been updated so the code can be simplied

Expected Behavior

All of the links and examples should work and be up to date with the new changes that have been made to the ml5.js library. Also, the documentation of this tutorial should be updated to match the new code examples.

Steps to reproduce

Prerequisites

Step 1: Set up ml5.js

The examples used in this tutorial are not up to date with the new ml5 examples.

  • The HTML file in the p5.js editor should include <script src="https://unpkg.com/ml5@1/dist/ml5.min.js">

  • The static image example could link to the new ml5 example handPose-single-image by ml5

Step 2: understanding the data

  • The data in the tutorial should be updated. When the data is output, the updated version of HandPose provides more detailed information and uses different data and syntax than in this example.

  • The Examples: Annotation and Hats needs to be updated with the new version of the ml5.js library in the html file and can be simplified to match the handPose-single-image by ml5

  • The Example: Using a live Webcam feed can be updated to link to the example handPose-keypoints by ml5

  • Example: Hats using a live Webcam feed should then build off the previous Webcam feed example

Step 3 -  Adding interactivity 

  • These examples and code should just be updated so they work and are based on the new ml5.js examples for hand pose.

Next Steps

In this section the link to FaceMesh is incorrect and should be https://docs.ml5js.org/#/reference/facemesh
Also, users might be encouraged to explore BodyPose rather than PoseNet, as it is part of the ml5.js library just like HandPose and FaceMesh.

Resources:
The ml5.js HandPose Example link is broken and should link to https://docs.ml5js.org/#/reference/handpose?id=examples
And the Interactivity in p5.js link is broken and should link to https://p5js.org/tutorials/conditionals-and-interactivity/

Would you like to work on the issue?

yes I would like to work on this issue

@gracywhelihan gracywhelihan added the Bug Something isn't working label Sep 4, 2024
@limzykenneth
Copy link
Member

@gracywhelihan You can go ahead with a PR for a fix. Thanks.

@asukaminato0721
Copy link
Contributor

according to https://docs.ml5js.org/#/welcome/faq?id=what-happened-to-older-ml5js-releases,

link need to change to

<script src="https://unpkg.com/ml5@0.12.2/dist/ml5.min.js"></script>

working on it...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug: Broken Link Bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants