Skip to content

Commit a290953

Browse files
authored
Update gpcam_tutorial.rst
1 parent 8df51be commit a290953

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

docs/tutorials/gpcam_tutorial.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Surrogate Model with gpCAM
2-
==========================
1+
Surrogate Modeling with gpCAM
2+
=============================
33

44
This example uses gpCAM_ to construct a global surrogate of ``f`` values using a Gaussian process.
55

@@ -14,9 +14,9 @@ Generator function
1414

1515
The gpCAM generator function is called ``persistent_gpCAM``.
1616

17-
This persistent generator is started at the beginning and runs until the Ensemble closes down.
17+
This persistent generator is started at the beginning of the Ensemble and runs until the Ensemble closes down.
1818

19-
This is a version of the gpCAM generator that can be found, along with other gpCAM generator functions, at `libensemble/gen_funcs/persistent_gpCAM.py <https://github.com/Libensemble/libensemble/blob/main/libensemble/gen_funcs/persistent_gpCAM.py>`_ and can be imported from that location when libEnsemble is installed as follows:
19+
This version (and others) of the gpCAM generator can be found at `libensemble/gen_funcs/persistent_gpCAM.py <https://github.com/Libensemble/libensemble/blob/main/libensemble/gen_funcs/persistent_gpCAM.py>`_ and can be imported from that location when libEnsemble is installed as follows:
2020

2121
``from libensemble.gen_funcs.persistent_gpCAM import persistent_gpCAM``
2222

@@ -74,8 +74,8 @@ Common acquisition functions include:
7474

7575
**Uncertainty reduction:**
7676

77-
- **"variance"** (default): The optimizer will find N best points.
78-
- **"total correlation"**: More expensive but points found are self-avoiding.
77+
- **"variance"** (default): The optimizer will produce N best points.
78+
- **"total correlation"**: More expensive but points produced are self-avoiding.
7979

8080
**Bayesian optimization:**
8181

@@ -142,14 +142,14 @@ The following code adds the functions used by ``persistent_gpCAM``.
142142
return my_gp
143143
144144
Simulator function
145-
-----------------
145+
------------------
146146

147147
Simulator functions or ``sim_f``\ s perform calculations based on parameters created in the generator function.
148-
Each worker will run a copy of this function in parallel.
148+
Each worker runs a copy of this function in parallel.
149149

150-
The function used here is the simple 2D ``six_hump_camel``, for demonstration purposes.
150+
The function here is the simple 2D ``six_hump_camel``, for demonstration purposes.
151151

152-
For running parallel applications in the simulator see the `forces examples <https://github.com/Libensemble/libensemble/tree/main/libensemble/tests/scaling_tests/forces/forces_simple>`_.
152+
For running applications using parallel resources in the simulator see the `forces examples <https://github.com/Libensemble/libensemble/tree/main/libensemble/tests/scaling_tests/forces/forces_simple>`_.
153153

154154
.. code-block:: python
155155
@@ -181,7 +181,7 @@ For running parallel applications in the simulator see the `forces examples <htt
181181
Calling Script
182182
-------------
183183

184-
Our calling script contains the configuration for libEnsemble, the generator function, and the simulator function. We then create the ensemble object and are ready to run the ensemble.
184+
Our calling script configures libEnsemble, the generator function, and the simulator function. It then create the ensemble object and runs the ensemble.
185185

186186
First we will create a cleanup script so we can easily re-run.
187187

@@ -277,7 +277,7 @@ At the end of our calling script we run the ensemble.
277277
Rerun and test model at known points
278278
-----------------------------------
279279

280-
To see how our model improves, we can use our existing points as test points and run again with a different seed.
280+
To see how the accuracy of the surrogate model improves, we can use previously evaluated points as test points and run again with a different seed.
281281

282282
.. code-block:: python
283283
@@ -294,8 +294,8 @@ To see how our model improves, we can use our existing points as test points and
294294
Viewing model progression
295295
------------------------
296296

297-
Now we can check how our model compared against the known test points at each iteration.
298-
The comparison is based on the **Mean Squared Error** between the gpCAM model and our known
297+
Now we can check how our model's values compared against the values at known test points as the ensemble progresses.
298+
The comparison is based on the **mean squared error** between the gpCAM model and our known
299299
values at the test points.
300300

301301
.. code-block:: python

0 commit comments

Comments
 (0)