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

fix: add manual for submitting to the GettingStarted page #33

Merged
merged 5 commits into from
Jun 20, 2024
Merged

fix: add manual for submitting to the GettingStarted page #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4f6c1b3
fix: add manual for submitting to the GettingStarted page
dazzhe Jun 19, 2024
ac4fdf3
fix: fix requirements
dazzhe Jun 19, 2024
7bfe8db
fix: refine GettingStarted page
dazzhe Jun 19, 2024
6cd6d49
fix: add submit screen, add link to specifications, etc.
dazzhe Jun 20, 2024
a343e12
chore: fix lint
taikitanaka3 Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 31 additions & 3 deletions docs/getting-started.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
# はじめ方

このページではROS2やAutowareに馴染みのない初学者向けに、AIチャレンジでの一連の流れをチュートリアルとして記載します。
このページではAIチャレンジでの一連の流れを記載します。

## オンライン採点環境へのアクセスと提出

本大会では、オンライン環境に提出ファイル（ソースコードの圧縮ファイル）をアップロードすることで自動採点が行われ、順位が決定されます。オンライン採点環境には[こちら](https://aichallenge-board.jsae.or.jp)からアクセスしてください。
ユーザー登録がまだ済んでいない方はSlackでの案内に従って登録お願いします。

アクセスが出来たら、一度ソースコードの提出をしてみましょう。
[GoogleDrive](https://drive.google.com/file/d/19LU70cgeg48R6stEXjvwDp1pTT25OjeN)からサンプルコードの圧縮ファイルをダウンロードして、オンライン採点環境の「UPLOAD」ボタンからそのままアップロードすることで提出ができます。
Copy link
Contributor

Choose a reason for hiding this comment

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

@dazzhe
sample のファイルのアップロード画面のスクショは載せてもいいかと思います。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@taikitanaka3
追加しました


![submit](./images/submit.png)

以下の手順では環境構築から開発、ファイルの提出までの流れを説明します。

## 必要なもの

## Ubuntu PC
### Ubuntu PC

[推奨環境](./setup/requirements.ja.md)を満たすPCが必要ですが、推奨と書かれているものについては満たしていなくても動作することは可能です。ただし、推奨よりも低いスペックで動作させる場合ROS2側での実行速度が安定せずシミュレーションの実行の度に挙動が大きく変わってしまう可能性があります。

Expand Down Expand Up @@ -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)を一通りやっていただくことをお勧めします。
isamu-takagi marked this conversation as resolved.
Show resolved Hide resolved

※リポジトリ内のコードを使わず独自に開発する方など、各種仕様について知りたい方は[インターフェース仕様](./specifications/interface.ja.md)、[シミュレータ仕様](./specifications/simulator.ja.md)のページを参照してください。

## ソースコードの提出

完成したコードの提出は[オンライン採点環境](https://aichallenge-board.jsae.or.jp)から行います。提出は以下の手順で行ってください。

1. ソースコードの圧縮
2. ローカル評価環境での動作確認
3. オンライン採点環境への提出

各手順の方法については[提出ページ](./submission.ja.md)を参照してください。

## 参考

Expand All @@ -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: コマンドが見つかりません`
Expand Down
Binary file added docs/images/submit.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading