We use this to guarantee the same structure for all projects. Projects will be then uploaded to our project page and there these information will be displayed. So you can check at any time the project page to have an idea about how that would look like.
Your objective is to train a neural network to estimate the sales from past data. You can choose the form of the input and the output, usually the input is the data for a specific day (or more than one day) and the output is the sales for a specific day (or more than one).
More information on the data can be found in the data folder. We have 2 datasets, which they contain similar data, the first one is smaller and maybe a bit simpler (and alreay used), the second may require some small pre-processing and is a bit larger and contains more location (so more challenging). In each folder there is a presentation or a readme file to explain.
It is advisable to start using FFNN without special features and find the optimal architecture configuration. Later you can use LSTM, CNN (1D) or whatever you like to try to improve the result.
To compare your results with the ones from previous groups, please use the Mean Absolute Percentage Error (Wikipedia - Tensorflow Metric)
Approximately you should reach an error below 20% on the prediction for a single day in the dataset1. Best results from the last semesters arrived around 15-16% error.
Once you are done, you could indicate the error you got (MAPE) and which architecture you used and it will be added here in a sort of ranking.
For this project in particular, there were already 2 implementations:
- SoSe 21, Group 1, Johannes Dupont, Pavan Jethvani, Osama Alrabayah, Jannik Knopp
- SoSe 21, Group 2, Amelie Schmuecker, Samira Ferssioui, Niko Schmidt, Christopher Hansen
- if you are reading on Github, clone or download this repository to your computer.
- rename the folder
project_template_folder
to the name of your project (please avoid spaces in the name of the folder). - complete the
INFO.md
file with title, description, students name, course, semester and whatever is asked there - upload the required documents:
- the code (one or more notebooks or python code) in the
code
folder. Inside the folder there is already a notebook with some informations. Please make sure to check it and start from there. - a picture of that represent your project in the
preview
folder. It will be used as a preview for the online visualization. It should have width larger than its height (something like 500x280 may work good), but it's not absolutely necessary. It will be centered anyway. Higher resolution will be down-scaled, so do not upload images higher than 720 pixels. - other resources you may need in the
resources
folder - please do not upload the dataset you used unless there are special reasons.
- the code (one or more notebooks or python code) in the
- (Optional) rename
INFO.md
asREADME.md
. This way when people open your repository page, they will see the information about your project (and not the instructions to upload it). TheREADME.md
file is automatically showed from github. - compress the whole folder as a
.zip
file and check the size. Please do not upload files larger than10Mb
. If you have special reason to do so, please let us know before you upload. - upload the
.zip
file in your course's online page. If you do not know where, ask your teacher.