Skip to content

Conversation

nasif-co
Copy link
Contributor

@nasif-co nasif-co commented Oct 6, 2025

Adding documentation for the depth estimation module in preparation for the coming release!

@nasif-co nasif-co requested a review from MOQN October 6, 2025 03:28
Copy link

netlify bot commented Oct 6, 2025

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

Name Link
🔨 Latest commit 916d3b0
🔍 Latest deploy log https://app.netlify.com/projects/ml5-next-gen-docs/deploys/68e6b132292a8900098f7625
😎 Deploy Preview https://deploy-preview-212--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 project configuration.

@MOQN
Copy link
Member

MOQN commented Oct 6, 2025

@nasif-co This looks amazing!! I really appreciate your time and effort. I’ll merge it once @AidanNelson’s comments on Discord are addressed.

We’ve structured our reference page as below so that beginner-level students can easily navigate and access the materials. Please understand that the page structure may be adjusted in the future for clarity and consistency.

Structure

  • Description
  • Quick Start
  • Examples
  • Step-by-Step Guide
  • Methods

So, the following three sections should be included under Step-by-Step Guide:

  • Initialization and Options
  • Estimating Depth
  • Using the Depth Result

The Methods section can be incorporated later.

I might reach out to @XiaozaoWang for a visual that can be placed at the top! 😄

Also address the highlighted example being too dark, by turning on normalizeDynamically
@nasif-co
Copy link
Contributor Author

nasif-co commented Oct 8, 2025

Just pushed the changes addressing the comments by @MOQN and @AidanNelson:

  • Restructured the doc to follow the common ml5 format. Also added anchor links to avoid repeating information
  • Added the 'Methods' section
  • Turned on normalizeDynamically for the demo example, to insure it will not be too dark.

Regarding that last one, the only reason why I don't want to change it to the COLOR colormap is because we decided that grayscale would be the default colormap in ml5js/ml5-next-gen#248 (comment). The thinking was that it is easier to understand how depth is mapped from black to white. Understanding that same idea with color mapping is harder for beginners.

So I think the happy medium is to turn on normalizeDynamically. This makes it so the depthmap colors are mapped from the far and close values detected, not by preset static values. Therefore there'll always be a brighter area.

@nasif-co nasif-co requested a review from AidanNelson October 8, 2025 18:57
@MOQN
Copy link
Member

MOQN commented Oct 9, 2025

This is fantastic!! 🤩 Thank you for incorporating the feedback so promptly! Merging it now :D

@MOQN MOQN merged commit 0eafb23 into main Oct 9, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants