Final Project Report, Code and Demo Environment

  • Each project group must submit the following materials to the instructor via email by Dec 13.

    Material

    Requirements

    Project Report

    • Describe the problem and goals of the project.

    • Describe the attacks, defenses, tools, or systems developed.

    • Explain the technical approach and implementation.

    • Present and analyze the main results.

    • Discuss limitations and unsuccessful approaches, if any.

    • Describe the contributions of each project member.

    • Include the URLs of the code repository.

    Code Repository

    • Include all source code developed for the project.

    • Include scripts, configuration files, and other files required to reproduce the results.

    • Provide a README with step-by-step instructions for downloading the demo environment, building, configuring, and running the project to reproduce the project demo and results.

    • Clearly identify any external code, tools, datasets, or other dependencies used.

    Demo Environment

    • Provide an environment that can be used to reproduce the project demo and results.

    • Examples include a virtual machine image (e.g. VirtualBox) or Docker container.

    • Include all required software, dependencies, and configuration whenever possible.

  • The submitted materials should allow the instructor to reproduce the main project demo and results presented by the group.

  • The project report should be self-contained. A reader should be able to understand the problem, approach, implementation, and results without referring to the presentation slides.

  • The code repository should be organized and documented sufficiently for the instructor to understand and run the implementation.

  • The demo environment should be tested before submission. Make sure that the provided instructions work from a clean environment.

  • If some parts of the project require hardware or other resources that cannot be included in the submitted environment, clearly document the required resources and provide an alternative way to reproduce or verify the results whenever possible.

  • Do not include passwords, private keys, API credentials, or other sensitive information in the submitted materials.

  • Make sure to write the submission email in the following format:

    Subject: [cs6301.002-f26] final project submission

* Group Member 1: Name (NetID)
* Group Member 2: Name (NetID)

# IMPORTANT: Make sure to attach the project report file in PDF!

  • The final project submission will be evaluated on:

    1. The quality and technical depth of the final project.

    2. The quality and completeness of the project report.

    3. The quality, organization, and documentation of the submitted code.

    4. The reproducibility of the project demo and results using the submitted environment and instructions.

    5. The completeness of the submitted project materials.