AI-ML 🧠 is an extremely fast growing environment where millions of new commits 👁️ and thousands of users 👨 👩 are actively engaging on a daily basis 📆. To start a new project 📦, one should generally setup a basic project structure with some default branches and files. GitHub Templates solves this by setting up a template from an existing repositories. The template 🧾 provides minimalistic approach to quickly start a machine learning/artificial intelligence project. ⚙️
For more information 💡 on how to use this template and getting started, check HOWTO. Feel free to use the template as it suits you! 🚀 Would be great, if you 🔗 put a link to my template, if you use this repository!
✍️ Please add/modify the project details on your first project start, as documentation is important and let end user have proper knowledge! 🎯 Start by editing all the sections/paragraphs marked with "✍️".
Client Name: ✍️
client name
(client details/informations
) 🏢
✍️ The template can also be used in creating research papers 📖, white paper 📝, summary report 📜, production level codes 🏆, etc. Necessary explorative results 🎉 can be documented in this section.
Report Link: ✍️
report link
📕
✍️ Information about the used models/engines/agents and their performance can be documented here ✨. An AI/ML trained model can be stored in their respective directories.
Report Link: ✍️
report link
📒
✍️ A config
directory is available to store and configure project with variables, values and/or other informations related to project template.
🔖 Relevant information related to project deployment, planning, production ready code. For more information
🏷️ A CONTRIBUTING.md file, in your open source repository or site, provides potential project contributors with a short guide to how they can help with your project or study group. It is convention to capitalize the word "contributing" as the file title, and to save it as a resource in markdown (hence the extension .md) (source). ✍️ For LICENSE create or add your own file as LICENSE
.
📇 Documentation and/or Resources for your codes, and other mentions can be included in this section! 🔑