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-2558: Update how service models are displayed #3048

Merged
merged 2 commits into from
Jun 20, 2024

Conversation

npentrel
Copy link
Collaborator

No description provided.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jun 20, 2024
@viambot
Copy link
Member

viambot commented Jun 20, 2024

Overall readability score: 53.06 (🔴 -0.01)

File Readability
_index.md 55.97 (🟢 +0)
_index.md 19.72 (🟢 +0.62)
_index.md 58.58 (🔴 -2.64)
performance-metrics.md 52.98 (🟢 +0)
cloud-sync.md 55.15 (🟢 +0)
dataset.md 74.8 (🟢 +0)
export.md 57.29 (🟢 +0)
query.md 56.67 (🟢 +0)
trigger-sync.md 66.29 (🟢 +0)
upload.md 67.67 (🟢 +0)
view.md 63.38 (🟢 +0)
visualize.md 54.43 (🟢 +0)
_index.md 51.5 (🟢 +0)
frame-config.md 61.94 (🟢 +0)
nested-frame-config.md 63.34 (🟢 +0)
_index.md 46.71 (🔴 -4.15)
fake.md 60.56 (🟢 +0)
_index.md 51.21 (🔴 -2.95)
tflite_cpu.md 59.57 (🟢 +0)
edit.md 79.72 (🟢 +0)
train-model.md 65.17 (🟢 +0)
upload-model.md 72.55 (🔴 -0.22)
_index.md 59.81 (🟢 +0)
algorithms.md 54.46 (🟢 +0)
constraints.md 52.25 (🟢 +0)
_index.md 63.95 (🟢 +0)
_index.md 59.73 (🟢 +0.19)
color_detector.md 58.47 (🟢 +0)
detector_3d_segmenter.md 68.92 (🟢 +0)
mlmodel.md 55.13 (🟢 +0)
obstacles_depth.md 54.48 (🟢 +0)
obstacles_distance.md 46.05 (🟢 +0)
obstacles_pointcloud.md 54.48 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 55.97 44.95 9.99 14.1 12.58 7.09
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
_index.md 19.72 15.75 15.85 22 16.14 8.61
  🟢 +0.62 🟢 +1.22 🟢 +0.45 🟢 +0 🔴 -0.23 🔴 -0.01
_index.md 58.58 42.11 10.59 13.5 11.31 6.64
  🔴 -2.64 🔴 -8.66 🔴 -0.14 🔴 -0.4 🔴 -0.23 🔴 -0.02
performance-metrics.md 52.98 45.66 10.71 13.3 13.05 7.83
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
cloud-sync.md 55.15 48.74 11.93 14 11.49 7.03
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
dataset.md 74.8 59.33 9.47 10.2 8.07 5.99
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
export.md 57.29 45.25 10.91 11.2 10.84 8.28
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
query.md 56.67 42 10.44 14.3 12.24 6.54
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
trigger-sync.md 66.29 60.75 10.46 11.6 10.1 6.66
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
upload.md 67.67 52.8 9.69 10.8 9.86 6.7
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
view.md 63.38 52.8 10.48 11.4 9.98 7.29
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
visualize.md 54.43 36.59 10.3 13.6 13.22 6.92
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
_index.md 51.5 41.4 11.39 15.4 13 6.78
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
frame-config.md 61.94 56.35 10.89 11.2 10.78 7.44
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
nested-frame-config.md 63.34 54.22 10.65 11.6 10.67 6.89
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
_index.md 46.71 35.47 10.81 16.2 14.33 7.33
  🔴 -4.15 🔴 -0.81 🔴 -0.38 🔴 -1.2 🔴 -0.88 🔴 -0.12
fake.md 60.56 56.45 10.78 11.5 11.3 7.57
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
_index.md 51.21 34.56 10.34 15.8 13.34 6.75
  🔴 -2.95 🔴 -8.76 🔴 -0.18 🔴 -0.4 🔴 -0.23 🔴 -0.09
tflite_cpu.md 59.57 57.2 11.78 13.4 10.33 6.95
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
edit.md 79.72 67.04 7.33 7.7 8.11 7.11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
train-model.md 65.17 51.48 9.91 11.9 10.21 6.64
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
upload-model.md 72.55 55.84 8.61 10 9.85 6.28
  🔴 -0.22 🔴 -0.11 🔴 -0.03 🟢 +0 🔴 -0.06 🔴 -0.02
_index.md 59.81 38.11 8.46 14.2 13.8 5.78
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
algorithms.md 54.46 47.38 11.13 11.7 12.7 8.11
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
constraints.md 52.25 44.44 10.35 14.9 13.81 7.13
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
_index.md 63.95 46.67 8.14 13.5 13.16 5.7
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
_index.md 59.73 38.01 8.44 14.4 13.57 5.82
  🟢 +0.19 🟢 +0.41 🟢 +0.2 🔴 -0.1 🔴 -0.17 🟢 +0.05
color_detector.md 58.47 49.75 11.36 13.5 10.44 7.04
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
detector_3d_segmenter.md 68.92 60.35 10.48 10.5 8.59 6.97
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
mlmodel.md 55.13 46.2 11.9 15.5 10.86 6.52
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
obstacles_depth.md 54.48 55.07 12.61 14.9 11.09 6.97
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
obstacles_distance.md 46.05 43.36 13.97 16.7 10.86 7.55
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
obstacles_pointcloud.md 54.48 53.34 12.84 15.2 10.39 6.93
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.06 45.72 11.13 12.59 12.11 8.32
  🔴 -0.01 🔴 -0.02 🟢 +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 merged commit e981ae6 into viamrobotics:main Jun 20, 2024
10 checks passed
@npentrel npentrel deleted the DOCS-2558 branch June 20, 2024 12:02
@viambot
Copy link
Member

viambot commented Jun 20, 2024

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

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.

2 participants