Is your feature request related to a problem? Please describe.
At the moment there is nothing in the README to help someone use or understand the models. They would have to go straight to the code to get a good understanding of the project.
Describe the solution you'd like
There needs to be a bit of information about the problem this project is trying to solve, the way it has gone about doing it, and the final model and its training and testing performance. It would also be good to add some information about usage and next steps/plans for the project.
Describe alternatives you've considered
Would a model card be an alternative? Or a helpful addition?
Is your feature request related to a problem? Please describe. At the moment there is nothing in the README to help someone use or understand the models. They would have to go straight to the code to get a good understanding of the project.
Describe the solution you'd like There needs to be a bit of information about the problem this project is trying to solve, the way it has gone about doing it, and the final model and its training and testing performance. It would also be good to add some information about usage and next steps/plans for the project.
Describe alternatives you've considered Would a model card be an alternative? Or a helpful addition?