Skip to content

Commit f23bfe5

Browse files
committed
Merge branch 'develop' into release-2.1
2 parents 2c9c10b + 6c53615 commit f23bfe5

File tree

6 files changed

+17
-7
lines changed

6 files changed

+17
-7
lines changed

docs/sphinx/en/source/how_to_use/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ The coordinate information should not be written here because it will obviously
128128
The lattice sites are specified in a separate abICS input file (see below),
129129
and abICS will take care of generating the coordinates section at each sampling step.
130130

131-
.. _subsec_basic_input:
131+
.. _trainer_specific_notes:
132132

133133
Machine learning trainer/calculator-specific notes
134134
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/sphinx/en/source/inputfiles/parameter_solver.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ In the present version, there are two main types of solvers.
1616

1717
- Parameters of the DFT solver such as convergence criteria are specified by using input files of the solver.
1818

19+
- Solver specific notes (e.g., input filename) are described in :ref:`solver_specific_notes`.
20+
1921
- Configurations (atomic positions, atomic species, etc.) are specified by the ``[config]`` section.
2022

2123
- Potts model solver

docs/sphinx/en/source/inputfiles/parameter_train.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@
33
[train] section
44
-------------------------------
55

6-
We create neural network potentials by learning the results of ab initio calculations made by abics\_train using aenet.
7-
The input information for abics_train is described in the ``[trainer]`` section. The description of each parameter is as follows.
6+
``abics_train`` creates and trains a regression model from configurations to energies.
7+
Indeed, ``abics_train`` uses an external program to train the model.
8+
In the current version, only ``aenet`` is supported as an external program.
9+
For software-specific notes (such as input file names), see :ref:`trainer_specific_notes`.
810

9-
This section specifies the type of physical quantity to be acquired.
11+
The input information for ``abics_train`` is described in the ``[trainer]`` section. The description of each parameter is as follows.
1012
An example is shown as follows:
1113

1214
::

docs/sphinx/ja/source/how_to_use/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ OpenMX
132132
参照ファイルのパスはabICSの入力ファイルにある ``[solver]`` セクションの ``base_input_dir`` で指定します。
133133
座標情報については、abICSの入力ファイルを参照するため、記載する必要はありません。
134134

135-
.. _subsec_basic_input:
135+
.. _trainer_specific_notes:
136136

137137
機械学習モデルソルバー利用時の注意点
138138
=======================================

docs/sphinx/ja/source/inputfiles/parameter_solver.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717

1818
- 収束条件など, ソフトウェア固有のパラメータなどはそれぞれの入力ファイルから読み取ります.
1919

20+
- それぞれのソフトウェア固有の注意事項(入力ファイル名など)は :ref:`solver_specific_notes` を参照してください.
21+
2022
- 原子の存在する座標や原子種などは ``[config]`` セクションで指定します.
2123

2224
- Potts 模型ソルバー

docs/sphinx/ja/source/inputfiles/parameter_train.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,12 @@
44
-------------------------------
55

66
訓練データから配置エネルギー予測モデルを学習する学習器の設定を行います。
7-
現在のところ、abICSではaenetのみに対応しています。
8-
以下のようなファイルフォーマットをしています.
7+
8+
予測モデルの作成・学習には外部のプログラムを利用します。
9+
現在はaenetのみに対応しています。
10+
ソフトウェア固有の注意事項(入力ファイル名など)は :ref:`trainer_specific_notes` を参照してください.
11+
12+
本セクションは以下のようなファイルフォーマットをしています.
913

1014
.. code-block:: toml
1115

0 commit comments

Comments
 (0)