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-1681-emphasize cartographer algorithm #2595

Conversation

skyleilani
Copy link
Contributor

Emphasize that the cartographer module is providing an algorithm for generating a SLAM map and that there are other types of algorithms for generating a map using SLAM.

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

viambot commented Feb 28, 2024

Overall readability score: 55.64 (🟢 +0)

File Readability
_index.md 64.89 (🟢 +0.1)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 64.89 52.09 9.64 12.5 11.31 6.15
  🟢 +0.1 🟢 +0.1 🟢 +0.03 🟢 +0 🟢 +0 🟢 +0.01

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.64 47.57 10.63 13.22 12.08 7.6
  🟢 +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

Copy link
Member

@EshaMaharishi EshaMaharishi left a comment

Choose a reason for hiding this comment

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

Lgtm with two suggestions!

Also heads up that we actually have a project in progress to allow users to run their own slam modules in the cloud: https://docs.google.com/document/d/16rHMjP8C88eV4ilPv0nDkQ0PyDDB0aXYbUaOh_AEbU8/edit#heading=h.tcicyojyqi6c

docs/mobility/slam/cartographer/_index.md Outdated Show resolved Hide resolved
docs/mobility/slam/cartographer/_index.md Outdated Show resolved Hide resolved
@viambot
Copy link
Member

viambot commented Feb 28, 2024

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

@skyleilani skyleilani merged commit 05dc4c7 into viamrobotics:main Feb 28, 2024
8 of 9 checks passed
@skyleilani skyleilani deleted the DOCS-1681-emphasize-cartographer-algorithm branch February 28, 2024 16:55
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