Skip to content

Commit

Permalink
doco
Browse files Browse the repository at this point in the history
  • Loading branch information
wumpus committed Jul 25, 2020
1 parent 1babece commit 7f1940f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ The `pararamsurvey.map()` function executes the worker function once for each ps
It returns a `MapResults` object, containing the results, performance
statistics, and information about any failures.

Multiple calls to `paramsurvey.map()` can be made, with different lists of psets.

## Worker function limitations

The worker function runs in a different address space and possibly on a different server.
Expand All @@ -60,7 +62,7 @@ The MapResults object has several properties:

* results is a list of dictionaries; 'return' is the return value of the worker function, and 'pset' is the pset.
* failed is a list of failed psets, plus an extra '_exception' key if an exception was raised in the worker
* progress is a MapProgress object containing the details of pset execution: total, started, finished, failures, exceptions
* progress is a MapProgress object with properties containing the details of pset execution: total, started, finished, failures, exceptions
* stats is a PerfStats object containing performance statistics

## Installing
Expand Down

0 comments on commit 7f1940f

Please sign in to comment.