update pmapreduce example (#13)

* update pmapreduce example * version bump to v0.8.5
jishnub · Jul 11, 2021 · aa838b3 · aa838b3 · jishnub · Jul 11, 2021
1 parent e14043a
commit aa838b3
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "ParallelUtilities"
 uuid = "fad6cfc8-4f83-11e9-06cc-151124046ad0"
 authors = ["Jishnu Bhattacharya"]
-version = "0.8.4"
+version = "0.8.5"
 
 [deps]
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -3,4 +3,4 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 ParallelUtilities = "fad6cfc8-4f83-11e9-06cc-151124046ad0"
 
 [compat]
-Documenter = "0.25"
+Documenter = "0.27"
diff --git a/docs/src/examples/pmapreduce.md b/docs/src/examples/pmapreduce.md
@@ -42,6 +42,26 @@ end
 
 We compare the performance of the serial and parallel evaluations using 20 cores on one node:
 
+We define a caller function first
+
+```julia
+function compare_with_serial()
+    # precompile
+    main_mapreduce(0)
+    main_pmapreduce(0)
+
+    # time
+    println("Tesing serial")
+    A = @time main_mapreduce(5e-6)
+    println("Tesing parallel")
+    B = @time main_pmapreduce(5e-6)
+
+    # check results
+    println("Results match : ", A == B)
+end
+```
+
+We run this caller on the cluster:
 ```julia
 julia> compare_with_serial()
 Tesing serial