docs: update (#283)

tier4 · Oct 19, 2023 · 5e081ba · 5e081ba
1 parent 126f628
commit 5e081ba
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 10 deletions.
diff --git a/docs/quick_start/localization.en.md b/docs/quick_start/localization.en.md
@@ -1,4 +1,4 @@
-# Localization Evaluation
+# NDT Localization Evaluation
 
 ## Preparation
 

diff --git a/docs/quick_start/localization.ja.md b/docs/quick_start/localization.ja.md
@@ -1,4 +1,4 @@
-# 自己位置推定機能の評価
+# NDT自己位置推定機能の評価
 
 ## 準備
 

diff --git a/docs/scenario_format/index.en.md b/docs/scenario_format/index.en.md
@@ -53,6 +53,7 @@ ScenarioName: String
 ScenarioDescription: String
 SensorModel: String
 VehicleModel: String
+PerceptionMode: String
 Evaluation:
   UseCaseName: String
   UseCaseFormatVersion: String
@@ -68,7 +69,7 @@ Evaluation:
 Describe the version information of the scenario format. Use the semantic version.
 
 `localization`, `performance_diag`, `yabloc`, `eagleye` and `ar_tag_based_localizer` scenarios use the 2.x.x series. The latest version of 2.x.x is 2.2.0.
-`perception` and `obstacle_segmentation` scenarios use 3.x.x series. The latest version of 3.x.x is 3.0.0
+`perception` and `obstacle_segmentation` scenarios use 3.x.x series. The latest version of 3.x.x is 3.1 .0
 
 Minor versions are updated each time the format is updated.
 
@@ -94,6 +95,10 @@ Specify `vehicle_id` as an argument in `autoware_launch/launch/logging_simulator
 
 If you don't know `vehicle_id`, set `default`.
 
+### PerceptionMode
+
+Specify the `perception_mode` in `autoware_launch/launch/autoware.launch.xml`.
+
 ### LocalMapPath
 
 Describes the path of the map folder to be used in the local environment.

diff --git a/docs/scenario_format/index.ja.md b/docs/scenario_format/index.ja.md
@@ -53,6 +53,7 @@ ScenarioName: String
 ScenarioDescription: String
 SensorModel: String
 VehicleModel: String
+PerceptionMode: String
 Evaluation:
   UseCaseName: String
   UseCaseFormatVersion: String
@@ -68,7 +69,7 @@ Evaluation:
 シナリオフォーマットのバージョン情報を記述する。セマンティックバージョンを用いる。
 
 `localization` と `performance_diag` と `yabloc` と `eagleye` と `ar_tag_based_localizer` は 2.x.x 系を使用する。2.x.x の最新バージョンは 2.2.0
-`perception` と `obstacle_segmentation` は 3.x.x 系を使用する。3.x.x の最新バージョンは 3.0.0
+`perception` と `obstacle_segmentation` は 3.x.x 系を使用する。3.x.x の最新バージョンは 3.1.0
 
 フォーマットの更新の度にマイナーバージョンを更新する。
 
@@ -94,6 +95,10 @@ autoware_launch/launch/logging_simulator.launch.xml の引数の vehicle_id を
 
 車両 ID が不明な場合は、`default` を設定する。
 
+### PerceptionMode
+
+autoware_launch/launch/autoware.launch.xml の perception_mode を指定する。
+
 ### LocalMapPath
 
 ローカル環境で使用する地図のフォルダのパスを記述する。

diff --git a/docs/use_case/localization.en.md b/docs/use_case/localization.en.md
@@ -1,8 +1,8 @@
-# Evaluate self-localization estimation (NDT)
+# Evaluate NDT estimation
 
 Evaluate whether Autoware's localization by NDT is working stably.
 
-In the evaluation of localization, the reliability, convergence, and availability of NDT are evaluated.
+In the evaluation of NDT, the reliability, convergence, and availability of NDT are evaluated.
 
 ## Evaluation method
 

diff --git a/docs/use_case/localization.ja.md b/docs/use_case/localization.ja.md
@@ -1,8 +1,8 @@
-# 自己位置推定(NDT)の評価
+# NDT自己位置推定の評価
 
 NDTによるAutowareの自己位置推定が安定して動作しているかを評価する。
 
-自己位置推定の評価では NDT の信頼度、収束性、可用性を評価する。
+NDT自己位置推定の評価では NDT の信頼度、収束性、可用性を評価する。
 
 ## 評価方法
 

diff --git a/docs/use_case/perception.en.md b/docs/use_case/perception.en.md
@@ -4,7 +4,7 @@ The performance of Autoware's recognition function (perception) is evaluated by
 
 Run the perception module and pass the output perception topic to the evaluation library for evaluation.
 
-By default, it is launched with perception_mode = lidar, so if you want to target camera or radar, pass perception_mode to perception.launch.py to change it.
+Since it is activated in the perception_mode described in the scenario, change the scenario if you want to change the sensor to be evaluated.
 
 ## Preparation
 

diff --git a/docs/use_case/perception.ja.md b/docs/use_case/perception.ja.md
@@ -4,7 +4,7 @@ Autoware の認識機能(perception)の認識結果から mAP(mean Average Preci
 
 perception モジュールを起動して出力される perception の topic を評価用ライブラリに渡して評価を行う。
 
-デフォルトではperception_mode = lidarで起動されるので、cameraやradarを対象としたい場合は、perception.launch.pyにperception_modeを渡して変更する。
+シナリオに記述したperception_modeで起動されるので、評価対象のセンサーを変更したい場合はシナリオを変更する。
 
 ## 事前準備