|
| 1 | + |
| 2 | +# Create a REST API for any ML model, in seconds. |
| 3 | + |
| 4 | +## Guide |
| 5 | + |
| 6 | +- What is this? |
| 7 | +- Installation |
| 8 | +- Usage |
| 9 | +- Features |
| 10 | +- How's this different from Tensorflow Serving? |
| 11 | +- Supported ML frameworks |
| 12 | +- Contributions |
| 13 | + |
| 14 | +### What is this? |
| 15 | +Olympus is basically a command-line tool that you can use to deploy any pre-trained ML/deep learning model as a REST api, in seconds. |
| 16 | + |
| 17 | +I built this tool after becoming tired of manually creating REST apis for a bunch of deep learning models that I was playing with, usually for using them in a web or mobile app. |
| 18 | + |
| 19 | +So if you'd like to quickly deploy that cool deep learning model that you've been tinkering on lately as a REST API, then this tool is for you. |
| 20 | + |
| 21 | +### Installation |
| 22 | +`pip install olympus` |
| 23 | + |
| 24 | +### Usage |
| 25 | +TODO (Add GIF HERE!!) |
| 26 | + |
| 27 | +### Features |
| 28 | +- Deploys any model with pretrained weights as a REST api, instantly. |
| 29 | +- Supports saving and deleting any model you deploy, for quick model management. |
| 30 | +- You can activate/deactivate any ML model you've deployed to enable/disable its specific API endpoint |
| 31 | + |
| 32 | +### How's this different from Tensorflow Serving? |
| 33 | +As you probably already know, Tensorflow Serving is an open-source, production-grade model deployment tool for deploying Tensorflow models to the cloud. |
| 34 | + |
| 35 | +One of the key differences between Olympus and TF Serving is that, while TF Serving is optimized for the production environment, Olympus is currently more geared towards the development phase. |
| 36 | + |
| 37 | +For example, when you're building an ML model that needs to be deployed as a REST API so that it can be accessed from a mobile app you're developing, you could use Olympus to easily manage and deploy your models so that you don't have to setup servers manually. |
| 38 | + |
| 39 | +However, when going to production, you would want to properly export your model and use a tool like TF Serving, which is built from the bottom-up for serving models at scale. |
| 40 | + |
| 41 | +### Supported ML Frameworks |
| 42 | + |
| 43 | +Ideally, we're building Olympus to deploy <i><b>any</b></i> ML model as a REST Api. |
| 44 | + |
| 45 | +For now, we support models built with the frameworks listed below. |
| 46 | + |
| 47 | +Don't see your framework? Don't worry! We're constantly adding integrations for more ML frameworks, and you can even extend Olympus with custom adapters for deploying models built with an unsupported framework (more docs on this soon!). |
| 48 | + |
| 49 | +- Keras |
| 50 | + |
| 51 | +### Contributions |
| 52 | +Love this project and got an idea for making it better? |
| 53 | +We'd love your help! |
| 54 | + |
| 55 | +Just send over a PR and we'll go on from there. |
0 commit comments