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

DOCS-2056: Add vision service control panel #2863

Merged
merged 2 commits into from
Jul 10, 2024

Conversation

npentrel
Copy link
Collaborator

@npentrel npentrel commented May 1, 2024

No description provided.

@npentrel npentrel marked this pull request as draft May 1, 2024 21:18
@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label May 1, 2024
@viambot
Copy link
Member

viambot commented May 1, 2024

Overall readability score: 55.14 (🟢 +0)

File Readability
mlmodel.md 56.99 (🟢 +1.92)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
mlmodel.md 56.99 46.71 11.58 15 10.62 6.47
  🟢 +1.92 🟢 +0.81 🟢 +0.3 🟢 +0.7 🟢 +0.18 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.14 47.4 10.83 13.28 12.07 7.62
  🟢 +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

@npentrel npentrel marked this pull request as ready for review July 10, 2024 13:59
@viambot
Copy link
Member

viambot commented Jul 10, 2024

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


![Blue boxes detected](/services/vision/detections.png)

{{% expand "Click to see how to configure a camera live feed that shows detections or classifications" %}}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question-- do you know if this is getting phased out and if so might it be best to just recommend vision control card and explain more about refreshing to fetch detections?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not getting phased out. It's just no longer the only way to see the detections in the UI. Once the test card has classifications we could remove this though

@npentrel npentrel merged commit 6b0f00d into viamrobotics:main Jul 10, 2024
8 checks passed
@npentrel npentrel deleted the DOCS-2056 branch July 29, 2024 12:16
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