Merge branch 'main' into docs/add-instructions-for-uploading-package-…

…to-online-environment
AutomotiveAIChallenge · Jun 21, 2024 · 4b6761a · 4b6761a
2 parents 892483c + 10028cf
commit 4b6761a
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -6,3 +6,17 @@
 
 - [日本語ページ](https://automotiveaichallenge.github.io/aichallenge-documentation-2024/)
 - [English Page](https://automotiveaichallenge.github.io/aichallenge-documentation-2024/en/)
+
+## Deploy
+
+ドキュメントの生成環境をインストールするには以下のコマンドを実行します。
+
+```bash
+pip install -r requirements.txt
+```
+
+ドキュメントをローカル環境で確認したい場合は以下を実行します。
+
+```bash
+mkdocs serve
+```
diff --git a/docs/course/perception.md b/docs/course/perception.md
@@ -1,4 +1,4 @@
-# 03. 外界認識
+# 03. 障害物回避
 
 安全な自動運転を行うために、障害物を認識し必要に応じて回避する必要があります。ここでは図のように、障害物を認識して回避しながら目標地点に到達することを目指します。
 

diff --git a/docs/faq.en.md b/docs/faq.en.md
@@ -159,7 +159,7 @@ If using a high-performance GPU is difficult, setting the time scale to around 0
 
 #### <u>I want to tune the mpc, but are the model parameters (lag and time constants) used in AWSIM disclosed?</u>
 
-The lag and time constants are not measured or disclosed, but the basic specifications are available [here](https://automotiveaichallenge.github.io/aichallenge-documentation-2024/specifications/simulator/).
+The lag and time constants are not measured or disclosed, but the basic specifications are available [here](./specifications/simulator.en.md).
 
 ---
 

diff --git a/docs/faq.ja.md b/docs/faq.ja.md
@@ -166,7 +166,7 @@ GPUの性能不足が原因の一つになります。
 
 #### <u>mpcのチューニングをしたいのですが，今回AWSIMで使用されているモデルパラメータ（遅れや時定数など）は公開されていないでしょうか．</u>
 
-遅れや時定数については計測も公開もされていませんが、基本的な仕様については[こちら](https://automotiveaichallenge.github.io/aichallenge-documentation-2024/specifications/simulator/)に公開されています。
+遅れや時定数については計測も公開もされていませんが、基本的な仕様については[こちら](./specifications/simulator.ja.md)に公開されています。
 
 ---
 

diff --git a/docs/getting-started.ja.md b/docs/getting-started.ja.md
@@ -1,10 +1,22 @@
 # はじめ方
 
-このページではROS2やAutowareに馴染みのない初学者向けに、AIチャレンジでの一連の流れをチュートリアルとして記載します。
+このページではAIチャレンジでの一連の流れを記載します。
+
+## オンライン採点環境へのアクセスと提出
+
+本大会では、オンライン環境に提出ファイル（ソースコードの圧縮ファイル）をアップロードすることで自動採点が行われ、順位が決定されます。オンライン採点環境には[こちら](https://aichallenge-board.jsae.or.jp)からアクセスしてください。
+ユーザー登録がまだ済んでいない方はSlackでの案内に従って登録お願いします。
+
+アクセスが出来たら、一度ソースコードの提出をしてみましょう。
+[GoogleDrive](https://drive.google.com/file/d/19LU70cgeg48R6stEXjvwDp1pTT25OjeN)からサンプルコードの圧縮ファイルをダウンロードして、オンライン採点環境の「UPLOAD」ボタンからそのままアップロードすることで提出ができます。
+
+![submit](./images/submit.png)
+
+以下の手順では環境構築から開発、ファイルの提出までの流れを説明します。
 
 ## 必要なもの
 
-## Ubuntu PC
+### Ubuntu PC
 
 [推奨環境](./setup/requirements.ja.md)を満たすPCが必要ですが、推奨と書かれているものについては満たしていなくても動作することは可能です。ただし、推奨よりも低いスペックで動作させる場合ROS2側での実行速度が安定せずシミュレーションの実行の度に挙動が大きく変わってしまう可能性があります。
 
@@ -36,7 +48,19 @@
 
 [メインモジュールについての解説ページ](./development/main-module.ja.md)
 
-※AIチャレンジで開発する上でベースとなるソースコードは[大会用リポジトリ](https://github.com/AutomotiveAIChallenge/aichallenge-2024/tree/main/aichallenge/workspace/src/aichallenge_submit)内に提供されています。参加者の皆様にはこちらのコードをカスタマイズすることで開発を進めていただきますが、Autowareに不慣れな方はまずは[入門講座](./course/index.ja.md)を一通りやっていただくことをお勧めします。
+※AIチャレンジで開発する上でベースとなるソースコードは[大会用リポジトリ](https://github.com/AutomotiveAIChallenge/aichallenge-2024/tree/main/aichallenge/workspace/src/aichallenge_submit)内に提供されています。参加者の皆様にはこちらのコードやパラメータをカスタマイズすることで開発を進めていただきますが、Autowareに不慣れな方はまずは[入門講座](./course/index.ja.md)を一通りやっていただくことをお勧めします。
+
+※リポジトリ内のコードを使わず独自に開発する方など、各種仕様について知りたい方は[インターフェース仕様](./specifications/interface.ja.md)、[シミュレータ仕様](./specifications/simulator.ja.md)のページを参照してください。
+
+## ソースコードの提出
+
+完成したコードの提出は[オンライン採点環境](https://aichallenge-board.jsae.or.jp)から行います。提出は以下の手順で行ってください。
+
+1. ソースコードの圧縮
+2. ローカル評価環境での動作確認
+3. オンライン採点環境への提出
+
+各手順の方法については[提出ページ](./submission.ja.md)を参照してください。
 
 ## 参考
 
@@ -59,6 +83,10 @@ cd aichallenge2024 # path to aichallenge2024
 git pull origin/main
 ```
 
+### 描画ありAWSIMの導入
+
+AWSIMのシミュレーション画面を確認したい方は、[こちら](./setup/visible-simulation.ja.md)の手順に従って描画ありAWSIMの導入を行ってください。
+
 ### TroubleShooting
 
 Q. `docker_run.sh: 行 35: rocker: コマンドが見つかりません`

diff --git a/docs/images/submit.png b/docs/images/submit.png
diff --git a/docs/index.ja.md b/docs/index.ja.md
@@ -1,4 +1,4 @@
-# Japan Automotive AI Challenge 20XX
+# Japan Automotive AI Challenge 2024
 
 ## コンセプト
 

diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -42,7 +42,6 @@ nav:
       - course/index.md
       - course/vehicle.md
       - course/velocity_planning.md
-      - course/path_planning.md
       - course/perception.md
   - FAQ: faq.md
   - Community: community.md
-Original file line number
+Diff line change
@@ Expand Up @@
     #### <u>I want to tune the mpc, but are the model parameters (lag and time constants) used in AWSIM disclosed?</u>
-    The lag and time constants are not measured or disclosed, but the basic specifications are available [here](https://automotiveaichallenge.github.io/aichallenge-documentation-2024/specifications/simulator/).
+    The lag and time constants are not measured or disclosed, but the basic specifications are available [here](./specifications/simulator.en.md).
     ---
@@ Expand Down @@