added benchmark plot

twhuang-utah · twhuang-utah · commit 03fa8221d51d · 2020-01-13T14:24:33.000-07:00
diff --git a/benchmarks/benchmarks.md b/benchmarks/benchmarks.md
@@ -27,16 +27,13 @@ Currently, we provide the following applications:
   + [Matrix Multiplication](./matrix_multiplication): multiplies two matrices
   + [MNIST](./mnist): trains a neural network-based image classfier on the MNIST dataset
 
-We have provided a python wrapper [regression.py](./regression.py) to help
+We have provided a python wrapper [benchmarks.py](./benchmarks.py) to help
 configure the benchmark of each application,
 including thread count, rounds to average, tasking methods, and plot.
 
 ```bash
-usage: regression.py [-h] -b
-                     {wavefront,graph_traversal,binary_tree,linear_chain,matrix_multiplication,mnist}
-                     [{wavefront,graph_traversal,binary_tree,linear_chain,matrix_multiplication,mnist} ...]
-                     [-m {tf,tbb,omp} [{tf,tbb,omp} ...]] -t THREADS
-                     [THREADS ...] [-r NUM_ROUNDS] [-p PLOT]
+~$ chmod 755 benchmarks.py    # change the permission to execute
+~$ ./benchmarks.py -h         # show the help message
 ```
 
 For example, the following command benchmarks 
@@ -47,13 +44,20 @@ with data collected in an average of ten runs.
 Results are illustrated in a plot and saved to `result.png`.
 
 ```bash
-~$ python regression.py -m tf omp tbb \ 
-                        -b graph_traversal wavefront linear_chain \
-                        -t 1 4 8 16 \
-                        -r 10 \
-                        -plot true
+~$ ./benchmarks.py -m tf omp tbb \ 
+                   -b graph_traversal wavefront linear_chain \
+                   -t 1 4 8 16 \
+                   -r 10 \
+                   -p true \
+                   -o result.png
 ```
 
+When the program completes, you will see a combined plot of all specified benchmarsk.
+The x-axis represents the growth of problem size and the y-axis denotes the runtime
+in millisecond.
+
+![](../image/benchmarks.svg)
+
 
 ---
 
diff --git a/benchmarks/benchmarks.py b/benchmarks/benchmarks.py
@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 import os
 import subprocess
 import sys
@@ -97,6 +97,13 @@ def main():
     help='show the plot or not',
     default=False
   )
+
+  parser.add_argument(
+    '-o', '--output',
+    type=str,
+    help='file name to save the plot result',
+    default="result.png"
+  )
   
   # parse the arguments
   args = parser.parse_args()
@@ -132,14 +139,24 @@ def main():
         #  horizontalalignment='center',
         #  transform=ax.transAxes
         #)
-        plot.plot(X, Y, label=method)
+        if method == 'tf':
+          marker = ''
+          color  = 'b'
+        elif method == 'omp':
+          marker = '+'
+          color  = 'g'
+        else:
+          marker = '.'
+          color  = 'r'
+
+        plot.plot(X, Y, label=method, marker=marker, color=color)
         plot.legend()
         print(X)
         print(Y)
       plot_index = plot_index + 1
 
   plot.tight_layout()
-  plot.savefig('result.png')
+  plot.savefig(args.output)
 
   if args.plot:
     plot.show()
diff --git a/benchmarks/mnist/dnn.hpp b/benchmarks/mnist/dnn.hpp
@@ -175,7 +175,7 @@ struct MNIST {
   MNIST() {
     std::string path = std::experimental::filesystem::current_path();                                                                  
     path = path.substr(0, path.rfind("cpp-taskflow") + 12);
-    path += "/benchmark/mnist/";
+    path += "/benchmarks/mnist/";
     
     images = read_mnist_image(path + "./train-images.data");
     labels = read_mnist_label(path + "./train-labels.data");
diff --git a/benchmarks/mnist/seq.cpp b/benchmarks/mnist/seq.cpp
@@ -1,6 +1,6 @@
 #include "dnn.hpp" 
 
-void run_sequential(MNIST& D, unsigned num_threads) {
+void run_sequential(MNIST& D, unsigned) {
 
   const auto iter_num = D.images.rows()/D.batch_size;
 
diff --git a/image/benchmarks.svg b/image/benchmarks.svg
