Skip to content

Commit 180c04f

Browse files
committed
feat: 事前計算に関するガイドを追加し、ドキュメントを更新
1 parent 5bf0065 commit 180c04f

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

docs/source/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,12 @@ adf-core-pythonを始めるには、インストールに従い、このドキ
6767
hands-on/clustering
6868
hands-on/search
6969

70+
.. toctree::
71+
:maxdepth: 1
72+
:caption: 開発ガイド
73+
74+
tips/precompute
75+
7076
.. toctree::
7177
:maxdepth: 1
7278
:caption: APIドキュメント

docs/source/tips/precompute.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 事前計算について
2+
3+
## 事前計算の実行の仕方
4+
5+
事前計算を実行するには、`--precompute` フラグを使用します。
6+
7+
```bash
8+
python main.py --precompute -a 1 -f 1 -p 1 -ac 0 -fs 0 -po 0
9+
```
10+
11+
このコマンドは、事前計算を実行し、事前計算結果を`launcher.yaml``adf.agent.precompute`で指定されたディレクトリに保存します。
12+
13+
## 事前計算の利用の仕方
14+
15+
事前計算結果が`launcher.yaml``adf.agent.precompute`で指定されたディレクトリに保存されている場合、通常の実行時に自動的に事前計算結果が利用されます。特別なフラグを指定する必要はありません。
16+
17+
```{warning}
18+
事前計算の結果を使用したくない場合は事前計算時に作成されたディレクトリを削除してください。
19+
```

0 commit comments

Comments
 (0)