Skip to content

Commit bc8fc66

Browse files
authored
feat: revamp the homepage (#755)
Signed-off-by: Mete Fatih Cırıt <mfc@autoware.org>
1 parent e372c7d commit bc8fc66

File tree

10 files changed

+51
-34
lines changed

10 files changed

+51
-34
lines changed
File renamed without changes.

docs/home/assets/images/autoware_front_image.png renamed to docs/design/autoware-concepts/images/autoware_ecosystem.png

File renamed without changes.

docs/design/autoware-concepts/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ At a high level, these interfaces come in two flavors:
4545

4646
## Core & Universe repository model
4747

48+
![Autoware Ecosystem](images/autoware_ecosystem.png)
49+
4850
Autoware’s software ecosystem is organized into two layers: **Autoware Core** and **Autoware Universe**.
4951
Together, they balance **quality assurance** with **community-driven innovation**.
5052

docs/home/index.md

Lines changed: 46 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,64 @@
11
# Autoware Documentation
22

3-
Welcome to the Autoware Documentation! Here, you'll find comprehensive information about Autoware, the forefront of open-source autonomous driving software.
3+
**Autoware** is the world's leading open-source autonomous driving framework. Autoware provides a comprehensive, production-ready software stack designed to accelerate the **commercial deployment** of autonomous vehicles across diverse platforms and use cases.
44

5-
![autoware_front_image](assets/images/autoware_front_image.png)
5+
<div style="text-align: center;">
6+
<iframe
7+
width="800"
8+
height="450"
9+
src="https://www.youtube.com/embed/7XP5Pq11Yi8?si=je1235R4ZFayw7cj&controls=0&autoplay=1&mute=1&loop=1&playlist=7XP5Pq11Yi8"
10+
title="YouTube video player"
11+
frameborder="0"
12+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
13+
referrerpolicy="strict-origin-when-cross-origin"
14+
allowfullscreen>
15+
</iframe>
16+
</div>
617

7-
## About Autoware
18+
---
819

9-
Autoware is the world’s leading open-source project dedicated to autonomous driving technology. Built on the Robot Operating System ([ROS 2](https://docs.ros.org/en/foxy/index.html)), Autoware facilitates the commercial deployment of autonomous vehicles across various platforms and applications. Discover more about our innovative project at the [Autoware Foundation website](https://autoware.org/autoware-overview).
20+
<div style="text-align: center;" markdown="1">
1021

11-
## Getting started
22+
[:fa-cl-s fa-circle-down: Install Autoware](../installation/index.md){ .md-button style="margin: 5px" }
23+
[:fa-cl-s fa-gamepad: Quick Start Demos](../demos/index.md){ .md-button style="margin: 5px" }
24+
[:fa-cl-s fa-book: Tutorials](../tutorials/index.md){ .md-button style="margin: 5px" }
25+
[:fa-cl-s fa-compass-drafting: Architecture Design](../design/index.md){ .md-button style="margin: 5px" }
26+
[:fa-cl-s fa-circle-question: Support](../community/support/index.md){ .md-button style="margin: 5px" }
27+
[:fa-cl-s fa-circle-plus: Contribute](../contributing/index.md){ .md-button style="margin: 5px" }
1228

13-
### Step into the World of Autoware
29+
</div>
1430

15-
**Discover the Concept**: Start your Autoware journey by exploring the [Concept](../design/autoware-concepts/index.md) pages. Here, you'll delve into the core ideas behind Autoware, understand its unique features and how it stands out in the field of autonomous driving technology. Learn about the principles guiding its development and the innovative solutions it offers.
31+
---
1632

17-
### Set Up Your Environment
33+
<div style="text-align: center;" markdown="1">
1834

19-
**Install Autoware**: Once you have a grasp of the Autoware philosophy, it's time to bring it into your world. Visit our [Installation](../installation/index.md) section for detailed, step-by-step instructions to seamlessly install Autoware and related tools in your environment. Whether you're a beginner or an expert, these pages are designed to guide you through a smooth setup process.
35+
[:fa-cl-s fa-gem: Autoware Core Documentation](https://autowarefoundation.github.io/autoware_core/main/){ .md-button style="margin: 5px" }
36+
[:fa-cl-s fa-star: Autoware Universe Documentation](https://autowarefoundation.github.io/autoware_universe/main/){ .md-button style="margin: 5px" }
37+
[:fa-cl-s fa-screwdriver-wrench: Autoware Tools Documentation](https://autowarefoundation.github.io/autoware_tools/main/){ .md-button style="margin: 5px" }
38+
[:fa-cl-s fa-house: Autoware Main Site](https://autoware.org/autoware-overview){ .md-button style="margin: 5px" }
2039

21-
### Dive Deeper
40+
</div>
2241

23-
**Hands-on Experience**: After installation, head over to the [Demos](../demos/index.md) pages. These tutorials are designed to provide you with hands-on experience with some simulations, allowing you to apply what you've learned and gain practical skills. From basic operations to advanced applications, these tutorials cover a wide range of topics to enhance your understanding of Autoware.
42+
---
2443

25-
**Advanced Topics**: As you become more familiar with Autoware, the [Tutorials](../tutorials/index.md) will be your next destination. These pages delve into more advanced topics, offering deeper insights and more complex scenarios. They're perfect for those looking to expand their knowledge and expertise in specific areas of Autoware. Additionally, this section also covers methods for integrating Autoware with real vehicles, providing practical guidance for those seeking to apply Autoware in real-world settings.
44+
## Capabilities
2645

27-
### Understand the Design
46+
Autoware handles the full autonomous driving stack, from sensing to control.
2847

29-
**Design Concepts**: For those interested in the architecture and design philosophy of Autoware, the [Design](../design/index.md) pages are a treasure trove. Learn about the architectural decisions, design patterns, and the rationale behind the development of Autoware's various components.
48+
| Domain | Key Features |
49+
| :------------------- | :------------------------------------------------------------------------------------------------------------- |
50+
| **🤖 AI & Learning** | Support for **End-to-End (E2E) driving models**, ML-based perception, and data-driven trajectory prediction. |
51+
| **👁️ Perception** | **Multi-Sensor Fusion** (Lidar, Camera, Radar), Traffic Light Recognition, and dynamic object tracking. |
52+
| **📍 Localization** | High-precision **NDT matching** combined with GNSS/IMU odometry for robust positioning in mapped environments. |
53+
| **🧠 Planning** | **Behavior Planning** for intersections and lane changes, plus real-time **Dynamic Obstacle Avoidance**. |
54+
| **🚗 Control** | Precise **Trajectory Following** and standardized vehicle interfaces for drive-by-wire platforms. |
55+
| **🎮 Simulation** | **Digital Twin Simulation** (AWSIM), Rosbag Replay, and Scenario Simulation for validation. |
3056

31-
### More Information
57+
## Validated Use Cases
3258

33-
**Datasets**: The [Datasets](../datasets/index.md) pages are a crucial resource for anyone working with Autoware. Here, you'll find a collection of datasets that are compatible with Autoware, providing real-world scenarios and data to test and refine your autonomous driving solutions.
59+
Autoware is designed to be platform-agnostic, powering applications such as
3460

35-
**Support**: As you dive deeper into Autoware, you might encounter challenges or have questions. The [Support](../community/support/index.md) section is designed to assist you in these moments. This area includes FAQs, community forums, and contact information for getting help with Autoware. It's also a great place to connect with other Autoware users and contributors, sharing experiences and solutions.
36-
37-
**Competitions**: The [Competitions](../community/autoware-competitions/index.md) pages are where excitement meets innovation. Autoware regularly hosts or participates in various competitions and challenges, providing a platform for users to test their skills, showcase their work, and contribute to the community. These competitions range from local to global scale, offering opportunities for both beginners and experts to engage and excel. Stay updated with upcoming events and take part in the advancement of autonomous driving technologies.
38-
39-
### Contribute and Collaborate
40-
41-
**Become a Part of the Autoware Story**: Your journey with Autoware isn't just about learning and using; it's also about contributing and shaping the future of autonomous driving. The [Contributing](../contributing/index.md) section is more than just a guide; it's an invitation to be part of something bigger. Whether you're a coder, a writer, or an enthusiast, your contributions can propel Autoware forward. Join us, and let's build the future together.
42-
43-
## Related Documentations
44-
45-
In addition to this page, there are several related documentations to further your knowledge and understanding of Autoware:
46-
47-
- [Autoware Core Documentation](https://autowarefoundation.github.io/autoware_core/main/)
48-
- [Autoware Universe Documentation](https://autowarefoundation.github.io/autoware_universe/) contains technical documentations of each component/function such as localization, planning, etc.
49-
- [Autoware Tools Documentation](https://autowarefoundation.github.io/autoware_tools/main/) contains technical documentations of each tools for autonomous driving such as performance analysis, calibration, etc.
61+
- **Robo-Taxis** & Urban Mobility
62+
- **Cargo Delivery** & Logistics
63+
- **Robo-Bus** Shuttles
64+
- **Privately-Owned Vehicles (POV)**

docs/home/assets/images/detection_area_turnaround_time.png renamed to docs/tutorials/integrating-autoware/tuning-parameters-and-performance/evaluation/evaluating-real-time-performance/images/detection_area_turnaround_time.png

File renamed without changes.

docs/home/assets/images/ring_outlier_filter_minor_faults.png renamed to docs/tutorials/integrating-autoware/tuning-parameters-and-performance/evaluation/evaluating-real-time-performance/images/ring_outlier_filter_minor_faults.png

File renamed without changes.

docs/home/assets/images/ring_outlier_filter_turnaround_time.png renamed to docs/tutorials/integrating-autoware/tuning-parameters-and-performance/evaluation/evaluating-real-time-performance/images/ring_outlier_filter_turnaround_time.png

File renamed without changes.

docs/tutorials/integrating-autoware/tuning-parameters-and-performance/evaluation/evaluating-real-time-performance/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Refer to the [Pull Request](https://github.com/autowarefoundation/autoware_unive
118118

119119
The following figure is a time-series plot of the turnaround time of the main processing part of `ring_outlier_filter`, analyzed as described in the "Performance Measurement" section above.
120120

121-
![ring outlier filter turnaround time](https://raw.githubusercontent.com/autowarefoundation/autoware-documentation/0ad57338ca24b35f0a271c6ae003aa303b3dd4ce/docs/assets/images/ring_outlier_filter_turnaround_time.png)
121+
![ring outlier filter turnaround time](images/ring_outlier_filter_turnaround_time.png)
122122

123123
The horizontal axis indicates the number of callbacks called (i.e., callback index), and the vertical axis indicates the turnaround time.
124124

@@ -127,7 +127,7 @@ When analyzing the performance of the sensing module from the viewpoint of perfo
127127
Analysis of the performance counter shows that the largest fluctuations come from `minor-faults` (i.e., soft page faults), the second largest from `LLC-store-misses` and `LLC-load-misses` (i.e., cache misses in the last level cache), and the slowest fluctuations come from instructions (i.e., message data size fluctuations).
128128
For example, when we plot `minor-faults` on the horizontal axis and turnaround time on the vertical axis, we can see the following dominant proportional relationship.
129129

130-
![ring outlier filter minor faults](https://raw.githubusercontent.com/autowarefoundation/autoware-documentation/0ad57338ca24b35f0a271c6ae003aa303b3dd4ce/docs/assets/images/ring_outlier_filter_minor_faults.png)
130+
![ring outlier filter minor faults](images/ring_outlier_filter_minor_faults.png)
131131

132132
To achieve zero soft page faults, heap allocations must only be made from areas that have been first touched in advance.
133133
We have developed a library called [`heaphook`](https://github.com/tier4/heaphook) to avoid soft page faults while running Autoware callback.
@@ -176,7 +176,7 @@ First, we will pick up `detection_area` module in `behavior_velocity_planner` no
176176
We have followed the performance analysis steps above to obtain the following graph.
177177
Axises are the same as the graphs in the sensing case study.
178178

179-
![detection area turnaround time](https://raw.githubusercontent.com/autowarefoundation/autoware-documentation/36647431080a837a1c8a983faf5045d6524cee66/docs/assets/images/detection_area_turnaround_time.png)
179+
![detection area turnaround time](images/detection_area_turnaround_time.png)
180180

181181
Using [`pmu_analyzer`](https://github.com/sykwer/pmu_analyzer) tool to further identify the bottleneck, we have found that the following multiple loops were taking up a lot of processing time:
182182

0 commit comments

Comments
 (0)