Skip to content

Commit fb15067

Browse files
committed
deploy: afeb9c9
1 parent f9b6d1f commit fb15067

File tree

3 files changed

+51
-7
lines changed

3 files changed

+51
-7
lines changed

_sources/hands-on/search.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ class KMeansPPSearch(Search):
5151
agent_info, world_info, scenario_info, module_manager, develop_data
5252
)
5353
self._result: Optional[EntityID] = None
54+
# ロガーの取得
5455
self._logger = get_agent_logger(
5556
f"{self.__class__.__module__}.{self.__class__.__qualname__}",
5657
self._agent_info,
@@ -108,20 +109,25 @@ class KMeansPPSearch(Search):
108109
agent_info, world_info, scenario_info, module_manager, develop_data
109110
)
110111
self._result: Optional[EntityID] = None
111-
112+
113+
# ロガーの取得
112114
self._logger = get_agent_logger(
113115
f"{self.__class__.__module__}.{self.__class__.__qualname__}",
114116
self._agent_info,
115117
)
116-
118+
119+
# クラスタリングモジュールの読み込み
117120
self._clustering: Clustering = cast(
118121
Clustering,
119122
module_manager.get_module(
123+
# config.yamlに登録したkey
120124
"KMeansPPSearch.Clustering",
125+
# 上記のkeyが登録されていなかった場合のデフォルトモジュール
121126
"adf_core_python.implement.module.algorithm.k_means_clustering.KMeansClustering",
122127
),
123128
)
124129
130+
# クラスタリングモジュールの登録
125131
self.register_sub_module(self._clustering)
126132
```
127133

@@ -191,7 +197,7 @@ python main.py
191197
```
192198

193199
```{warning}
194-
プログラム例のプログラムにも一部問題があるので、余裕があったら修正してみてください。
200+
プログラム例のプログラムにも一部改善点があるので、余裕があったら修正してみてください。
195201
```
196202

197203
### 探索対象がステップごとに変わってしまう問題
@@ -230,6 +236,9 @@ python main.py
230236
# 探索対象が未選択の場合
231237
if not self._result and cluster_entity_ids:
232238
self._result = random.choice(cluster_entity_ids)
239+
240+
# ログ出力
241+
self._logger.info(f"Target entity ID: {self._result}")
233242
234243
return self
235244
```
@@ -259,19 +268,24 @@ python main.py
259268
)
260269
self._result: Optional[EntityID] = None
261270
271+
# ロガーの取得
262272
self._logger = get_agent_logger(
263273
f"{self.__class__.__module__}.{self.__class__.__qualname__}",
264274
self._agent_info,
265275
)
266276
277+
# クラスタリングモジュールの読み込み
267278
self._clustering: Clustering = cast(
268279
Clustering,
269280
module_manager.get_module(
281+
# config.yamlに登録したkey
270282
"KMeansPPSearch.Clustering",
283+
# 上記のkeyが登録されていなかった場合のデフォルトモジュール
271284
"adf_core_python.implement.module.algorithm.k_means_clustering.KMeansClustering",
272285
),
273286
)
274287
288+
# クラスタリングモジュールの要録
275289
self.register_sub_module(self._clustering)
276290
277291
# 探索したいエンティティIDのリスト(追加)
@@ -305,6 +319,9 @@ python main.py
305319
# 探索対象が未選択の場合(変更)
306320
if not self._result and self._search_entity_ids:
307321
self._result = random.choice(self._search_entity_ids)
322+
323+
# ログ出力
324+
self._logger.info(f"Target entity ID: {self._result}")
308325
309326
return self
310327
```
@@ -358,4 +375,9 @@ python main.py
358375
nearest_entity_id = entity_id
359376
nearest_distance = distance
360377
self._result = nearest_entity_id
378+
379+
# ログ出力
380+
self._logger.info(f"Target entity ID: {self._result}")
381+
382+
return self
361383
```

hands-on/search.html

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,7 @@ <h2>サーチモジュールの実装の準備<a class="headerlink" href="#id3"
385385
<span class="n">agent_info</span><span class="p">,</span> <span class="n">world_info</span><span class="p">,</span> <span class="n">scenario_info</span><span class="p">,</span> <span class="n">module_manager</span><span class="p">,</span> <span class="n">develop_data</span>
386386
<span class="p">)</span>
387387
<span class="bp">self</span><span class="o">.</span><span class="n">_result</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">EntityID</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
388+
<span class="c1"># ロガーの取得</span>
388389
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span> <span class="o">=</span> <span class="n">get_agent_logger</span><span class="p">(</span>
389390
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__module__</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__qualname__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
390391
<span class="bp">self</span><span class="o">.</span><span class="n">_agent_info</span><span class="p">,</span>
@@ -436,20 +437,25 @@ <h2>モジュールの実装<a class="headerlink" href="#id5" title="Link to thi
436437
<span class="n">agent_info</span><span class="p">,</span> <span class="n">world_info</span><span class="p">,</span> <span class="n">scenario_info</span><span class="p">,</span> <span class="n">module_manager</span><span class="p">,</span> <span class="n">develop_data</span>
437438
<span class="p">)</span>
438439
<span class="bp">self</span><span class="o">.</span><span class="n">_result</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">EntityID</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
439-
440+
441+
<span class="c1"># ロガーの取得</span>
440442
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span> <span class="o">=</span> <span class="n">get_agent_logger</span><span class="p">(</span>
441443
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__module__</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__qualname__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
442444
<span class="bp">self</span><span class="o">.</span><span class="n">_agent_info</span><span class="p">,</span>
443445
<span class="p">)</span>
444-
446+
447+
<span class="c1"># クラスタリングモジュールの読み込み</span>
445448
<span class="bp">self</span><span class="o">.</span><span class="n">_clustering</span><span class="p">:</span> <span class="n">Clustering</span> <span class="o">=</span> <span class="n">cast</span><span class="p">(</span>
446449
<span class="n">Clustering</span><span class="p">,</span>
447450
<span class="n">module_manager</span><span class="o">.</span><span class="n">get_module</span><span class="p">(</span>
451+
<span class="c1"># config.yamlに登録したkey</span>
448452
<span class="s2">&quot;KMeansPPSearch.Clustering&quot;</span><span class="p">,</span>
453+
<span class="c1"># 上記のkeyが登録されていなかった場合のデフォルトモジュール</span>
449454
<span class="s2">&quot;adf_core_python.implement.module.algorithm.k_means_clustering.KMeansClustering&quot;</span><span class="p">,</span>
450455
<span class="p">),</span>
451456
<span class="p">)</span>
452457

458+
<span class="c1"># クラスタリングモジュールの登録</span>
453459
<span class="bp">self</span><span class="o">.</span><span class="n">register_sub_module</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_clustering</span><span class="p">)</span>
454460
</pre></div>
455461
</div>
@@ -514,7 +520,7 @@ <h2>課題<a class="headerlink" href="#id7" title="Link to this heading">#</a></
514520
</div>
515521
<div class="admonition warning">
516522
<p class="admonition-title">警告</p>
517-
<p>プログラム例のプログラムにも一部問題があるので、余裕があったら修正してみてください。</p>
523+
<p>プログラム例のプログラムにも一部改善点があるので、余裕があったら修正してみてください。</p>
518524
</div>
519525
<section id="id8">
520526
<h3>探索対象がステップごとに変わってしまう問題<a class="headerlink" href="#id8" title="Link to this heading">#</a></h3>
@@ -548,6 +554,9 @@ <h3>探索対象がステップごとに変わってしまう問題<a class="hea
548554
<span class="c1"># 探索対象が未選択の場合</span>
549555
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_result</span> <span class="ow">and</span> <span class="n">cluster_entity_ids</span><span class="p">:</span>
550556
<span class="bp">self</span><span class="o">.</span><span class="n">_result</span> <span class="o">=</span> <span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">cluster_entity_ids</span><span class="p">)</span>
557+
558+
<span class="c1"># ログ出力</span>
559+
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Target entity ID: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_result</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
551560

552561
<span class="k">return</span> <span class="bp">self</span>
553562
</pre></div>
@@ -575,19 +584,24 @@ <h3>すでに探索したエンティティを再度探索対象として選択
575584
<span class="p">)</span>
576585
<span class="bp">self</span><span class="o">.</span><span class="n">_result</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">EntityID</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
577586

587+
<span class="c1"># ロガーの取得</span>
578588
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span> <span class="o">=</span> <span class="n">get_agent_logger</span><span class="p">(</span>
579589
<span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__module__</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__qualname__</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span>
580590
<span class="bp">self</span><span class="o">.</span><span class="n">_agent_info</span><span class="p">,</span>
581591
<span class="p">)</span>
582592

593+
<span class="c1"># クラスタリングモジュールの読み込み</span>
583594
<span class="bp">self</span><span class="o">.</span><span class="n">_clustering</span><span class="p">:</span> <span class="n">Clustering</span> <span class="o">=</span> <span class="n">cast</span><span class="p">(</span>
584595
<span class="n">Clustering</span><span class="p">,</span>
585596
<span class="n">module_manager</span><span class="o">.</span><span class="n">get_module</span><span class="p">(</span>
597+
<span class="c1"># config.yamlに登録したkey</span>
586598
<span class="s2">&quot;KMeansPPSearch.Clustering&quot;</span><span class="p">,</span>
599+
<span class="c1"># 上記のkeyが登録されていなかった場合のデフォルトモジュール</span>
587600
<span class="s2">&quot;adf_core_python.implement.module.algorithm.k_means_clustering.KMeansClustering&quot;</span><span class="p">,</span>
588601
<span class="p">),</span>
589602
<span class="p">)</span>
590603

604+
<span class="c1"># クラスタリングモジュールの要録</span>
591605
<span class="bp">self</span><span class="o">.</span><span class="n">register_sub_module</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_clustering</span><span class="p">)</span>
592606

593607
<span class="c1"># 探索したいエンティティIDのリスト(追加)</span>
@@ -621,6 +635,9 @@ <h3>すでに探索したエンティティを再度探索対象として選択
621635
<span class="c1"># 探索対象が未選択の場合(変更)</span>
622636
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_result</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_search_entity_ids</span><span class="p">:</span>
623637
<span class="bp">self</span><span class="o">.</span><span class="n">_result</span> <span class="o">=</span> <span class="n">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_search_entity_ids</span><span class="p">)</span>
638+
639+
<span class="c1"># ログ出力</span>
640+
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Target entity ID: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_result</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
624641

625642
<span class="k">return</span> <span class="bp">self</span>
626643
</pre></div>
@@ -672,6 +689,11 @@ <h3>近くに未探索のエンティティがあるのに、遠くのエンテ
672689
<span class="n">nearest_entity_id</span> <span class="o">=</span> <span class="n">entity_id</span>
673690
<span class="n">nearest_distance</span> <span class="o">=</span> <span class="n">distance</span>
674691
<span class="bp">self</span><span class="o">.</span><span class="n">_result</span> <span class="o">=</span> <span class="n">nearest_entity_id</span>
692+
693+
<span class="c1"># ログ出力</span>
694+
<span class="bp">self</span><span class="o">.</span><span class="n">_logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Target entity ID: </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_result</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
695+
696+
<span class="k">return</span> <span class="bp">self</span>
675697
</pre></div>
676698
</div>
677699
</div>

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)