[{"_1":2,"_171":-5,"_172":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_149":150},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_137":-5,"_138":11,"_139":21,"_140":11,"_141":11,"_142":-5,"_143":11,"_144":-5,"_145":146,"_147":91,"_148":-7},"canonicalUrl","https://hub.docker.com/r/jgbustos/ml-rest-api/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","jgbustos","reponame","ml-rest-api","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2021-03-23T09:33:38.764232Z","description","A RESTful API to return predictions from a trained ML model, built with Python 3 and Flask-RESTX","is_private","last_updated","2026-02-27T15:16:48.606974Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.oci.image.index.v1+json","name","pull_count",2500,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# ml_rest_api\n\n[![CircleCI](https://img.shields.io/circleci/build/github/jgbustos/ml_rest_api/master?logo=CircleCI&label=CircleCI%20build)](https://circleci.com/gh/jgbustos/ml_rest_api)\n[![Build and publish Docker image](https://github.com/jgbustos/ml_rest_api/actions/workflows/main.yml/badge.svg)](https://github.com/jgbustos/ml_rest_api/actions/workflows/main.yml)\n[![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=jgbustos_ml_rest_api&metric=alert_status)](https://sonarcloud.io/dashboard?id=jgbustos_ml_rest_api)\n[![Known Vulnerabilities](https://snyk.io/test/github/jgbustos/ml_rest_api/badge.svg)](https://app.snyk.io/org/jgbustos/projects)\n\nA RESTful API to return predictions from a trained ML model, built with Python 3 and Flask-RESTX\n\n## Development set-up instructions\n\nFirst, open a command line interface and clone the GitHub repo in your workspace\n\n```Powershell\nPS > cd $WORKSPACE_PATH$\nPS > git clone https://github.com/jgbustos/ml_rest_api\nPS > cd ml_rest_api\n```\n\nCreate and activate a Python virtual environment, then install the required Python packages using pip\n\n```Powershell\nPS > virtualenv venv\nPS > venv\\scripts\\activate.ps1\n(venv) PS > pip install -r requirements.txt\n```\n\nOnce dependencies are installed, set up the project for development\n\n```Powershell\n(venv) PS > pip install -e .\n```\n\nFinally, run the project:\n\n```Powershell\n(venv) PS > python ml_rest_api\\app.py\n```\n\nOpen the URL with your browser and see the sample Swagger documentation\n\n## Interfaces exposed\n\nSwagger JSON available from URL \n\n### Health\n\nThese two methods are meant to be used as the liveness and readiness probes in a Kubernetes deployment:\n\n* GET returns 200/\"Alive\" if the service is up and running\n* GET returns 200/\"Ready\" or 503/\"Not Ready\" depending on whether the ML model has been correctly initialised or not\n\n### Model\n\n* POST will return a prediction using the ML model. The data_point structure shows the JSON argument that must be supplied, and example values for each of the fields. The service will validate that all the mandatory values are passed. Return values are:\n * 200/Predicted value based on JSON input\n * 400/Validation error if any mandatory parameter is missing or if any wrong data type (e.g. str, int, bool, datetime...) is supplied\n * 500/\"Internal Server Error\" as catch-all exception handler\n * 503/\"Not Ready\" if model is not initialised\n\n## Config settings\n\nConfiguration parameters are contained in the file **ml_rest_api/settings.py**, but they can also be overriden by setting env vars:\n\n```python\nsettings: Dict = {\n # Flask settings\n \"FLASK_SERVER_NAME\": \"localhost:8888\",\n \"FLASK_HOST\": \"0.0.0.0\",\n \"FLASK_PORT\": 8888,\n \"FLASK_DEBUG\": True, # Do not use debug mode in production\n # Flask-RESTX settings\n \"SWAGGER_UI_DOC_EXPANSION\": \"list\",\n \"RESTX_VALIDATE\": True,\n \"RESTX_MASK_SWAGGER\": False,\n \"ERROR_404_HELP\": False,\n \"SWAGGER_UI_JSONEDITOR\": True,\n # Flask-WTF settings\n \"WTF_CSRF_ENABLED\": True,\n # Trained ML/AI model settings\n \"TRAINED_MODEL_MODULE_NAME\": \"ml_trained_model\",\n # Module settings\n \"MULTITHREADED_INIT\": True,\n}\n```\n\n| Parameter | Values | Details |\n| --- | --- | --- |\n| FLASK_SERVER_NAME | e.g.: localhost:8888 | Flask server name |\n| FLASK_HOST | e.g.: 0.0.0.0 | Leave as 0.0.0.0 to avoid virtual host filtering |\n| FLASK_PORT | e.g.: 8888 | Choose whatever suits you, go crazy |\n| FLASK_DEBUG | False/True | Do not use debug mode in production |\n| SWAGGER_UI_DOC_EXPANSION | 'none', 'list' or 'full' | Explained here: |\n| RESTX_VALIDATE | False/True | Explained here: |\n| RESTX_MASK_SWAGGER | False/True | Explained here: |\n| ERROR_404_HELP | False/True | Explained here: |\n| WTF_CSRF_ENABLED | False/True | Enable CSRF protection using [Flask-WTF pip module](https://pypi.org/project/Flask-WTF/)|\n| SWAGGER_UI_JSONEDITOR | False/True | Enable a JSON editor in the Swagger interface |\n| TRAINED_MODEL_MODULE_NAME | e.g.: ml_trained_model | Name of the Python module that initialises the ML model and returns predictions (see [section below](#setting-up-the-model)) |\n| MULTITHREADED_INIT | False/True | Multi-threaded initialisation of the trained model |\n\n## Setting up the model\n\nThe trained ML model is meant to be initialised and invoked to make predictions in the context of a Python unit saved inside the directory **ml_rest_api/ml_trained_model**. The structure of this Python module is explained in [this document](ml_rest_api/ml_trained_model/module_structure.md)\n\n## Build automation\n\nThis project is built into a container image using GitHub Actions and pushed to the Docker Hub at \n\n## Running the Docker container\n\n```Powershell\n> docker run -d -p8888:8888 jgbustos/ml-rest-api:latest\n```\n\nOpen the URL with your browser and see the sample Swagger documentation\n\n## Acknowledgements\n\nThis projects borrows heavily from the work done by [Michał Karzyński](https://twitter.com/postrational):\n\n* \n* \n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",65865428810,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":102,"_50":125,"_126":94,"_127":33,"_128":56,"_57":129,"_130":131,"_132":133,"_134":125,"_135":66,"_136":21},"content_type","creator",2172688,"digest","sha256:5b97ef441736c1cb8c111be0a16ffc013adf642c0bbaf0d287fae092bc4c7d1e","full_size",596124677,"id",142581925,"images",[103,119],{"_104":105,"_95":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":108,"_116":-5,"_117":98,"_63":66,"_118":-5},"architecture","amd64","sha256:0730ad73f159b58cab77b23e9ebc237bb415b4567eabaf14d8991c45af42542d","features","","last_pulled","2026-10-17T19:52:28.86038277Z","last_pushed","2026-02-27T15:16:46.491531462Z","os","linux","os_features","os_version","size","variant",{"_104":120,"_95":121,"_107":108,"_109":122,"_111":123,"_113":120,"_115":108,"_116":-5,"_117":124,"_63":66,"_118":-5},"unknown","sha256:8ecc2c2af482e2b27540ee75d8062623fe467d815150b62c829149e21724830b","2026-09-29T10:52:15.8542815Z","2026-02-27T15:16:46.995985525Z",10259,"2026-02-27T15:16:47.467034Z","last_updater","last_updater_username","media_type","latest","repository",11918420,"tag_last_pulled","2026-10-18T02:45:20.035357213Z","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxRunInCloud","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":151,"_158":159,"_145":169,"_170":11},{"_40":152,"_42":153,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":154,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":155,"_79":11,"_80":157,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":156},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_160":64,"_161":-5,"_162":-5,"_163":164},"count","next","previous","results",[165],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":166,"_50":125,"_126":94,"_127":33,"_128":56,"_57":129,"_130":131,"_132":133,"_134":125,"_135":66,"_136":21},[167,168],{"_104":105,"_95":106,"_107":108,"_109":110,"_111":112,"_113":114,"_115":108,"_116":-5,"_117":98,"_63":66,"_118":-5},{"_104":120,"_95":121,"_107":108,"_109":122,"_111":123,"_113":120,"_115":108,"_116":-5,"_117":124,"_63":66,"_118":-5},[],"canDeleteTags","actionData","errors"]

jgbustos/ml-rest-api

Tags for jgbustos/ml-rest-api