In this milestone you will provide a report which includes the results of your benchmark and optimization. Your report will include a benchmark speeds on a single core and then a description of what you did to speed up the code and a graph of how much improvements you made over the benchmark. Your final report should include the following:
To help you out your instructor has provided the following template
---- START TEMPLATE ----
By "Your name"
✅ Replace the following with a picture that "defines" your project. This could be software logo, an expected outcome of your project, or a graphical representation of the research area. Again, it is okay to use the picture from the proposal but it is also good to come up with a new unique picture.
Image from: URL REFERENCE
✅ Provide a short paragraph about the software and scientific/engineering domain you cover in your project (research area, sports, economics, etc). Explain why you picked this domain (i.e. what is your motivation). Explain how computation is used in this domain. Give a short description of what you did and a summary of results.
✅ Provide a more detailed description about what you did for this project. Include detailed instructions needed to reprodue the project. These instructions should be detailed enough for a future student to be able to read the report, reproduce your results and pick up where you left off.
✅ Show the results of a baseline experiment on a single core and after optimization. Also include a graph of the results.
✅ Provide the results of a benchmark or scaling study for your project. Make sure you include a description of the hardware that was used and graph the results. Make sure you include detailed descriptions about the hardware that was used. Graphs alone are not sufficient, explain the graphs. Did they meet expectations? Was there any anomalies?
✅ Give another short description of the project and your final results. Use this to talk about what you learned in this project. Include what you found interesting and what would be a next step.
---- END TEMPLATE ----
Now, you just need to create a second directory in your git repository and include your report as an md or ipynb file in the directory along with any additional figures and files needed to reproduce the results. You instructor should already have your git repository and be able to pull in your changes.
Written by Dr. Dirk Colbry, Michigan State University
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.