CSE 163, Summer 2021: Final Project: Deliverables

Overview

Due Thursday, August 19 at 23:59 (AoE).

  • A 5-6 page written document as a PDF
  • All code and test files, including documentation

Due Friday, August 20 at 23:59 (AoE).

  • A 3-5 minute video presentation

All submissions will use Canvas. Due to grading restrictions, we may not be able to accept late submissions or resubmissions.

Report

Submit a roughly 4–6 page report documenting your findings. Annotate and explain how your visualizations were produced and contribute to the narrative or analysis. You should update any of the previous sections based on feedback from the proposal.

Outline your report with at least the following sections:

  1. Title and author(s)

  2. Summary of questions and results.

    Repeat your research questions in a numbered list. After each research question, clearly state the answer you determined. Don't give any details or justifications yet — just a brief summary of the answer.

  3. Motivation

    Same as Proposal, updated according to feedback

  4. Dataset

    Same as Proposal, updated according to feedback

  5. Method

    Same as Proposal, updated with any changes made during implementation

  6. Results
    • Present and discuss your research results. Treat each of your research questions separately. Focus in particular on the results that are most interesting, surprising, or important. Discuss the consequences or implications.
    • Interpret the results. If the answers are unexpected, try to offer an explanation. A good report not only presents the results, but provides an argument or interpretation based on the data analysis
    • Include any visualizations you have made. In general, these should be generated programmatically as part of your project code. If you plotted by hand, explain why it was not possible to create the plot you wanted in Python
  7. Challenge Goals

    Same as Proposal, updated with any changes made during implementation. If the challenge goals were scaled back or expanded, explain why the task turned out differently than initially estimated.

  8. Work Plan Evaluation

    Evaluate your proposed work plan. How accurate were your proposed work plan estimates? Why were your estimates close to reality or far from reality?

  9. Testing.

    Describe how you tested your code. Did you use assert statements? Smaller data files? Submit your tests and any testing files along with your code. Make sure you tell us why we should trust your results!

  10. Collaboration

    State the other people and resources that you consulted during the project aside from the course staff and team members.

Submit the report as a document to Canvas.

Code

Your code should follow the following requirements.

  • Submit one or more Python scripts or Jupyter Notebooks providing implementation code and testing code. Follow the code quality guidelines. Code documentation should assume the programmer has already read your report, so you don’t need to repeat details from the report though it also doesn’t hurt to restate important ideas as they come up in the code. Most projects that meet two challenge goals will involve about 120 lines of code, inclusive of whitespace and documentation.
  • Submit documentation on how to run the code and reproduce the results. Either include the instructions at the top of the script/notebook or write a separate README.md file. Explain how to setup the project, install libraries, download the datasets, and run the Python code in enough detail for another student to reproduce the results.
  • Make sure that your code follows the guidelines from the Code Quality Guide. Your code must pass flake8, if you are submitting a Python script.

If your project code and documentation is all in an Ed Workspace, submitting the code is easy: just copy-paste the link in the Canvas submission. Otherwise, archive all your code in a zip file and upload the zip to Canvas.

Presentation

Submit a 3-5 minute video presenting a slide deck (or other tool) highlighting the project’s big ideas. Your slide deck should convey the following big ideas in no more than 10 slides.

  • Title and authors
  • Motivation
  • Research questions
  • Methods
  • Results, visualizations, and key takeaways
  • Future work, or future directions for this project

Importantly, the video should be understandable to someone who has not read your report. All team members must present some meaningful aspect of the project during the video. Zoom is the easiest way to record the video with screenshare and team members. Since this is such a short video, don’t bother editing and just re-take the video. This might take a 5 or more takes—think of each take as practice for a live presentation. If team members are not able to meet synchronously, you can also edit-together shorts from each team member.