[](https://travis-ci.com/IBM/[MODEL REPO NAME]) [](http://[MODEL DOCKER TAG].max.us-south.containers.appdomain.cloud/)
This file contains the README template for a new model for Model Asset Exchange. Refer to other published MAX models for examples of how the README components are completed. Most sections that need to be updated are either marked in brackets or reference this skeleton repo. Some helpful hints are also included in comment blocks like this one. Please remember to delete the comment blocks before publishing.
Don't forget to update
samples/README.mdas well.
This repository contains code to instantiate and deploy a [MODEL NAME]. [ADD A DESCRIPTION OF THE MODEL HERE - see other MAX models for examples]
The model is based on the [ADD OPEN SOURCE MODEL]([LINK TO MODEL]). The model files are hosted on [IBM Cloud Object Storage]([LINK TO SPECIFIC SOFTLAYER LOCATION]). The code in this repository deploys the model as a web service in a Docker container. This repository was developed as part of the IBM Developer Model Asset Exchange and the public API is powered by IBM Cloud.
| Domain | Application | Industry | Framework | Training Data | Input Data Format |
|---|---|---|---|---|---|
| [INSERT DOMAIN] | [INSERT APPLICATION] | [INSERT INDUSTRY] | [INSERT FRAMEWORK] | [INSERT TRAINING DATA] | [INSERT INPUT DATA FORMAT] |
The predictive performance of the model can be characterized by the benchmark table below.
Note: The performance of a model is not the only significant metric. The level of bias and fairness incorporated in the model are also of high importance. Learn more by reading up on the AI Fairness 360 open source toolkit.
| [DATASET 1] | [DATASET 2] | [DATASET 3] | |
|---|---|---|---|
| [METRIC 1] | [VALUE] | [VALUE] | [VALUE] |
| [METRIC 2] | [VALUE] | [VALUE] | [VALUE] |
This section should include links to relevant papers, github repos and dataset home pages. Please follow the standard format for references.
- [AUTHOR 1, AUTHOR 2], ["PAPER NAME"]([LINK TO PAPER]), [JOURNAL / SITE], [YEAR].
- [GITHUB REPO]([LINK TO REPO])
| Component | License | Link |
|---|---|---|
| This repository | Apache 2.0 | LICENSE |
| Model Weights | [LINK TO LICENSE] | [LINK TO LICENSE IN SOURCE] |
| Model Code (3rd party) | [LINK TO LICENSE] | [LINK TO LICENSE IN SOURCE] |
| Test samples | [LINK TO LICENSE] | samples README |
docker: The Docker command-line interface. Follow the installation instructions for your system.- The minimum recommended resources for this model is [SET NECESSARY GB] Memory and [SET NECESSARY CPUs] CPUs.
- If you are on x86-64/AMD64, your CPU must support AVX at the minimum. [Remove this item if it's not TensorFlow-based.]
To run the docker image, which automatically starts the model serving API, run:
$ docker run -it -p 5000:5000 quay.io/codait/[MODEL DOCKER TAG]
This will pull a pre-built image from the Quay.io container registry (or use an existing image if already cached locally) and run it. If you'd rather checkout and build the model locally you can follow the run locally steps below.
You can deploy the model-serving microservice on Red Hat OpenShift by following the instructions for the OpenShift web console or the OpenShift Container Platform CLI in this tutorial, specifying quay.io/codait/[MODEL DOCKER TAG] as the image name.
You can also deploy the model on Kubernetes using the latest docker image on Quay.
On your Kubernetes cluster, run the following commands:
$ kubectl apply -f https://github.ibm.com/CODAIT/[MODEL REPO NAME]/raw/master/[MODEL DOCKER TAG].yaml
The model will be available internally at port 5000, but can also be accessed externally through the NodePort.
A more elaborate tutorial on how to deploy this MAX model to production on IBM Cloud can be found here.
Clone this repository locally. In a terminal, run the following command:
$ git clone https://github.ibm.com/CODAIT/[MODEL REPO NAME].git
Change directory into the repository base folder:
$ cd [MODEL REPO NAME]
To build the docker image locally, run:
$ docker build -t [MODEL DOCKER TAG] .
All required model assets will be downloaded during the build process. Note that currently this docker image is CPU only (we will add support for GPU images later).
To run the docker image, which automatically starts the model serving API, run:
$ docker run -it -p 5000:5000 [MODEL DOCKER TAG]
The API server automatically generates an interactive Swagger documentation page. Go to http://localhost:5000 to load it. From there you can explore the API and also create test requests.
[INSERT DESCRIPTION OF HOW TO USE MODEL ENDPOINT]
Example description for image upload models: Use the
model/predictendpoint to load a test image (you can use one of the test images from thesamplesfolder) and get predicted labels for the image from the API.
You can also test it on the command line, for example:
$ curl -F "image=@samples/[SAMPLE IMAGE]" -XPOST http://localhost:5000/model/predict
You should see a JSON response like that below:
{
"status": "ok",
"predictions": [
["INSERT EXAMPLE OUTPUT"]
]
}Please remember to set
DEBUG = Falsewhen publishing the model.
To run the Flask API app in debug mode, edit config.py to set DEBUG = True under the application settings. You will then need to rebuild the docker image (see step 1).
To stop the Docker container, type CTRL + C in your terminal.
Remove this section if this model cannot be trained using custom data. Refer to https://github.ibm.com/CODAIT/max-model-training for details on how to enable a model for custom training.
This model supports both fine-tuning with transfer learning and training from scratch on a custom dataset. Please follow the steps listed under the training readme to retrain the model on Watson Machine Learning, a deep learning as a service offering of IBM Cloud.