Skip to content

Commit

Permalink
Merge branch 'master' into docs/improve_examples
Browse files Browse the repository at this point in the history
  • Loading branch information
jmlarson1 committed Aug 9, 2018
2 parents 96dcb1d + 4a3bfe1 commit 5568fc1
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/data_structures/persis_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
persis_info
===========

Supply peristent information to libEnsemble::
Supply persistent information to libEnsemble::

persis_info: [dict] :
Dictionary containing persistent info
Expand Down
12 changes: 6 additions & 6 deletions docs/sim_gen_alloc_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The sim_f function will be called by libEnsemble with the following API::
Parameters:
***********

**H**: :obj:`numpy strucutred array`
**H**: :obj:`numpy structured array`
:doc:`(example)<data_structures/history_array>`

**persis_info**: :obj:`dict`
Expand All @@ -29,7 +29,7 @@ Parameters:
Returns:
********

**H**: :obj:`numpy strucutred array`
**H**: :obj:`numpy structured array`
with keys/value-sizes matching those in sim_specs['out'].
:doc:`(example)<data_structures/history_array>`

Expand All @@ -55,7 +55,7 @@ The gen_f calculations will be called by libEnsemble with the following API::
Parameters:
***********

**H**: :obj:`numpy strucutred array`
**H**: :obj:`numpy structured array`
:doc:`(example)<data_structures/history_array>`

**persis_info**: :obj:`dict`
Expand All @@ -71,7 +71,7 @@ Parameters:
Returns:
********

**H**: :obj:`numpy strucutred array`
**H**: :obj:`numpy structured array`
with keys/value-sizes matching those in gen_specs['out'].
:doc:`(example)<data_structures/history_array>`

Expand All @@ -96,10 +96,10 @@ The alloc_f calculations will be called by libEnsemble with the following API::
Parameters:
***********

**W**: :obj:`numpy strucutred array`
**W**: :obj:`numpy structured array`
:doc:`(example)<data_structures/worker_array>`

**H**: :obj:`numpy strucutred array`
**H**: :obj:`numpy structured array`
:doc:`(example)<data_structures/history_array>`

**sim_specs**: :obj:`dict`
Expand Down
10 changes: 5 additions & 5 deletions docs/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,21 @@ to support) and plan to have examples of:
simulation sim_f at various parameter values and gen_f would return candidate
parameter values (possibly after each sim_f output).

* A user is has a gen_f that produces different meshes to be used within a
* A user has a gen_f that produces different meshes to be used within a
sim_f. Given the sim_f output, gen_f will refine a mesh or produce a new
mesh. libEnsemble can ensure that the calculated meshes can be used by
multiple simulations without requiring movement of data.

* A user is attempting to sample a simulation sim_f at some parameter values,
many of which are will cause the simulation to fail. libEnsemble can stop
many of which will cause the simulation to fail. libEnsemble can stop
unresponsive evaluations, and recover computational resources for future
evaluations. gen_f can possibly update the sampling after discovering regions
where evaluations of sim_f fail.

* A user has a simulation sim_f that requires calculating multiple expensive
quantities, some of which depend on other quantities. sim_f can observe
intermediate quantities in order to stop related calculations and preempt
future calculations associated with a poor parameter values.
future calculations associated with poor parameter values.

* A user has a simulation sim_f with multiple fidelities, with the
higher-fidelity evaluations requiring more computational resources, and a
Expand All @@ -61,7 +61,7 @@ to support) and plan to have examples of:

* A user wishes to identify multiple local optima for a sim_f. Furthermore,
sensitivity analysis is desired at each identified optimum. libEnsemble can
use the points from the APOSMM gen_f to identify optima and after a point is
use the points from the APOSMM gen_f to identify optima; and after a point is
ruled to be an optimum, a different gen_f can produce a collection of
parameters necessary for sensitivity analysis of sim_f.

Expand Down Expand Up @@ -100,7 +100,7 @@ to/from the manager.):

* gen_worker' [int]: libEnsemble worker that generated this sim_id

* returned' [bool]: Has this a worker completed the evaluation of this unit of
* returned' [bool]: Has this worker completed the evaluation of this unit of
work?

* paused' [bool]: Has this evaluation been paused?
1 change: 0 additions & 1 deletion libensemble/libE.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
Main libEnsemble routine
============================================
"""

from __future__ import division
Expand Down

0 comments on commit 5568fc1

Please sign in to comment.