(Replace above heading with your project name - think of something cool to describe your work :) )
Describle briefly what your project is about with as few sentences as possible. It is best if you can give a good visual example below your textual description .
- must have proper
requirements.txt
file having even the version information. - must use either conda environments or python virtual environments to code your project.
Give sample outputs - both success and failure cases for the techniquie you have used.
List out the details of your team here.
List all resources you used - starting from most important (the original paper you are trying to implement) to least important and give a brief description of why you used the resource. Use hyperlinks to keep the readme neat.
If you end up publishing a report/arxiv preprint report, provide citation information for others to use/cite your work.