Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelschwier committed Aug 31, 2018
2 parents 5666dc4 + 14eaa8b commit 7358d8a
Show file tree
Hide file tree
Showing 13 changed files with 77 additions and 268 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
/tests
/contrib_src/.ipynb_checkpoints
/docs/build
/modelhub/build
/modelhub/dist
/modelhub/modelhub_ai.egg-info
*.pyc
.coverage
.vscode
Expand Down
File renamed without changes.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,58 @@
| Build/Test Status | Code Coverage | Documentation |
| :---: | :---: | :---: |
| Build/Test Status | Code Coverage | Documentation |
| :---------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------: |
| [![](https://travis-ci.org/modelhub-ai/modelhub-engine.svg?branch=master)](https://travis-ci.org/modelhub-ai/modelhub-engine) | [![Coverage Status](https://coveralls.io/repos/github/modelhub-ai/modelhub-engine/badge.svg?branch=master&service=github)](https://coveralls.io/github/modelhub-ai/modelhub-engine?branch=master) | [![Documentation Status](https://readthedocs.org/projects/modelhub/badge/?version=latest)](https://modelhub.readthedocs.io/en/latest/?badge=latest) |


# modelhub-engine

Backend library, framework, and API for models in modelhub http://modelhub.ai/

Library and common framework on which model contributors must base their model contribution. The framework handles/provides

* data I/O
* data conversion to/from numpy (typical data format used in deep learning libraries)
* generic API for accessing and working with the model
* “slots” for preprocessing, postprocessing, and inference, which have to be populated by the contributor with the model specific code

For a detailed technical documentation of the whole Modelhub project and infrastructure see [modelhub.readthedocs.io](http://modelhub.readthedocs.io).


## Developer info

**/docker** contains files for building the specific docker images for a model.

**/docs** contains Sphinx documentation sources for the modelhub project.

**/framework** contains the modelhub framework code.

**/modelhub** contains the modelhub python package files.

Template files for the contributer source (integrating the actual net plus required pre- and postprocessing) are locateded [here](https://github.com/modelhub-ai/model-template). Instructions on how to prepare a new contribution can be found [here](http://modelhub.readthedocs.io/en/latest/contribute.html).

### Running a model with a development version of the framework

For deployment of a model the framework is part of the runtime docker. However, when developing on the framework you would not want to re-build a docker to test each change. Hence the start script [here](https://github.com/modelhub-ai/modelhub) has the option to mount a framework folder, temporarily replacing the internal framwork:

```
python start.py MODEL_NAME -mf PATH_TO_FRAMEWORK
```

### Python Package Instructions

To build a new version:

```
python setup.py sdist bdist_wheel
```

To upload to test PyPi:

```
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
```

To upload to PyPi:

```
twine upload dist/*
```

## Acknowledgements

See NOTICE file in **/framework** for acknowledgements of third party technologies used.

47 changes: 0 additions & 47 deletions docker/Dockerfile_base_caffe2_deepyeast

This file was deleted.

49 changes: 0 additions & 49 deletions docker/Dockerfile_base_caffe_jonlong

This file was deleted.

31 changes: 0 additions & 31 deletions docker/Dockerfile_base_keras_2.0.2

This file was deleted.

48 changes: 0 additions & 48 deletions docker/Dockerfile_main_caffe2_deepyeast

This file was deleted.

43 changes: 0 additions & 43 deletions docker/Dockerfile_main_caffe_jonlong

This file was deleted.

43 changes: 0 additions & 43 deletions docker/Dockerfile_main_keras_2.0.2

This file was deleted.

21 changes: 21 additions & 0 deletions modelhub/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 ModelHub

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
3 changes: 3 additions & 0 deletions modelhub/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# modelhub

Crowdsourced through contributions by the research community, modelhub.ai is a repository of deep learning models for various data types.
2 changes: 2 additions & 0 deletions modelhub/modelhub/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
name = "modelhub"
test = "OK"
21 changes: 21 additions & 0 deletions modelhub/setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import setuptools

with open("README.md", "r") as fh:
long_description = fh.read()

setuptools.setup(
name="modelhub-ai",
version="0.0.4",
author="modelhub",
author_email="info@modelhub.ai",
description="Crowdsourced through contributions by the research community, modelhub.ai is a repository of deep learning models for various data types.",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/modelhub-ai",
packages=setuptools.find_packages(),
classifiers=[
"Programming Language :: Python :: 2",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
)

0 comments on commit 7358d8a

Please sign in to comment.