Skip to content

Commit a4097b5

Browse files
authored
misc readme changes (#29)
* misc readme changes * Update DEPLOY_MODEL.md moved protocol onto same line as ports to match ui * Update README.md * Update README.md nit * Update deploy.json Fixed example endpoints * Update README.md grammar
1 parent a0a05e7 commit a4097b5

File tree

3 files changed

+13
-12
lines changed

3 files changed

+13
-12
lines changed

.bluemix/deploy.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"pattern": "\\S"
2424
},
2525
"dev-ml-endpoint": {
26-
"description": "e.g. https://max-image-caption-generator.mybluemix.net/model/predict",
26+
"description": "e.g. http://170.0.0.1:5000",
2727
"type": "string"
2828
}
2929
},
@@ -85,8 +85,8 @@
8585
"type": "text",
8686
"readonly": false,
8787
"title": "Image Caption Generator Model API Endpoint",
88-
"description": "e.g. https://max-image-caption-generator.mybluemix.net/model/predict",
88+
"description": "e.g. http://170.0.0.1:5000",
8989
"key": "dev-ml-endpoint"
9090
}
9191
]
92-
}
92+
}

DEPLOY_MODEL.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@
66
77
![Create Cluster](doc/source/images/create-cluster.png)
88

9-
2. (Optional Step) The instructions to install the command line tools are optional and not required to deploy the model using this tutorial. You may choose to install them while waiting for the cluster to be created, if you wish to do so.
9+
2. (Optional Step) The instructions to install the command line tools are optional and not required to deploy the model using this tutorial. While not required, you may choose to install them while waiting for the cluster to be created.
1010

1111
3. On your cluster dashboard, select `Worker Nodes` in the sidebar and take note of the `Public IP Address` for the node.
1212

13+
> Note: The IP address will not be displayed until the cluster is fully deployed.
14+
1315
![Worker IP](doc/source/images/worker-public-ip.png)
1416

1517
4. Click the `Kubernetes Dashboard` button to open the dashboard. Hit the `+ Create` button in the top right corner. Go to `Create an app`.
@@ -19,7 +21,7 @@
1921
Container image: codait/max-image-caption-generator:latest
2022
Number of pods: 1
2123
Service: External
22-
Port: 5000 | Target Port: 5000
24+
Port: 5000 | Target Port: 5000 | Protocol: TCP
2325
```
2426
Then click `Deploy`
2527

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,25 +74,24 @@ If you already have a model API endpoint available you can skip this process.
7474
7575
### Deploy the Web App
7676

77-
1. Press the ``Deploy to IBM Cloud`` button. If you do not have an IBM Cloud account yet, you will need to create one.
77+
1. Press the `Deploy to IBM Cloud` button. If you do not have an IBM Cloud account yet, you will need to create one.
7878

7979
[![Deploy to IBM Cloud](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https://github.com/IBM/MAX-Image-Caption-Generator-Web-App)
8080

81-
2. Click `Delivery Pipeline` and fill in the form with Image Caption Generator API endpoint deployed above then
82-
click on ``Create``.
81+
2. Click `Delivery Pipeline` and fill in the form with the Image Caption Generator API endpoint deployed above, then click on `Create`.
8382

84-
> e.g. `https://max-image-caption-generator.mybluemix.net/model/predict`
83+
> The format for this entry should be `http://170.0.0.1:5000`
8584
8685
![Create App](doc/source/images/ibm-cloud-form.png)
8786

88-
3. In Toolchains, click on ``Delivery Pipeline`` to watch while the app is deployed. Once deployed, the app can be
89-
viewed by clicking ``View app``.
87+
3. In Toolchains, click on `Delivery Pipeline` to watch while the app is deployed. Once deployed, the app can be
88+
viewed by clicking `View app`.
9089

9190
![Delivery Pipeline](doc/source/images/ibm-cloud-deploy.png)
9291

9392
## Run Locally
9493

95-
> NOTE: These steps are only needed when running locally instead of using the ``Deploy to IBM Cloud`` button.
94+
> NOTE: These steps are only needed when running locally instead of using the `Deploy to IBM Cloud` button.
9695
9796
#### Setting up the MAX Model
9897

0 commit comments

Comments
 (0)