From 9ef17562918829fc1a15bfba36d2207b82dd3dbc Mon Sep 17 00:00:00 2001 From: "T.Aoyama" Date: Sun, 1 Sep 2024 12:18:51 +0900 Subject: [PATCH] update manual --- doc/en/source/algorithm/bayes.rst | 4 ++-- doc/en/source/algorithm/exchange.rst | 4 ++-- doc/en/source/algorithm/mapper_mpi.rst | 4 ++-- doc/en/source/algorithm/pamc.rst | 4 ++-- doc/ja/source/algorithm/bayes.rst | 4 ++-- doc/ja/source/algorithm/exchange.rst | 4 ++-- doc/ja/source/algorithm/mapper_mpi.rst | 4 ++-- doc/ja/source/algorithm/pamc.rst | 4 ++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/en/source/algorithm/bayes.rst b/doc/en/source/algorithm/bayes.rst index b7ba7ae..7f8e8a4 100644 --- a/doc/en/source/algorithm/bayes.rst +++ b/doc/en/source/algorithm/bayes.rst @@ -139,11 +139,11 @@ At each step of the optimization process, the values of the parameters and the c Restart ~~~~~~~~~~~~~~~~~~~~~~ -The execution mode is specified by the ``run_mode`` parameter to the ``Algorithm.main()`` method. +The execution mode is specified by the ``run_mode`` parameter to the constructor. The operation of each mode is described as follows. The parameter values correspond to ``--init``, ``--resume``, and ``--cont`` options of ``py2dmat`` command, respectively. -- ``"initialize"`` (default) +- ``"initial"`` (default) The program is started from the initial state. First, it performs the random sampling for the number of times specified by ``random_max_num_probes`` parameter. diff --git a/doc/en/source/algorithm/exchange.rst b/doc/en/source/algorithm/exchange.rst index c22e2c2..b282fd3 100644 --- a/doc/en/source/algorithm/exchange.rst +++ b/doc/en/source/algorithm/exchange.rst @@ -243,11 +243,11 @@ The remaining columns are the coordinates. Restart ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The execution mode is specified by the ``run_mode`` parameter to the ``Algorithm.main()`` method. +The execution mode is specified by the ``run_mode`` parameter to the constructor. The operation of each mode is described as follows. The parameter values correspond to ``--init``, ``--resume``, and ``--cont`` options of ``py2dmat`` command, respectively. -- ``"initialize"`` (default) +- ``"initial"`` (default) The program is started from the initialized state. If the checkpointing is enabled, the intermediate states will be stored at the folloing occasions: diff --git a/doc/en/source/algorithm/mapper_mpi.rst b/doc/en/source/algorithm/mapper_mpi.rst index e3d5f9f..3a3e76a 100644 --- a/doc/en/source/algorithm/mapper_mpi.rst +++ b/doc/en/source/algorithm/mapper_mpi.rst @@ -106,11 +106,11 @@ Below, output example is shown. Restart ~~~~~~~~~~~~~~~~~~~~~~ -The execution mode is specified by the ``run_mode`` parameter to the ``Algorithm.main()`` method. +The execution mode is specified by the ``run_mode`` parameter to the constructor. The operation of each mode is described as follows. The parameter values correspond to ``--init``, ``--resume``, and ``--cont`` options of ``py2dmat`` command, respectively. -- ``"initialize"`` (default) +- ``"initial"`` (default) The program is started from the initial state. If the checkpointing is enabled, the intermediate states will be stored at the folloing occasions: diff --git a/doc/en/source/algorithm/pamc.rst b/doc/en/source/algorithm/pamc.rst index 87c5278..e7f9cfb 100644 --- a/doc/en/source/algorithm/pamc.rst +++ b/doc/en/source/algorithm/pamc.rst @@ -296,11 +296,11 @@ The sixth column is the acceptance ratio of MC updates. Restart ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The execution mode is specified by the ``run_mode`` parameter to the ``Algorithm.main()`` method. +The execution mode is specified by the ``run_mode`` parameter to the constructor. The operation of each mode is described as follows. The parameter values correspond to ``--init``, ``--resume``, and ``--cont`` options of ``py2dmat`` command, respectively. -- ``"initialize"`` (default) +- ``"initial"`` (default) The program is started from the initialized state. If the checkpointing is enabled, the intermediate states will be stored at the folloing occasions: diff --git a/doc/ja/source/algorithm/bayes.rst b/doc/ja/source/algorithm/bayes.rst index 2e502d1..42638ce 100644 --- a/doc/ja/source/algorithm/bayes.rst +++ b/doc/ja/source/algorithm/bayes.rst @@ -140,11 +140,11 @@ リスタート ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -``Algorithm.main()`` メソッドの引数 ``run_mode`` に実行モードを指定します。 +コンストラクタの引数 ``run_mode`` に実行モードを指定します。 以下はそれぞれ ``py2dmat`` コマンドの引数の ``--init``, ``--resume``, ``--cont`` に対応します。 各モードの動作は次のとおりです。 -- ``"initialize"`` (デフォルト) +- ``"initial"`` (デフォルト) 初期化して実行します。 まず、ランダムサンプリングを ``random_max_num_probes`` に指定した回数だけ行います。 diff --git a/doc/ja/source/algorithm/exchange.rst b/doc/ja/source/algorithm/exchange.rst index 013134d..a8b4f4a 100644 --- a/doc/ja/source/algorithm/exchange.rst +++ b/doc/ja/source/algorithm/exchange.rst @@ -233,11 +233,11 @@ MPI並列を利用する場合は、あらかじめ `mpi4py