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: setup glossary #33298

Closed
wants to merge 10,000 commits into from
Closed

Conversation

JoeFyhrCeesay
Copy link

Closes #33117

  • Terms can be defined in docs/glossary.toml with category headers, abbreviations, and descriptions. I added the openpilot terms, driver-assistance terms, and automotive terms from the wiki page. Let me know if you would like me to add or remove any.
  • A glossary page is aromatically built based on docs/glossary.toml and tooltips are added for the (exact but case insensitive) terms on all other pages (i.e. "(Automatic) Lane Centering" won't show a tooltip for "Lane Centering", but will show one for "(automatic) lane centering", let me know if you want that to be changed).
  • Abbreviations are only displayed on the glossary page and do not affect tooltips.

Glossary page screenshot:
commaai-glossary

Tooltip screenshot:
commaai-tooltip

jyoung8607 and others added 30 commits July 10, 2024 15:10
…aai#32949)

* improved PlotJuggler layout for lat accel controller

* help estimate steerActuatorDelay

* update Actuator Performance, add Vehicle Dynamics

* disable Y limits on actuator performance because sunny

* apply delay estimation feedback from harald

* gc extra custom series that PJ copied in

* label wordsmithing
* lat active/steer override: check up to now

* lint

* Update ref_commit
* check on either edge

* clean up

* clean up

* good thing I tested this first :P
* initial setup.sh for curl|bash

* --single-branch for faster pull and some final instructions

* fix git lfs pull
Rewrite git history final touches
* Replace ui.py with rerun

* Visualizing radarpoints

* Visualizing all points

* Code clean-up

* Merging matrices into one

* Removing pygame depndency

* Replacing ui.py with rp_visualization.py

* Minor fix, changing color names

* Update README.md
…2983)

update submodules that used numpy-stubs in pre-commit config
* Update Python packages and pre-commit hooks

* fix ruff

---------

Co-authored-by: Vehicle Researcher <[email protected]>
Co-authored-by: Maxime Desroches <[email protected]>
* lint import

* Update selfdrive/car/__init__.py

---------

Co-authored-by: Shane Smiskol <[email protected]>
)

Revert "selfdrive/car: ban imports from external modules (commaai#32973)"

This reverts commit 83d4623.
…2993) (commaai#32994)

* Reapply "selfdrive/car: ban imports from external modules" (commaai#32993)

This reverts commit 35a4a77.

* controls will just use controls

* also these

* ignore
bump submodules

Co-authored-by: Vehicle Researcher <[email protected]>
… speed (commaai#32992)

* use rounded constant instead of hard-coded value for incrementing set speed

* better comment
* add livepose

* Formatting

* Add to sevices

* Update locationd to publish livePose

* Remove fields and increase decimation

* Fix field indices

* Remove the line

* Add livePose to pubmaster

* Fix llk decimation

* Update ref commit

* XYZ measurements instead of lists

* Update locationd

* Update ref commit

* Lower the qlog size in test_onroad

* Update lower and upper boundary

---------

Co-authored-by: Kacper Rączy <[email protected]>
reduce cameraOdometry decimation
change longitudinalPlan decimation
* decimate option

* clean up

* check exists
* tici: reset panda boot0

* ooops
sshane and others added 11 commits August 13, 2024 21:16
* remove some defs

* now carstate

* remove carControl from CI update function

* almost merged that

* and that
* formatting

* fix these

* not these
* move mazda button events to carstate

* do  more

* remove

* some more

* clean up
* mock carstate inside card

* not used
* use CP

* no car control, consistent _update function signatures

* eh it's fine to name it whatever

* clean up

* oops

* !!

* now we can delete this!

* nobody does anymore
Copy link
Contributor

github-actions bot commented Aug 14, 2024

Thanks for contributing to openpilot! In order for us to review your PR as quickly as possible, check the following:

  • Convert your PR to a draft unless it's ready to review
  • Read the contributing docs
  • Before marking as "ready for review", ensure:
    • the goal is clearly stated in the description
    • all the tests are passing
    • the change is something we merge
    • include a route or your device' dongle ID if relevant

@JoeFyhrCeesay JoeFyhrCeesay marked this pull request as draft August 14, 2024 21:04
@JoeFyhrCeesay JoeFyhrCeesay marked this pull request as ready for review August 15, 2024 14:49
Copy link
Contributor

This PR has had no activity for 9 days. It will be automatically closed in 2 days if there is no activity.

@github-actions github-actions bot added the stale label Aug 25, 2024
"big model".description = "A new paradigm in model development that takes a bigger input frame. Full frame is 1164x874, little model is a 512x256 crop, big model is a 1024x512 crop, 4x bigger than little. Make box bigger, drive better. Useful for signs and lights."

"Driving Model".abbreviation = "model"
"Driving Model".description = "The resulting neural network after Comma trains on driving data on their supercomputer. This file lives on the device, and processes inputs to give outputs relevant to driving. Usually takes the form of an ONNX file, or a THNEED file after compilation on device. This file does not change or get trained on device, only processes inputs and outputs. See [the list of driving models](https://github.com/commaai/openpilot/wiki/Driving-Models) for names and details of models over time."
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally we don't want to define terms like "Driving Model" multiple times. A map like this would be better

"openpilot terms" = [
  {term = "Driving Model", abbreviation = "model", description = "..."},
  {term = "End to end", abbreviation = "e2e", description = "..."}
]

"driver-assistance terms" = [
  {term = "Adaptive Cruise Control", abbreviation = "ACC", description = "..."}
]

@@ -0,0 +1,30 @@
[data-tooltip] {
Copy link
Contributor

Choose a reason for hiding this comment

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

Would be nice if you could copy/highlight the content of the tooltip

@maxime-desroches
Copy link
Contributor

This PR was closed because of a git history rewrite.
Please read #33399 for what to do with your fork and your PRs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: setup glossary