ml5js / ml5-website-v02-docsify

This repository is a work-in-progress website, containing documentation and reference materials for the ml5.js library models.
https://docs.ml5js.org/
Other
1 stars 11 forks source link

Update Models methods & properties (WIP) #93

Closed alanvww closed 5 months ago

alanvww commented 5 months ago

This PR is for updating methods and properties for each models. @ziyuan-linn Peter, thanks for the amazing works of the library and commenting everything! This update is based on the those content and also the latest examples in the collection. Feel free to review and leave any comments! @QuinnHe @myrahsa

Progress

netlify[bot] commented 5 months ago

Deploy Preview for ml5-next-gen-docs ready!

Name Link
Latest commit b833365c335e075ad656315789aac956822eecf0
Latest deploy log https://app.netlify.com/sites/ml5-next-gen-docs/deploys/6676ebecac0a4c0008b5af32
Deploy Preview https://deploy-preview-93--ml5-next-gen-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

QuinnHe commented 5 months ago

Hi @alanvww , thanks for the amazing updates! One thing I noticed, can we include options that are shared by MoveNet and Blaz

Screenshot 2024-06-17 at 8 44 38 PM

ePose. See the screenshot for reference.

alanvww commented 5 months ago

@QuinnHe got it! I will work on it now :)

alanvww commented 5 months ago

Quick update for the docs! Just confirmed with Peter, all score labels will be replaced with confidence in 1.0. Check PR here @QuinnHe @myrahsa @MOQN

alanvww commented 5 months ago

Resolved conflicts for updated to main and also included #112

QuinnHe commented 5 months ago

@alanvww some bodyseg really new PRs and Issues for your reference, the second one seems more urgent to be included: switch default runtime to tfjs: https://github.com/ml5js/ml5-next-gen/pull/140 BodySegmentation: Add raw values of the detected body parts to result: https://github.com/ml5js/ml5-next-gen/pull/139

alanvww commented 5 months ago

@alanvww some bodyseg really new PRs and Issues for your reference, the second one seems more urgent to be included: switch default runtime to tfjs: ml5js/ml5-next-gen#140 BodySegmentation: Add raw values of the detected body parts to result: ml5js/ml5-next-gen#139

I can fix it quickly now. But I didn't realize NN's workload was so huge. I better skip Sound Classifier and focus on this.

In the meantime, would you please also check the preview deployment of this PR to see the new content I added? I tried my best to match the source code, but it might still be missing something.

QuinnHe commented 5 months ago

@alanvww some bodyseg really new PRs and Issues for your reference, the second one seems more urgent to be included: switch default runtime to tfjs: ml5js/ml5-next-gen#140 BodySegmentation: Add raw values of the detected body parts to result: ml5js/ml5-next-gen#139

I can fix it quickly now. But I didn't realize NN's workload was so huge. I better skip Sound Classifier and focus on this.

In the meantime, would you please also check the preview deployment of this PR to see the new content I added? I tried my best to match the source code, but it might still be missing something.

Yes, I will go through them after I complete BodySeg other sections.

alanvww commented 5 months ago

@QuinnHe Got it! For the runtime change, I added the Runtime section in the glossary update. #84 Would you please review and merge this as well? I corrected the content and runtime is the only new section there. I don't think I'll add anything else before tomorrow's launch.

QuinnHe commented 5 months ago

@QuinnHe Got it! For the runtime change, I added the Runtime section in the glossary update. #84 Would you please review and merge this as well? I corrected the content and runtime is the only new section there. I don't think I'll add anything else before tomorrow's launch.

Thanks Alan, will review soon!

QuinnHe commented 5 months ago

@alanvww , I've done reviewing the models you have right now! I have to say, this is AWESOME! Thank you so much for your work Alan!!

alanvww commented 5 months ago

@alanvww , I've done reviewing the models you have right now! I have to say, this is AWESOME! Thank you so much for your work Alan!!

Thanks Quinn! Thanks for the reviews. My schedule is too fragmented these days and sometimes I can't finish reading the codes right away, so I have to go over things again and again. I wish I didn't mess things up too much lol.

QuinnHe commented 5 months ago

Hey @alanvww , just let you know that I will start to work on SoundClassifier now, let's avoid duplicated work :)

QuinnHe commented 5 months ago

@alanvww , I've done reviewing the models you have right now! I have to say, this is AWESOME! Thank you so much for your work Alan!!

Thanks Quinn! Thanks for the reviews. My schedule is too fragmented these days and sometimes I can't finish reading the codes right away, so I have to go over things again and again. I wish I didn't mess things up too much lol.

Haha as always you did awesome, no worries at all!

alanvww commented 5 months ago

Hey @alanvww , just let you know that I will start to work on SoundClassifier now, let's avoid duplicated work :)

All good!

alanvww commented 5 months ago

@QuinnHe @MOQN Last comment before bed. I just added Properties to the model pages.

Question about NN: The origin methods section of it is more like an instruction. The way I modify it right now is to make it match with other page's style more. But I think those contents are still very helpful for beginners.

Maybe we should separate it from the methods and use it in the guide?

QuinnHe commented 5 months ago

This PR is for updating methods and properties for each models. @ziyuan-linn Peter, thanks for the amazing works of the library and commenting everything! This update is based on the those content and also the latest examples in the collection. Feel free to review and leave any comments! @QuinnHe @myrahsa

Progress

  • [x] BodyPose
  • [x] HandPose
  • [x] FaceMesh
  • [x] Body Segmentation
  • [x] Image Classifier
  • [x] Sound Classifier 🚧
  • [x] Sentiment
  • [x] NN

Sound Classifier is done. #0649346

QuinnHe commented 5 months ago

@QuinnHe @MOQN Last comment before bed. I just added Properties to the model pages.

Question about NN: The origin methods section of it is more like an instruction. The way I modify it right now is to make it match with other page's style more. But I think those contents are still very helpful for beginners.

Maybe we should separate it from the methods and use it in the guide?

Thanks @alanvww for the work on Properties. After soft launch, we can consider put How to initialize NN uder ml5.neuralNetwork().

One small thing - can we make sure the Properties goes before Methods?

alanvww commented 5 months ago

@QuinnHe @MOQN Last comment before bed. I just added Properties to the model pages.

Question about NN: The origin methods section of it is more like an instruction. The way I modify it right now is to make it match with other page's style more. But I think those contents are still very helpful for beginners.

Maybe we should separate it from the methods and use it in the guide?

Thanks @alanvww for the work on Properties. After soft launch, we can consider put How to initialize NN uder ml5.neuralNetwork().

One small thing - can we make sure the Properties goes before Methods?

Got it. I am on my way to school now. Will fix that soon.

alanvww commented 5 months ago

@QuinnHe @MOQN this PR is ready for merge now!

QuinnHe commented 5 months ago

Thanks @alanvww ! This looks great! Merged