- Your idea in a nutshell: Name your project and prepare to describe it briefly.
- Background: What is the problem your idea will solve? How common or frequent is this problem? What is your personal motivation? Why is this topic important or interesting?
- Data and AI techniques: What data sources does your project depend on? Almost all AI solutions depend on some data. The availability and quality of the data are essential. Which AI techniques do you think will be helpful? Depending on whether you've been doing the programming exercises or not, you may choose to include a concrete demo implemented by coding, using some actual data!
- How is it used: What is the context in which your solution is used, and by whom? Who are the people affected by it? It’s important to appreciate the viewpoints of all those affected.
- Challenges: What does your project not solve? It’s important to understand that any technological solution will have its limitations.
- What next: How could your project grow and become something even more?
- Acknowledgments: If you’re using open source code or documents in your project, make sure you give credit to the creators. Mention your sources of inspiration, too.
Final project for the Building AI course
Describe briefly in 2-3 sentences what your project is about. About 250 characters is a nice length!
Which problems does your idea solve? How common or frequent is this problem? What is your personal motivation? Why is this topic important or interesting?
This is how you make a list, if you need one:
- problem 1
- problem 2
- etc.
Describe the process of using the solution. In what kind situations is the solution needed (environment, time, etc.)? Who are the users, what kinds of needs should be taken into account?
Images will make your README look nice!
Once you upload an image to your repository, you can link link to it like this (replace the URL with file path, if you've uploaded an image to Github.)
If you need to resize images, you have to use an HTML tag, like this:
This is how you create code examples:
def main():
countries = ['Denmark', 'Finland', 'Iceland', 'Norway', 'Sweden']
pop = [5615000, 5439000, 324000, 5080000, 9609000] # not actually needed in this exercise...
fishers = [1891, 2652, 3800, 11611, 1757]
totPop = sum(pop)
totFish = sum(fishers)
# write your solution here
for i in range(len(countries)):
print("%s %.2f%%" % (countries[i], 100.0)) # current just prints 100%
main()
Where does your data come from? Do you collect it yourself or do you use data collected by someone else? If you need to use links, here's an example: Twitter API
Syntax | Description |
---|---|
Header | Title |
Paragraph | Text |
What does your project not solve? Which limitations and ethical considerations should be taken into account when deploying a solution like this?
How could your project grow and become something even more? What kind of skills, what kind of assistance would you need to move on?
- list here the sources of inspiration
- do not use code, images, data etc. from others without permission
- when you have permission to use other people's materials, always mention the original creator and the open source / Creative Commons licence they've used
For example: Sleeping Cat on Her Back by Umberto Salvagnin / CC BY 2.0 - etc