AI/DaESD - Group 14
Project Overview
We are developing a system that takes advantage of machine learning to provide a Machine Learning as a Service experience to users which will allow them to find out more about the food they're eating.
Whether at a friend's house or a fancy restaurant, users will be able to simply take a picture of their meal and our system will automatically detect what is in the frame. It will then provide the user with a list of ingredients, as well as step-by-step instructions on how to recreate it themselves, as well as the relevant nutritional information.
Users will be able to alert the system to any dietary preferences or allergies that they may have, and it will let the user know if a dish they take a photo of contains any of these undesired ingredients.
Collaboration
Other platforms we're using:
- Notion
- Milanote
- Slack
- Google Docs
- Discord
Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
License
For open source projects, say how it is licensed.