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.

Sign up for GitHub

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: glossary terms #34232

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: glossary terms #34232

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bddd6c
docs: glossary terms
LouisVelez Dec 14, 2024
8275b2b
code review fixes
LouisVelez Dec 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions docs/glossary.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
[glossary]

[glossary.openpilot_terms]
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.", abbreviation = "" }
driving_model = { description = "<a href='https://github.com/commaai/openpilot/wiki/Driving-Models' target='_blank'>Driving Models</a>.", abbreviation = "model" }
end_to_end = { description = "End to end means the model reacts like a human would. It assesses the whole picture and acts accordingly. Unlike other approaches where things must be labeled by hand, end to end learns all the nuances of driving. A model is basically trained on what human drivers would do in a certain situation and attempts to reproduce that behavior.", abbreviation = "e2e" }
longitudinal = { description = "Refers to gas and brake control.", abbreviation = "long" }
lateral = { description = "Refers to steering control.", abbreviation = "lat" }
model_predictive_control = { description = "An advanced method of process control that is used to control a process while satisfying a set of constraints. Used for longitudinal and lateral control.", abbreviation = "mpc" }
lead = { description = "Selected radar point from your car's radar by the driving model of openpilot using the camera. Used for longitudinal MPC. Usual attributes: distance, speed, and acceleration.", abbreviation = "" }
onroad = { description = "openpilot's system state while ignition is on.", abbreviation = "" }
offroad = { description = "openpilot's system state while ignition is off.", abbreviation = "" }
route = { description = "A route is a recording of an onroad session.", abbreviation = "" }
segment = { description = "Routes are split into one minute chunks called segments.", abbreviation = "" }
comma_connect = { description = "The web viewer for all your routes; check it out at <a href='https://connect.comma.ai' target='_blank'>connect.comma.ai</a>", abbreviation = "" }
panda = { description = "This is the secondary processor on the device that implements the functional safety and directly talks to the car over CAN. See the <a href='https://github.com/commaai/panda' target='_blank'>panda repo</a>.", abbreviation = "" }
comma_3x = { description = "The latest hardware by comma.ai for running openpilot. More info at <a href='https://comma.ai/shop' target='_blank'>comma.ai/shop</a>.", abbreviation = "" }

[glossary.driver_assistance_terms]
adaptive_cruise_control = { description = "<a href='https://en.wikipedia.org/wiki/Adaptive_cruise_control' target='_blank'>Adaptive cruise control</a>", abbreviation = "ACC" }
advanced_driver_assistance_systems = { description = "<a href='https://en.wikipedia.org/wiki/Advanced_driver_assistance_systems' target='_blank'>Advanced driver-assistance systems</a>", abbreviation = "ADAS" }
forward_collision_warning = { description = "<a href='https://en.wikipedia.org/wiki/Collision_avoidance_system#Forward_collision_warning' target='_blank'>Forward Collision Warning</a>", abbreviation = "FCW" }
lane_departure_warning = { description = "<a href='https://en.wikipedia.org/wiki/Lane_departure_warning_system' target='_blank'>Lane Departure Warning</a>", abbreviation = "LDW" }
lane_centering = { description = "<a href='https://en.wikipedia.org/wiki/Lane_centering' target='_blank'>Lane centering</a>", abbreviation = "(A)LC" }
collision_avoidance_system = { description = "<a href='https://en.wikipedia.org/wiki/Collision_avoidance_system' target='_blank'>Collision avoidance system</a>", abbreviation = "AEB, CMS, FCW(S), FCA, PCS" }
driver_monitoring_system = { description = "<a href='https://en.wikipedia.org/wiki/Driver_drowsiness_detection' target='_blank'>Driver monitoring system</a>", abbreviation = "DM(S), DAM" }
dynamic_range_cruise_control = { description = "A cruise control system that automatically adjusts the vehicle speed to maintain a safe distance from vehicles ahead.", abbreviation = "DRCC" }
hugging = { description = "An undesired behavior where the vehicle drives too closely to one side of the lane.", abbreviation = "" }
lane_keep_assist_system = { description = "<a href='https://en.wikipedia.org/wiki/Lane_keeping_assist' target='_blank'>Lane keep assist</a>", abbreviation = "LKA(S)" }
lane_departure_warning_system = { description = "<a href='https://en.wikipedia.org/wiki/Lane_departure_warning_system' target='_blank'>Lane departure warning</a>", abbreviation = "LDW(S), LDA" }
pedestrian_crash_avoidance_mitigation = { description = "A system that uses computer and artificial intelligence technology to recognize pedestrians and bicycles in an automobile's path to take action for safety.", abbreviation = "PCAM" }
ping_pong = { description = "An undesired behavior where the vehicle sways from one side of the lane to the other repeatedly. The desired behavior is to stay in the center of the lane.", abbreviation = "" }
wobble = { description = "Similar to ping pong, but where the vehicle drives mostly centered in the lane but sways slightly from side to side. Primarily due to improper tuning of the steering control system, influence from wind, or poor lane/path perception due to rain, dirt, and/or debris on the vehicles windshield.", abbreviation = "" }
traffic_sign_recognition = { description = "<a href='https://en.wikipedia.org/wiki/Traffic_sign_recognition' target='_blank'>Traffic sign recognition</a>", abbreviation = "TSR" }
stop_and_go = { description = "The ability for the car to be brought to a standstill and then resume driving without needing to disengage or reengage openpilot.", abbreviation = "SnG" }
vision_only_adaptive_cruise_control = { description = "The exclusive use of cameras instead of radar to provide adaptive cruise control functions.", abbreviation = "VOACC" }

[glossary.automotive_terms]
controller_area_network = { description = "<a href='https://en.wikipedia.org/wiki/CAN_bus' target='_blank'>Controller Area Network</a>", abbreviation = "CAN, CAN bus" }
can_fd = { description = "<a href='https://en.wikipedia.org/wiki/CAN_FD' target='_blank'>CAN FD</a>", abbreviation = "" }
electronic_control_unit = { description = "<a href='https://en.wikipedia.org/wiki/Electronic_control_unit' target='_blank'>Electronic Control Unit</a>", abbreviation = "ECU" }
electric_power_steering = { description = "<a href='https://en.wikipedia.org/wiki/Power_steering#Electric_power_steering' target='_blank'>Electric power steering</a>", abbreviation = "EPS" }
onboard_diagnostics_connector = { description = "<a href='https://en.wikipedia.org/wiki/On-board_diagnostics' target='_blank'>Onboard diagnostics</a>", abbreviation = "OBD-II, OBD-II port" }
full_self_driving = { description = "<a href='https://en.wikipedia.org/wiki/Self-driving_car' target='_blank'>Full self-driving</a>", abbreviation = "FSD" }
Loading