Skip to content

Latest commit

 

History

History
219 lines (169 loc) · 6.51 KB

README.md

File metadata and controls

219 lines (169 loc) · 6.51 KB
Raw

Forecasting von Customs Duties - Bachelor Thesis Stefan Eißler

Installation

pip install -r requirements.txt

Mit SSL Error WSL Ubuntu

pip install --trusted-host pypi.org --trusted-host=files.pythonhosted.org -r requirements.txt

oder

pip install --trusted-host=pypi.org --trusted-host=files.pythonhosted.org [dependency]

Projektsturktur

  1. Data - Ablage von Beispieldaten
  • evaluation - Evaluationsmatrix nach "/evaluation" Route
  • predicition - Ergebnisse zum test nach "/evaluation" Route
  • raw - Datensätze nach AEB Format
  1. models - Speichern der trainierten Modelle nach "/train" Route
  2. notebooks - Datenuntersuchung mittels Jupyter Notebooks
  3. src/app - root der App (Flask Server)

Projekt Architektur

Die beste Performance auf Zeitreihendaten der AEB-Zolldaten hatten Forest-Modelle. Daher werden diese in den "/train" und "/forecast" Routen eingesetzt. Über die API können diese nun trainiert und Prognosen erstellt werden. Beim Aufrufen der train-Methode wird ein Modell trainiert und mit Pickle im "/models" Ordner abgelegt. Beim Forecasting wird dieses aufgerufen und eine Prognose ab dem aktuellen Tag im angegebenen Horizont erstellt. Wenn ein Modell mit derselben Kunden-ID erneut trainiert wird, überschreibt die ModelIO-Klasse das alte Modell. Über die "/evaluate" Route können Modelle getestet und verglichen werden. Es wird ein Train-Test-Split mit einem Forecasting-Horizont von 90 Tagen durchgeführt und mit einer statischen evaluate-Methode des Evaluators ausgewertet. Durch das erweiterbare BaseModel-Objekt in "src/app/models.py" können neue Modelle programmiert und eingesetzt werden. Durch die "src/app/modelio.py" werden trainierte Modelle im "/models" Ordner abgelegt. Auch die übergeordnete ModelIO-Klasse ist abstrakt und erweiterbar durch weitere Ablagemöglichkeiten in der Cloud oder in einer Datenbank. In "src/app/data_preprocessing.py" werden Hilfsmethoden für die API definiert. Die API mit dem Flask Server befindet sich in "src/app/api.py".

Run Application

python3 src/app/api.py

API Beschreibung

Training des Models

Trainiert ein Model und legt es mit dem Kundenname ab.

POST /train

curl -i -H 'Accept: application/json' http://localhost:5000/train

Request body

{
    "customerid": "example",    
    "data":[
        {
            "Abgabenbescheid" : {
            "Gesamtabgabe" : 305.33,
            "Datum Erstellung" : "2014-11-13"
            }
        }
        ,{
            "Abgabenbescheid" : {
                "Gesamtabgabe" : 0,
                "Datum Erstellung" : "2016-01-29"
            }
        }
    ]
}

customerid

  • Kundenname

data

  • Daten im AEB-Forecast-Format

Response

HTTP/1.1 200 OK
Server: Werkzeug/3.0.1 Python/3.10.12
Date: Mon, 08 Apr 2024 13:18:33 GMT
Content-Type: application/json
Content-Length: 333
Connection: close

[{
    "message": "ets for example trained and saved successfully",
    "success": true,
}]

Forecast erstellen

Erstellt einen Forecast für einen Kunden über einen angegebenen Horizont.

Request

POST /forecast

curl -i -H 'Accept: application/json' http://localhost:5000/forecast

Request body

{
    "customerid": "example",
    "horizon": 60
}

customerid

  • Kundenname

horizon

  • Horizont des Forecast in Tagen

Response

HTTP/1.1 200 OK
Server: Werkzeug/3.0.1 Python/3.10.12
Date: Mon, 08 Apr 2024 13:45:46 GMT
Content-Type: application/json
Content-Length: 847
Connection: close

{
    "data": {
        "2024-04-09": 23.424447619047598,
        "2024-04-10": 22.49140952380951,
        "2024-04-11": 22.49140952380951,
        "2024-04-12": 21.558371428571416,
        "2024-04-13": 19.725590476190465,
        "2024-04-14": 21.275561904761897,
        "2024-04-15": 10.93853333333333,
        "2024-04-16": 9.763857142857145,
        "2024-04-17": 12.773714285714286,
        "2024-04-18": 12.828152380952382,
        "2024-04-19": 22.335238095238093,
        "2024-04-20": 16.00308571428571,
        "2024-04-21": 16.00308571428571,
        "2024-04-22": 19.06738095238095,
        "2024-04-23": 83.14954285714285,
        "2024-04-24": 218.10132380952388,
        "2024-04-25": 218.10132380952388,
        "2024-04-26": 205.6808285714286,
        "2024-04-27": 202.61653333333336,
        "2024-04-28": 202.61653333333336
    },
    "message": "forest for example predicted successfully",
    "success": true
}

Evaluationsmatrix erstellen

Trainiert ein Model mit einem train-test-split und gibt die Ergebnisse der Evaluation aus. Außerdem speichert es die Ergebnisse der Kennzahlen in "data/evaluation" und die Test und Forgecastete Zeitreihe in "data/prediction"

POST /evaluate

curl -i -H 'Accept: application/json' http://localhost:5000/evaluate

Request body

{
    "customerid": "example",   
    "modeltype": "forest" 
    "data":[
        {
            "Abgabenbescheid" : {
            "Gesamtabgabe" : 305.33,
            "Datum Erstellung" : "2014-11-13"
            }
        }
        ,{
            "Abgabenbescheid" : {
                "Gesamtabgabe" : 0,
                "Datum Erstellung" : "2016-01-29"
            }
        }
    ]
}

modeltype

  • arima
  • ets
  • forest
  • xgboost
  • rnn
  • ltsm

customerid

  • Kundenname

data

  • Daten im AEB-Forecast-Format

Response

HTTP/1.1 200 OK
Server: Werkzeug/3.0.1 Python/3.10.12
Date: Mon, 08 Apr 2024 13:18:33 GMT
Content-Type: application/json
Content-Length: 366
Connection: close

{
    "message": "Evaluation with lstm for customer_d generated successfully",
    "success": true,
    "validation_matrix": {
        "Forecast Bias (%)": -15.236810684801814,
        "Mean Absolute Error": 11132.229894097238,
        "Mean Absolute Percentage Error (%)": 26.628031891865163,
        "Mean Absolute Scaled Error": 2.811757115144287,
        "r2": -0.29637923057041315
    }
}

Main Libaries