birbnetes/svm-prefilter-service
birbnetes/svm-prefilter-service
4
0
Fork 0
Code Pull Requests Releases Activity

Added readme

Browse Source
This commit is contained in:
Pünkösd Marcell 2022-01-31 23:05:34 +01:00
parent 1f24a2c09e
commit dbb266c744
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md Normal file
View File

@ -0,0 +1,20 @@
# SVM Prefilter Service
The purpose of this service is to bring the SVM Ai from the Birbox to the Edge.
This service has the same interface as the input service. Upon receiving a request it enqueues it, runst the Ai prediction, if a bird chirp sound is predicted then this service forwards the request to the original input service in the cloud.
This service needs to communicate with the input service and the model service. And optionally it can report its queue length to birb-latency-collector.
## Configuration:
This service can be configured trough envvars:
- **SECRET_KEY**: Flask secret key. See https://flask.palletsprojects.com/en/2.0.x/config/#SECRET_KEY
- **SENTRY_DSN**: Sentry DSN. See https://docs.sentry.io/product/sentry-basics/dsn-explainer/
- **RELEASE_ID**: Release ID for Sentry.
- **RELEASEMODE**: Release mode for sentry.
- **MODEL_INFO_URL**: URL of the model service endpoint when the information about the used SVM model can be fetched (e.g.: `https://birb.k8s.kmlabz.com/model/svm/$default`)
- **INPUT_SERVICE_URL**: URL of the real input service (e.g.: `https://birb.k8s.kmlabz.com/input`)
- **REPORT_URL**: URL of the birb-latency-collector service to report queue length to (e.g.: `http://192.168.110.100:30420/report/site`)
- **REPORT_INTERVAL**: Seconds between reporting queue length to birb-latency-collector.