{"id":107,"date":"2015-03-13T13:36:16","date_gmt":"2015-03-13T13:36:16","guid":{"rendered":"https:\/\/blogs.mathworks.com\/developer\/?p=107"},"modified":"2015-03-13T18:28:55","modified_gmt":"2015-03-13T18:28:55","slug":"encouragingly-parallel-epilogue","status":"publish","type":"post","link":"https:\/\/blogs.mathworks.com\/developer\/2015\/03\/13\/encouragingly-parallel-epilogue\/","title":{"rendered":"Encouragingly Parallel (Epilogue)"},"content":{"rendered":"

OK, so remember how we just went through the exercise (not just once<\/a>, but twice<\/a>) of how you can write a function to help parallelize your test runs? Well all of that still applies if you have not yet upgraded to MATLAB R2015a. However, if you do have R2015a you now get this out of the box because the TestRunner now has a runInParallel<\/a> method!<\/p>

One last time, we can create the same representative suite used in the previous posts:<\/p>

import matlab.unittest.TestSuite<\/span>;\r\nclassSuite = TestSuite.fromFile('aClassBasedTest.m'<\/span>);\r\nfcnSuite = TestSuite.fromFile('aFunctionBasedTest.m'<\/span>);\r\nscriptSuite = TestSuite.fromFile('aScriptBasedTest.m'<\/span>);\r\n\r\nsuite = [repmat(classSuite, 1, 50), repmat(fcnSuite, 1, 50), repmat(scriptSuite, 1, 50)];\r\n<\/pre>
Next we create a TestRunner explicitly. To achieve the same style of test output we'll need to create the runner as configured with text output.<\/p>
import matlab.unittest.TestRunner<\/span>;\r\nrunner = TestRunner.withTextOutput;\r\n<\/pre>
Now, just run it in parallel!<\/p>
tic;\r\nrunner.runInParallel(suite)\r\ntoc;\r\n<\/pre>
Split tests into 48 groups and running them on 16 workers.\r\n-----------------\r\nFinished Group 15\r\n-----------------\r\nRunning aFunctionBasedTest\r\n.......\r\nDone aFunctionBasedTest\r\n__________\r\n\r\n\r\n-----------------\r\nFinished Group 14\r\n-----------------\r\nRunning aFunctionBasedTest\r\n........\r\nDone aFunctionBasedTest\r\n__________\r\n\r\n\r\n<SNIP: Output truncated because you get the idea>\r\n\r\n\r\n-----------------\r\nFinished Group 25\r\n-----------------\r\nRunning aFunctionBasedTest\r\n......\r\nDone aFunctionBasedTest\r\n__________\r\n\r\n\r\n-----------------\r\nFinished Group 47\r\n-----------------\r\nRunning aScriptBasedTest\r\n...\r\nDone aScriptBasedTest\r\n__________\r\n\r\n\r\n-----------------\r\nFinished Group 44\r\n-----------------\r\nRunning aScriptBasedTest\r\n....\r\nDone aScriptBasedTest\r\n__________\r\n\r\n\r\n\r\nans = \r\n\r\n  300x1 TestResult array with properties:\r\n\r\n    Name\r\n    Passed\r\n    Failed\r\n    Incomplete\r\n    Duration\r\n\r\nTotals:\r\n   300 Passed, 0 Failed, 0 Incomplete.\r\n   482.5131 seconds testing time.\r\n\r\nElapsed time is 33.861671 seconds.\r\n<\/pre>
The result here is for the most part the same as described in the last post. However, it does apply a slightly different heuristic. I need to get something off my chest here and admit to one more possible problem with the algorithm we have developed in the past couple posts. First note that the example test suite we are using is front-loaded with the most expensive tests. Remember the class-based tests are first in the array and these tests contain the expensive system test (reminder<\/a>). Since we are scheduling these first we are in great shape, but think about the case where all of these expensive tests happen to fall on the end of the array rather than the front. It would be unfortunate to enjoy the benefits of parallelism for most of the tests only to have the last group(s) get stuck with the long pole. If you think about it, the system is resilient to the early groups being the long pole because in that event we can still utilize the full set of workers and crank away at the other groups while the long pole executes. However, if the long pole is the last job to get scheduled we have most of the pool sitting idle at the end of the run while we wait for the last group.<\/p>
For this reason, the runInParallel method of the TestRunner tweaks the scheduling a bit by sending larger chunks of the test suite in the early schedules and by gradually reducing the size as the later groups are scheduled. This means we pay a small price in the best case when the expensive tests are in front but have more consistency and pay a lower price in the worst case when the expensive tests are in back (Note, the runInParallel may use a different scheduling algorithm in future releases in order to allow continued improvements).<\/p>
I'll spare you the experiment, but I ran this test suite in these four scenarios:<\/p>
  1. front heavy using runWithParFeval (the previous blog post's algorithm)<\/li>
  2. back heavy using runWithParFeval<\/li>
  3. front heavy using  runInParallel (R2015a's new method of TestRunner)<\/li>
  4. back heavy using runInParallel<\/li><\/ol><\/div>
    Remember that the suite has some inherent randomness in its runtime. This way we can get a better sense of how arbitrary test suites might behave. However, because of this randomness I ran these scenarios 100 times each to get a better picture of the behavior. I saved these results to a mat file so you can just see the result.<\/p>
    data = load('runData'<\/span>);\r\n<\/pre>
    Comparing runWithParFeval with runInParallel for the front loaded suite we see that there is not much affect in the best case:<\/p>
    clf;\r\nhold on<\/span>;\r\nhistogram(data.runInParallelFrontHeavy, 'BinWidth'<\/span>, 1);\r\nhistogram(data.runWithParFevalFrontHeavy, 'BinWidth'<\/span>, 1);\r\nhold off<\/span>;\r\n\r\n\r\ntitle('R2015a Algorithm vs. Blog Algorithm (Front Heavy Suite)'<\/span>)\r\nlegend('R2015a Algorithm'<\/span>, 'Blog Algorithm'<\/span>)\r\nxlabel('Wallclock Time to run full suite in parallel (seconds)'<\/span>)\r\n<\/pre>\"\" 
    There is a bit more variance in the R2015a algorithm. This is expected. Remember it was really the best case for the blog algorithm to operate on a front heavy suite, but in general we don't have enough information to achieve this in practice (in other words, here we are just getting lucky). However, if we look at the case where the expensive suite elements are include at the end of the suite we can see the R2015a approach does better:<\/p>
    clf;\r\nhold on<\/span>;\r\nhistogram(data.runInParallelBackHeavy, 'BinWidth'<\/span>, 1);\r\nhistogram(data.runWithParFevalBackHeavy, 'BinWidth'<\/span>, 1);\r\nhold off<\/span>;\r\n\r\n\r\ntitle('R2015a Algorithm vs. Blog Algorithm (Back Heavy Suite)'<\/span>)\r\nlegend('R2015a Algorithm'<\/span>, 'Blog Algorithm'<\/span>)\r\nxlabel('Wallclock Time to run full suite in parallel (seconds)'<\/span>)\r\n<\/pre>\"\" 
    There you have it. Adjusting the scheduling of the groups to gradually decrease the group size prevents the run from having too large of a segment scheduled as the last suite. Also, you can't beat the ease of use, all it takes is a simple call to the new runInParallel method of TestRunner. Go check it out and let us know what you think!<\/p>