Skip to content

Commit 03a8b8f

Browse files
committed
docs: fix lint
1 parent a3e701e commit 03a8b8f

File tree

4 files changed

+14
-12
lines changed

4 files changed

+14
-12
lines changed

docs/source/hands-on/clustering.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
# クラスタリングモジュール
22

3-
43
## クラスタリングモジュールの目的
54

65
複数のエージェントを動かす場合は、それらのエージェントにどのように協調させるかが重要になります。RRSでは多くのチームが、エージェントに各々の担当地域を持たせ役割分担をおこなう協調を取り入れています(他の手段による協調も取り入れています)。担当地域を割り振るためには、地図上のオブジェクトをいくつかのグループに分ける必要があります。このようなグループ分けをしてそれらを管理する場合には、クラスタリングモジュールと呼ばれるモジュールを用います。
76

8-
本資料では、多くの世界大会参加チームが使用しているアルゴリズムを用いたクラスタリングモジュールの実装をおこないます。
7+
本資料では、多くの世界大会参加チームが使用しているアルゴリズムを用いたクラスタリングモジュールの実装をおこないます。
98

109
## 開発するクラスタリングモジュールの概要
1110

1211
本資料で開発するモジュールは下の画像のように、
1312

14-
1. k-means++アルゴリズムによって地図上のオブジェクトをエージェント数分の区画に分けます。
13+
1. k-means++アルゴリズムによって地図上のオブジェクトをエージェント数分の区画に分けます。
1514
1. Hungarianアルゴリズムによってそれらの区画とエージェントを (間の距離の総和が最も小さくなるように)1対1で結びつけます。
1615

17-
1816
![クラスタリングの画像](./../images/clustering_image.jpg)
1917

2018
## クラスタリングモジュールの実装
@@ -23,7 +21,7 @@
2321
以降の作業では、カレントディレクトリがプロジェクトのルートディレクトリであることを前提としています。
2422
```
2523

26-
まず、クラスタリングモジュールを記述するためのファイルを作成します。
24+
まず、クラスタリングモジュールを記述するためのファイルを作成します。
2725

2826
```bash
2927
mkdir -p src/<your_team_name>/module/algorithm
@@ -299,5 +297,3 @@ SampleSearch:
299297
SampleHumanDetector:
300298
Clustering: src.test-agent.module.algorithm.k_means_pp_clustering.KMeansPPClustering
301299
```
302-
303-

docs/source/tutorial/agent/agent_control.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# エージェントの制御
2+
23
このセクションでは、エージェントの制御用のプログラムを作成する方法について説明します。
34

4-
## エージェントの制御
5+
## エージェントの制御について
56

67
RRSの災害救助エージェントは3種類あり、種類毎にそれぞれ異なるプログラムを書く必要があります。しかし、初めから全てのプログラムを書くことは困難です。ここではまず初めに、消防隊エージェントを操作するプログラムの一部を書いてみましょう.
78

@@ -88,11 +89,12 @@ class FireBrigadeHumanDetector(HumanDetector):
8889
return self._result
8990
```
9091

91-
## モジュールの登錍
92+
## モジュールの登録
9293

9394
次に、作成したモジュールを登録します.
9495

9596
`WORKING_DIR/<your_team_name>/config/module.yaml` ファイルを開き,以下の部分を
97+
9698
```yaml
9799
DefaultTacticsFireBrigade:
98100
HumanDetector: src.<your_team_name>.module.complex.sample_human_detector.SampleHumanDetector
@@ -126,7 +128,6 @@ python main.py
126128

127129
このフローチャート中の各処理を,次小節で紹介する各クラス・メソッド等で置き換えたものを,`fire_brigade_human_detector.py` に記述していくことで,救助対象選択プログラムを完成させます.
128130

129-
130131
## `Human Detector` モジュールの実装で使用するクラス・メソッド
131132

132133
### WorldInfo
@@ -146,6 +147,7 @@ python main.py
146147
`EntityID` クラスは,全てのエージェント/オブジェクトを一意に識別するためのID(識別子)を表すクラスです. RRSではエージェントとオブジェクトをまとめて,エンティティと呼んでいます.
147148

148149
- 自分自身のエンティティIDを取得する
150+
149151
```python
150152
self._agent_info.get_entity_id()
151153
```
@@ -155,11 +157,13 @@ self._agent_info.get_entity_id()
155157
`Entity` クラスは,エンティティの基底クラスです. このクラスは,エンティティの基本情報を保持します.
156158

157159
- エンティティIDからエンティティを取得する
160+
158161
```python
159162
self._world_info.get_entity(entity_id)
160163
```
161164

162165
- 同じクラスのエンティティを全て取得する
166+
163167
```python
164168
self._world_info.get_entities_by_type([Building, Road])
165169
```
@@ -169,18 +173,21 @@ self._world_info.get_entities_by_type([Building, Road])
169173
`Civilian` クラスは,市民を表すクラスです.このクラスからは,エージェントの位置や負傷の進行状況を取得することができます.
170174

171175
- `entity` が市民であるかどうかを判定する
176+
172177
```python
173178
isinstance(entity, Civilian)
174179
```
175180

176181
- 市民が生きているかどうかを判定する
182+
177183
```python
178184
hp: Optional[int] = entity.get_hp()
179185
if hp is None or hp <= 0:
180186
return False
181187
```
182188

183189
- 市民が埋まっているかどうかを判定する
190+
184191
```python
185192
buriedness: Optional[int] = entity.get_buriedness()
186193
if buriedness is None or buriedness <= 0:
@@ -195,7 +202,6 @@ RRS上のエンティティは下図のように Entity を継承したクラス
195202

196203
![エンティティの継承関係](./../../images/entity.png)
197204

198-
199205
## `Human Detector` モジュールの実装
200206

201207
`Human Detector` モジュールの実装を行います.

docs/source/tutorial/environment/environment.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ git clone https://github.com/roborescue/rcrs-server.git
2020
cd rcrs-server
2121
./gradlew completeBuild
2222
```
23+
2324
ビルドした際に以下のようなメッセージが表示されたら成功です。
2425

2526
```bash

docs/source/tutorial/install/install.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
このセクションでは、パッケージのインストール方法について説明します。
44

5-
65
## 前提条件
76

87
インストールする前に、以下の前提条件を確認してください:

0 commit comments

Comments
 (0)