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

Jump to bottom

docs: add perception design #385

Merged
merged 64 commits into from
Nov 24, 2023
Merged

docs: add perception design #385

merged 64 commits into from
Nov 24, 2023

Conversation

miursh
Copy link
Contributor

@miursh miursh commented May 31, 2023 •
edited
Loading

Description

  • This PR contains following three documents.
    • Perception component design
    • Perception component Reference Implementation Design
    • Perception Interface Design
  • These documents are written for sharing the design philosophy with engineers who want to contribute to Perception Component in autoware.

Pre-review checklist for the PR author

The PR author must check the checkboxes below when creating the PR.

In-review checklist for the PR reviewers

The Reviewers must check the checkboxes below before approval.

Post-review checklist for the PR author

The PR author must check the checkboxes below before merging.

  • There are no open discussions or they are tracked via tickets.

After all checkboxes are checked, anyone who has write access can merge the PR.

Shin-kyoto added 30 commits May 20, 2023 20:22
@Shin-kyoto
docs(design): add titles of chapers
f5c33bc 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): update figures in perception document
9bc524f 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): modify path of figure
dd0b1e6 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): modify path of figure
42310ac 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): add goals and non-goals
6c1bc29 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): add important parameters figure
42ae5c6 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): add input and output
85bdad6 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): update description
f045ee2 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): add requirements
0d08827 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): add parameters
851fc62 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): add parameter description
e402808 
Signed-off-by: Shin-kyoto <[email protected]>
@Shin-kyoto
docs(design): Translate overview into English.
d92df9c
@Shin-kyoto
docs(design): Translate requirements into English.
445cf89
@Shin-kyoto
docs(design): Modify expression.
ee63eb0
@Shin-kyoto
docs(design): add goals about basic function.
f5e174b
@Shin-kyoto
docs(design): Translate goal into English.
6f6cc1c
@Shin-kyoto
docs(design): Translate exlanation of Object Recognition into English.
9739644
@Shin-kyoto
docs(design): Translate exlanation of Dynamic Objects into English.
0596db9
@Shin-kyoto
docs(design): Update description of Object Recognition.
4f7e04a
@Shin-kyoto
docs(design): Update description of obstacle segmentation and occupan…
74e4620 
…cy grid map.
@Shin-kyoto
docs(design): Update description of internal interface.
3ab8a8d
@Shin-kyoto
docs(design): Update internal interface.
d80c9bb
@Shin-kyoto
docs(design): Update description of Traffic Light Recognition.
4f374be
@Shin-kyoto
docs(design): Update description of goals.
2e8dafe
@Shin-kyoto
docs(design): Update description of input from map component.
0f29846
@Shin-kyoto
docs(design): Update description of output to planning.
ec58ac4
@Shin-kyoto
docs(design): Update description of input from camera.
8a226f7
@Shin-kyoto
docs(design): Update description of input from camera sensor data.
d7ace97
@Shin-kyoto
docs(design): Update description of input.
80ff086
@Shin-kyoto
docs(design): Update description of Point Cloud input.
ec818ae
@Shin-kyoto Shin-kyoto marked this pull request as ready for review November 20, 2023 07:06
@Shin-kyoto Shin-kyoto requested a review from kminoda November 20, 2023 07:06
Shin-kyoto and others added 2 commits November 20, 2023 18:14
kminoda
kminoda reviewed Nov 21, 2023
View reviewed changes
Copy link
Contributor

@kminoda kminoda left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thank you for the documentation! Super helpful 👏

docs/design/autoware-architecture/perception/index.md Outdated Show resolved Hide resolved
docs/design/autoware-architecture/perception/index.md Outdated Show resolved Hide resolved
docs/design/autoware-architecture/perception/index.md Outdated Show resolved Hide resolved
docs/design/autoware-architecture/perception/index.md Outdated Show resolved Hide resolved
docs/design/autoware-architecture/perception/index.md Outdated Show resolved Hide resolved
docs/design/autoware-architecture/perception/reference_implementation.md Outdated Show resolved Hide resolved
@Shin-kyoto Shin-kyoto requested a review from kminoda November 21, 2023 06:38
kminoda
kminoda approved these changes Nov 21, 2023
View reviewed changes
Copy link
Contributor

@kminoda kminoda left a comment

Choose a reason for hiding this comment

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

LGTM

miursh
miursh commented Nov 21, 2023
View reviewed changes
Copy link
Contributor Author

@miursh miursh left a comment •
edited
Loading

Choose a reason for hiding this comment

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

@Shin-kyoto
Thank you so much for your work!
I have a few change requests/comments.

docs/design/autoware-interfaces/components/perception.md Outdated Show resolved Hide resolved
docs/design/autoware-architecture/perception/index.md Outdated Show resolved Hide resolved
docs/design/autoware-architecture/perception/reference_implementation.md Outdated Show resolved Hide resolved
docs/design/autoware-architecture/perception/index.md Outdated Show resolved Hide resolved
docs/design/autoware-architecture/perception/index.md Outdated Show resolved Hide resolved
docs/design/autoware-architecture/perception/index.md Outdated Show resolved Hide resolved
Shin-kyoto and others added 8 commits November 22, 2023 14:40
@miursh
Copy link
Contributor Author

miursh commented Nov 22, 2023

@mitsudome-r @xmfcx
I had left this document in draft for a while, but it has now been updated by my team, and the review process is complete.
I believe it's fine to be merged, but do you have any concerns?

mitsudome-r
mitsudome-r approved these changes Nov 24, 2023
View reviewed changes
Copy link
Member

@mitsudome-r mitsudome-r left a comment

Choose a reason for hiding this comment

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

LGTM

@mitsudome-r mitsudome-r merged commit f508499 into autowarefoundation:main Nov 24, 2023
11 checks passed
@tier4-autoware-public-bot tier4-autoware-public-bot bot mentioned this pull request Nov 25, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Shin-kyoto Shin-kyoto Shin-kyoto left review comments

@kminoda kminoda kminoda approved these changes

@mitsudome-r mitsudome-r mitsudome-r approved these changes

Assignees

@miursh miursh

Labels
tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) type:documentation Creating or refining documentation.
Projects
No open projects
Sensing & Perception Working Group
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@miursh @mitsudome-r @kminoda @Shin-kyoto @xmfcx