Skip to content

Commit b794638

Browse files
authored
Update README.md
1 parent bcd0e9e commit b794638

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src="./assets/logo.png" width="400" height="300">
33
</p>
44

5-
<font size=36>**NOTE: This package has been renamed as `gdpx` from `GDPy` as we found unfortunately the name of `gdpy` has been taken for a long time. The `x` instead of `y` can be seen as an extended and improved verion of the original one. The development of `gdpx` will still be undergoing in this `GDPy` repository. Also, the documentation is changed to https://gdpx.readthedocs.io.**</font>
5+
<font size=36>**NOTE: This package has been renamed as `gdpx` from `GDPy` as we found, unfortunately, the name of `gdpy` has been taken for a long time. The `x` instead of `y` can be seen as an extended and improved version of the original one. The development of `gdpx` will still be undergoing in this `GDPy` repository. Also, the documentation is changed to https://gdpx.readthedocs.io.**</font>
66

77
<font size=36>**NOTE: `gdpx` is under active development and has not been released. The APIs are frequently changed and we cannot ensure any
88
backward compatibility.**</font>
@@ -17,9 +17,8 @@ $ python -m pip install git+https://github.com/hsulab/GDPy.git
1717
```
1818

1919
## Stable Release
20-
We have pull request to add `gdpx` to conda-forge but it can only be installed from a personal conda channel right now.
2120
```
22-
$ conda install gdpx -c jxu1223 -c conda-forge
21+
$ conda install gdpx -c conda-forge
2322
```
2423

2524
# Table of Contents
@@ -92,7 +91,7 @@ We take advantage of codes in well-established packages (ASE and LAMMPS) to perf
9291
| Grand Cononical Monte Carlo (gcmc) | Monte Carlo with Variable Composition | GDPy |
9392

9493
## Workflow
95-
There are two kinds of workflows according to the way how they couple the expedition and the training. Offline workflow as the major category separates the expedition and the training, which collects a large number of structures from several expeditions and then train the MLIP with the collective dataset. This process is highly parallelised, and is usually aimed for a general dataset. Online workflow, a really popular one, adopts an on-the-fly strategy to build dataset during the expedition, where a new MLIP is trained to continue exploration once new candidates are selected (sometimes only one structure every time!). Thus, it is mostly used to train a MLIP for a very specific system.
94+
There are two kinds of workflows according to the way they couple the expedition and the training. Offline workflow as the major category separates the expedition and the training, which collects structures from several expeditions and then trains the MLIP with the collective dataset. This process is highly parallelised and is usually aimed at a general dataset. Online workflow, a really popular one, adopts an on-the-fly strategy to build a dataset during the expedition, where a new MLIP is trained to continue exploration once new candidates are selected (sometimes only one structure every time!). Thus, it is mostly used to train an MLIP for a particular system.
9695

9796
| Type | Supported Expedition |
9897
| ------- | -------------------- |

0 commit comments

Comments
 (0)