Skip to content

Commit 2e140b2

Browse files
Subhash RameshSubhash Ramesh
authored andcommitted
updated readme
1 parent bf54278 commit 2e140b2

File tree

5 files changed

+145
-0
lines changed

5 files changed

+145
-0
lines changed

.DS_Store

0 Bytes
Binary file not shown.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 Galiboo
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
![Alt Olympyus](olympus_logo.png "Olympus")
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.

olympus_logo.png

16.9 KB
Loading

requirements.txt

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
appnope==0.1.0
2+
backports-abc==0.5
3+
backports.shutil-get-terminal-size==1.0.0
4+
backports.weakref==1.0.post1
5+
bleach==1.5.0
6+
certifi==2017.11.5
7+
click==6.7
8+
configparser==3.5.0
9+
coolname==0.2.1
10+
decorator==4.1.2
11+
entrypoints==0.2.3
12+
enum34==1.1.6
13+
fire==0.1.2
14+
Flask==0.12.2
15+
funcsigs==1.0.2
16+
functools32==3.2.3.post2
17+
futures==3.1.1
18+
haikunator==2.1.0
19+
html5lib==0.9999999
20+
ipykernel==4.6.1
21+
ipython==5.5.0
22+
ipython-genutils==0.2.0
23+
ipywidgets==7.0.3
24+
itsdangerous==0.24
25+
Jinja2==2.9.6
26+
jsonschema==2.6.0
27+
jupyter==1.0.0
28+
jupyter-client==5.1.0
29+
jupyter-console==5.2.0
30+
jupyter-core==4.4.0
31+
Keras==2.0.9
32+
Markdown==2.6.9
33+
MarkupSafe==1.0
34+
mistune==0.8
35+
mock==2.0.0
36+
nbconvert==5.3.1
37+
nbformat==4.4.0
38+
notebook==5.2.1
39+
numpy==1.13.3
40+
pandas==0.21.0
41+
pandocfilters==1.4.2
42+
pathlib2==2.3.0
43+
pbr==3.1.1
44+
pexpect==4.2.1
45+
pickleshare==0.7.4
46+
prompt-toolkit==1.0.15
47+
protobuf==3.4.0
48+
ptyprocess==0.5.2
49+
Pygments==2.2.0
50+
python-dateutil==2.6.1
51+
pytz==2017.3
52+
PyYAML==3.12
53+
pyzmq==16.0.3
54+
qtconsole==4.3.1
55+
scandir==1.6
56+
scipy==1.0.0
57+
simplegeneric==0.8.1
58+
singledispatch==3.4.0.3
59+
six==1.11.0
60+
tensorflow==1.4.0
61+
tensorflow-tensorboard==0.4.0rc2
62+
terminado==0.6
63+
testpath==0.3.1
64+
tinydb==3.6.0
65+
tornado==4.5.2
66+
traitlets==4.3.2
67+
wcwidth==0.1.7
68+
Werkzeug==0.12.2
69+
widgetsnbextension==3.0.6

0 commit comments

Comments
 (0)