Project Submission Template

📁 Repository Structure

Below is an example repository structure to help you to navigate through the various segments and files for your chosen project.

• /project_name/
  • src/
    • notebooks/
      • notebook1.ipynb
      • notebook2.ipynb
      • ...
    • scripts/
      • script1.py
      • script2.py
      • ...
  • data/
    • raw/
    • processed/
    • ...
  • docs/
    • report.pdf
    • presentation.pptx
    • ...
  • results/
    • figures/
    • tables/
  • tests/
    • test_script1.py
    • ...
  • .gitignore
  • LICENSE
  • README.md

Explanation of the structure:

• src/: Contains all the source code files.
• data/: Contains all the data used in the project.
• docs/: Contains documentation like reports and presentations.
• results/: Contains the outputs of your analyses.
• tests/: Contains testing scripts.
• .gitignore: Lists files/directories to ignore.
• LICENSE: Contains the license information.
• README.md: This file, containing information about the project.

Project Report Format

Project Title

Write the title of your chosen project here.

Abstract

Short summary of the project, its context, and its objectives. In 3-4 sentences, explain the high-level purpose and what you hope to achieve or uncover.

Introduction

Background Provide a detailed background of the project. This might include the problem you’re addressing, why it’s important, and what the desired outcome is.

Objectives Enumerate the specific goals and targets you wish to achieve with this project. Be as clear and concise as possible.

Methods

Data Acquisition For those that choose their own project, detail where and how you obtained your data, including a brief description of the data.

Data Analysis Outline the methods and tools you used to analyze the data. This could include statistical methods, machine learning models, and data visualization techniques.

Tools Used List and briefly describe the tools or technology stack used (e.g., programming languages, libraries, frameworks).

Results

Present the key findings of your project. Ensure to include visual representations of your results, like plots, graphs, or tables, and provide interpretations of these findings.

Findings [Briefly summarize the key findings of your analysis.]

Visualizations [Insert images or use markdown to create tables. Make sure that visuals are clearly labeled and have appropriate captions.]

Conclusion

Summarize the main points of your project, relating them back to your objectives. Discuss the implications of your findings and any limitations in your study. Provide any future directions for this work.

License

For those that choose their own project, provide license details of your dataset e.g., this data is licensed under the [The License] - see the LICENSE.md file for details.

Acknowledgments

• Mention any individuals or organizations that helped you in executing the project.
• Reference any research papers, data, or other resources that were crucial for the completion of your project. Do not forget to provide ChatGPT prompts you used for the project.