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

[vpdq] Add data flow diagram, misc docs cleanup #1700

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ianwal
Copy link
Contributor

@ianwal ianwal commented Nov 29, 2024

Summary

I was looking at vPDQ again and noticed the initial docs has a lot of words and can be hard to understand.

Tabulating (?) the TMK comparison and adding a simple high level diagram of how vPDQ works can help new readers understand the project better.

  • Add simple high level mermaid diagram for vPDQ data flow.
  • Put TMK+PDQF / vPDQ comparison in table form for readability
  • Other misc cleanup
    • All changes maintain the same amount of info but in a different format that may be easier for new users to understand.

Consideration: mermaid can also be exported to svg, so instead of a codeblock I could add a svg file to avoid readers needing a mermaid renderer. Probably will still need to put the mermaid code somewhere since I think mermaid -> svg is a one way conversion.

Test Plan

Mermaid renders as expected in github:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants