Skip to content

Commit cbf5a96

Browse files
authored
Revise GPU version information in README
Updated links and descriptions related to the GPU version and its usage.
1 parent 7347b35 commit cbf5a96

1 file changed

Lines changed: 1 addition & 9 deletions

File tree

README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The package comes with a **GPU** speedup version and convenient graphical user i
4747
Unlike CLI, these needs to be explicitly enabled during the installation.
4848
To enable it, check the [dedicated section](https://github.com/Probe-Particle/ppafm/wiki/Install-ppafm#enable-gpugui-support) on the [Install ppafm](https://github.com/Probe-Particle/ppafm/wiki/Install-ppafm#enable-gpugui-support) wiki page.
4949
To know more about the GUI interface, please consult the [ppafm GUI](https://github.com/Probe-Particle/ppafm/wiki/PPAFM-GUI) wiki page.
50-
Additional information about the **GPU** version can be found [bellow](https://github.com/Probe-Particle/ppafm?tab=readme-ov-file#run-gpu-generator-for-machine-learning), at [models](https://github.com/Probe-Particle/ppafm/wiki#ppafm-simulation-models-and-implementations) and [models differences](https://github.com/Probe-Particle/ppafm/wiki/Differences-between-the-CPU-and-GPU-implementations) wiki pages.
50+
Additional information about the **GPU** version can be found [bellow, when describing python API](https://github.com/Probe-Particle/ppafm?tab=readme-ov-file#usage-examples), at [models](https://github.com/Probe-Particle/ppafm/wiki#ppafm-simulation-models-and-implementations) and [models differences](https://github.com/Probe-Particle/ppafm/wiki/Differences-between-the-CPU-and-GPU-implementations) wiki pages.
5151

5252
## Usage examples
5353

@@ -67,14 +67,6 @@ Once the simulation is finished, several files and folders will be created.
6767

6868
See also the tutorial for using the Python API for [running GPU-accelerated simulations](https://ppafm.readthedocs.io/en/latest/tutorials/afmulator-tutorial.html).
6969

70-
### Run GPU generator for machine learning
71-
72-
* `examples/CorrectionLoopGraphene` use GPU accelerated ppafm to iteratively improve the estimate of molecular geometry by comparing simulated AFM images with reference.
73-
This is a work in progress.
74-
Currently, modification of estimate geometry is random (Monte-Carlo), while later we plan to develop a more clever (e.g. Machine-Learned) heuristic for more efficient improvement.
75-
* `examples/Generator` quickly generates a batch of simulated AFM images (resp. 3D data stacks) which can be further used for machine learning.
76-
Especially in connection with (https://github.com/SINGROUP/ASD-AFM).
77-
7870
## For contributors
7971
If you miss some functionality or have discovered issues with the latest release - let us know by creating [an issue](https://github.com/Probe-Particle/ppafm/issues/new).
8072
If you would like to contribute to the development of the ppafm code, please read the [Developer's Guide](https://github.com/Probe-Particle/ppafm/wiki/For-Developers) wiki page.

0 commit comments

Comments
 (0)