Skip to content

Conversation

andf-viam
Copy link
Contributor

Add notice that Python SDK users must now also install the mlmodel extra alongside the Python SDK in order to use the ML Model service.

  • Notice to central Program and ML Model service reference pages
  • Inclusion on tutorials that present Python code, and use the ML Model service (though none used the deprecated
    input_data or output_data nomenclature). Guess: no changes needed to these tutorials, besides additional dep install step now documentation.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Oct 30, 2023
@viambot
Copy link
Member

viambot commented Oct 30, 2023

Overall readability score: 56.2 (🟢 +0.01)

File Readability
_index.md 30.05 (🟢 +0.45)
python-venv.md 70.07 (🟢 +0.28)
_index.md 58.53 (🟢 +2.79)
guardian.md 72.53 (🔴 -0.07)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 30.05 32.57 15.37 20.5 13.53 8.34
  🟢 +0.45 🟢 +0.31 🟢 +0.14 🟢 +0.1 🔴 -0.06 🟢 +0.03
python-venv.md 70.07 49.21 8.01 9.8 11.13 6.56
  🟢 +0.28 🔴 -0.61 🔴 -0.05 🟢 +0 🔴 -0.01 🟢 +0.15
_index.md 58.53 49.04 11.21 13.6 10.21 7.12
  🟢 +2.79 🟢 +0.91 🟢 +0.5 🟢 +0.7 🟢 +0.36 🟢 +0.08
guardian.md 72.53 60.95 9.39 10.7 9.34 6.04
  🔴 -0.07 🟢 +0 🔴 -0.02 🟢 +0 🟢 +0 🔴 -0.01

Averages:

  Readability FRE GF ARI CLI DCRS
Average 56.2 47.78 10.54 12.9 11.95 7.69
  🟢 +0.01 🟢 +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

@andf-viam andf-viam requested a review from njooma October 30, 2023 20:52
Copy link
Member

@njooma njooma left a comment

Choose a reason for hiding this comment

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

Looks good! A few comments on how the instructions might be redundant, but they will work!

Comment on lines 155 to 156
pip install viam-sdk
pip install 'viam-sdk[mlmodel]'
Copy link
Member

Choose a reason for hiding this comment

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

installing viam-sdk[mlmodel] includes the base viam-sdk itself, so you don't need both commands here

Comment on lines 432 to 433
pip3 install viam-sdk python-vlc
pip3 install 'viam-sdk[mlmodel]'
Copy link
Member

Choose a reason for hiding this comment

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

Same as above, viam-sdk[mlmodel] includes the base SDK

@viambot
Copy link
Member

viambot commented Oct 31, 2023

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

@andf-viam andf-viam merged commit 3ea91bb into viamrobotics:main Oct 31, 2023
@andf-viam andf-viam deleted the DOCS-1105-mlmodel-pysdk-numpy-dep branch October 31, 2023 14:29
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.

4 participants