From 0dfc49509085db0c0447601858aa2f28433198e5 Mon Sep 17 00:00:00 2001 From: Yuichi Motoyama Date: Thu, 15 Apr 2021 13:20:36 +0900 Subject: [PATCH] added docs for `root_dir` --- doc/en/source/input.rst | 6 ++++++ doc/ja/source/input.rst | 7 +++++++ 2 files changed, 13 insertions(+) diff --git a/doc/en/source/input.rst b/doc/en/source/input.rst index 2749b09d..d50a9253 100644 --- a/doc/en/source/input.rst +++ b/doc/en/source/input.rst @@ -30,6 +30,12 @@ The input file consists of the following four sections. Description: Dimension of the search space (number of parameters to search) +- ``root_dir`` + + Format: string (default: The directory where the program was executed) + + Description: Name of the root directory. The origin of the relative paths to input files. + - ``output_dir`` Format: string (default: The directory where the program was executed) diff --git a/doc/ja/source/input.rst b/doc/ja/source/input.rst index 25b28ee3..c97e678c 100644 --- a/doc/ja/source/input.rst +++ b/doc/ja/source/input.rst @@ -30,6 +30,13 @@ py2dmat は入力ファイルの形式に `TOML `_ を採 説明: 探索空間の次元(探索するパラメータの数) +- ``root_dir`` + + 形式: string型 (default: プログラム実行時のディレクトリ) + + 説明: プログラムを実行する一番上のディレクトリ。 + 入力ファイルなどのパスはすべて ``root_dir`` を起点とします。 + - ``output_dir`` 形式: string型 (default: プログラム実行時のディレクトリ)