Skip to content

report_structure.md

Latest commit

 

History

History
91 lines (86 loc) · 4.28 KB

report_structure.md

File metadata and controls

91 lines (86 loc) · 4.28 KB

======================== Report contents - Sample - Incorporate as applicable --------------- Project Title

  • Have a good project title that mentions the problem being solved
Abstract
Executive Summary
Introduction
Definition of Terms / Abbreviations
Scope of project
  • What is the goal of the project
  • Explain who can use your project for what purpose
  • Explain why the current solutions are not sufficient and there is a need for this project
  • Who are stakeholders who will value the result / output provided
  • Inscope and Out of scope
  • Inputs (Mandatory, Optional) and Output
  • How to interpret the Output Results
  • Which stakeholder can use the result for what
  • Explanation of Input Fields

Completeness Criteria Best in Class Target Success Criteria Measurement Model

  • From Kaggle / Your Org / Literature Survey / Others ...
Uniqueness of the project
  • New to the world
  • New to the Company
  • New to my team
  • New to me
Business / economic value of the project (if project is successful)
  • Which Stakeholder
  • What Value - Please quantify the value if possible
Literature Survey
  • Analysis of Literature is needed and not just a list
  • Explain what you inferred from which paper/literature
Data Set
  • Source URL
  • data set - Public / Proprietary
  • Data Structure
  • Data preprocessing including data cleaning
  • Best results on the data set

    • Model Development Techniques / Approaches chosen and why Alternate options considered (based on experimental results or literature survey) Results Achieved mathematical results that are aligned with the goal Algorithmic Tradeof based on economic value Analysis of results achieved Which algorithm / model gave what results and why Interpret the results achieved Explain if you fell short / met / exceeded your targets and the reasons Next Steps/Future work Conclusions References

    Appendix

    • Code (if it can be shared)
    • All code in appendix, crucial algorithms can be in the main report
    • Please provide full working code
    • Link to dataset used for the project
    • Link to github
    • Link to colab notebook

    Graphs/Charts/tables

  • Don't just dump the charts/tables - Interpret the charts/tables

    • Notes

    • Less profit but zero loss
    • beat h2o model
    • Knapsack problem for grouping of stocks using neural network pytorch