Model Reports (Template)

This file should be created for each model created in the project. If you are logging results to a processed (gold) dataset, also update the Datasets tab in the Data Dictionary and complete a Data Report.

The purpose of this document is to give you space to note down all the key information about the features processed in your project, such that it can be easily accessed and understood by colleagues or customers following project close. The structure of this template contains a number of salient points to consider in relation to the data along with prompts to help you complete it quickly.

Key points

• The modelling process is iterative, and should typically start with building and scoring a baseline model, with subsequent developments aiming to improve on this baseline, until arriving at the optimum which can be used in production. The report templates are split into three instances to reflect this process - Baseline, Development, and Production. 

• Reporting on the models built throughout a project can be laborious, but it is essential for maintaining its relevant and allowing a future colleague, customer, or even yourself to pick it up efficiently in the future

• This template aims to distill the key points and make the reporting process clearer and easier/more efficient to conduct during project delivery

• Answering every prompt is not necessary, but you should consider each one and if they are relevant to your project/proposal

• Similarly, the list of prompts is not necessarily exhaustive, add more detail if and when you feel it is appropriate