Project Card
Project Name
The purpose of Project Cards is two folds. During development, it helps the developer think about the problem in a structured way w.r. t framing the problem, assessing the business value, viability, and many other aspects.
It can also serve as a document giving a high level overview of the system developed and deployed. With proper versioning, one can also see the evolution of the problem. It is meant to be a high level document and as details emerge, documents such Model Cards and Data Cards can be linked.
The following are the different sections of the Project Cards.
This notebook uses tags to render the output. Each call has a tag. There are three tags: objective, instruction, response. The cell with objective tag explains the purpose of this project card. Cells with instruction tag, are the key sections of the document that must be filled. A cell following immediately will have a tag response. You only fill the cell with response tag. DO NOT MODIFY the cells with tag instruction. Of course, feel free to modify to your needs. Once the format is agreed upon, stick to it.
Business View
Background
Provide succinct background to the problem so that the reader can empathize with the problem.
your response
Problem
What is the problem being solved?
your response
Customer
Who it is for? Is that a user or a beneficiary? What is the problem being solved? Who it is for?
your response
Value Proposition
Why it needs to be solved?
your response
Product
How does the solution look like? It is more of the experience, rather how it will be developed.
your response
Objectives
Breakdown the product into key (business) objectives that need to be delivered? SMART Goals is useful to frame
your response
Risks & Challenges
What are the challenges one can face and ways to overcome?
your response
ML View
Task
What type of prediction problem is this? Link Model Card when sufficient details become available (start small but early)
your response
Metrics
How will the solution be evaluated - What are the ML metrics? What are the business metrics? Link Model Card when sufficient details become available (start small but early)
your response
Evaluation
How will the solution be evaluated (process)? Link Model Card when sufficient details become available (start small but early)
your response
Data
What type of data is needed? How will it be collected - for training and for continuous improvement? Link Data Cards when sufficient details become available (start small but early)
your response
Plan/ Roadmap
Provide problem break-up, tentative timelines and deliverables? Use PACT format if SMART is not suitable.
your response
Continuous Improvement
How will the system/model will improve? Provide a plan and means.
your response
Resources
What resources are needed? Estimate the cost!
your response
Human Resources
what type of team and strength needed?
your response
Compute Resources
What type of compute resources needed to train and serve?
your response