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

Add more info about vision service and camera to mlmodel page #2345

Merged
merged 2 commits into from
Dec 21, 2023

Conversation

sguequierre
Copy link
Collaborator

Matt Vella sent over feedback from a community user where he filmed a YouTube video and apparently spent a lot of time on this docs page not realizing he needed a vision service/that that was his "next steps". We do make it pretty clear already on that page but this is what I could think of to make it even more clear

  • Add sentence under "Used with" talking about combination of mlmodel service, mlmodel vision service, and transform camera

Matt Vella sent over feedback from a community user where he filmed a YouTube video and apparently spent a lot of time on this docs page not realizing he needed a vision service/that that was his "next steps". We do make it pretty clear already on that page but this is what I could think of to make it even more clear
@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Dec 20, 2023
@viambot
Copy link
Member

viambot commented Dec 20, 2023

Overall readability score: 56.55 (🟢 +0)

File Readability
deploy.md 59.1 (🔴 -0.7)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
deploy.md 59.1 44.14 9.72 13.9 12.01 6.56
  🔴 -0.7 🔴 -0.3 🔴 -0.22 🔴 -0.1 🟢 +0 🔴 -0.04

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.55 48.53 10.5 12.92 11.91 7.65
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

docs/ml/deploy.md Outdated Show resolved Hide resolved
Co-authored-by: Naomi Pentrel <[email protected]>
@viambot
Copy link
Member

viambot commented Dec 21, 2023

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2345

@sguequierre sguequierre merged commit a42c19c into main Dec 21, 2023
12 checks passed
@sguequierre sguequierre deleted the sguequierre-patch-2 branch December 21, 2023 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants