From 9395d6bb913a712651bc4c8b2fdba44ef08a0627 Mon Sep 17 00:00:00 2001 From: Hayato Mizushima Date: Thu, 5 Sep 2024 15:59:34 +0900 Subject: [PATCH] docs: update usage flow (#554) Signed-off-by: Hayato Mizushima --- docs/overview/index.en.md | 5 ++--- docs/overview/index.ja.md | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/overview/index.en.md b/docs/overview/index.en.md index 28ae617a..1e424d02 100644 --- a/docs/overview/index.en.md +++ b/docs/overview/index.en.md @@ -38,12 +38,11 @@ The details of the node's operation are shown in the figure below. 1. Acquire rosbags for evaluation using a real-world vehicle. 2. Filter the acquired rosbags to contain only sufficient input topics in required period of time - For this purpose please use [ros2bag_extensions](https://github.com/tier4/ros2bag_extensions) package (developed by TIER IV). To properly filter the input rosbag: - - Autoware's output topics must be dropped except `/tf`. The sensor topics (input topics) should remain in the filtered rosbag. - - Rosbag needs 10 seconds of parking before driving. The other messages should be dropped. + - See docs/use_case/ documentations for which topics to leave in the filter. 3. Create an evaluation scenario 1. Example scenarios could be found in the repository's [sample folder](https://github.com/tier4/driving_log_replayer/tree/main/sample) 2. Refer to the [format definition](../result_format/index.md) section of this document for description contents. -4. If the node should test obstacle_segmentation or perception stacks, please annotate with an annotation tool that supports conversion to t4_dataset. +4. If the node should test obstacle_segmentation, perception, perception_2d, or traffic_light stacks, please annotate with an annotation tool that supports conversion to t4_dataset. 1. [Deepen.AI](https://www.deepen.ai/) is available. 2. By adding conversion functionality to [perception_dataset](https://github.com/tier4/tier4_perception_dataset), it becomes possible to use other annotation tools as well. 5. Perform the evaluation. diff --git a/docs/overview/index.ja.md b/docs/overview/index.ja.md index 1d37b10d..981a9644 100644 --- a/docs/overview/index.ja.md +++ b/docs/overview/index.ja.md @@ -38,12 +38,11 @@ Driving Log Replayer の評価ノードは、以下のように動作します 1. 評価用の rosbag を実車で取得する 2. 取得した rosbag を必要な時間、topic だけ残るようにフィルタする - フィルタ処理には TIER IV で開発した [ros2bag_extensions](https://github.com/tier4/ros2bag_extensions) を使用する - - `/tf` を除き収録時に autoware が出力したトピックを落とす。センサーのトピックだけを残す - - 自己位置合わせのために走行前に 10 秒停車している時間を残しておく + - フィルタでどのtopicを残すかは、docs/use_case/のドキュメント参照 3. シナリオを作成する 1. [sample folder](https://github.com/tier4/driving_log_replayer/tree/main/sample) 内にシナリオの例あり 2. 記述内容は[フォーマット定義](../result_format/index.md)を参照 -4. ユースケースが obstacle_segmentation, perception の場合、t4_dataset への変換に対応したアノテーションツールでアノテーションを実施する。 +4. ユースケースが obstacle_segmentation, perception, perception_2d, traffic_light の場合、t4_dataset への変換に対応したアノテーションツールでアノテーションを実施する。 1. [Deepen.AI](https://www.deepen.ai/)が利用可能 2. [perception_dataset](https://github.com/tier4/tier4_perception_dataset)に変換機能を追加すれば他のアノテーションツールも使用可能になる 5. 評価を実行する。