Skip to content

Commit fb1057a

Browse files
djalovaajbozarth
authored andcommitted
Update README (#4)
* Update README
1 parent 4b58881 commit fb1057a

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,35 @@ Before starting this web app you must setup the MAX Image Caption Generator REST
1010

1111
## Starting the Web App
1212

13-
Before running this web app you must install it's dependencies:
13+
Before running this web app you must install its dependencies:
1414

1515
pip install requests tornado
1616

1717
You then start the web app by running:
1818

1919
python app.py
2020

21-
Once it's finished processing the default images (< 1 minute) you can then access the web app at:
21+
Once it's finished processing the default images (< 1 minute) you can then access the web app at:
2222
[http://localhost:8088](http://localhost:8088)
2323

2424
The Image Caption Generator endpoint must be available at `http://localhost:5000` for the web app to successfully start.
2525

26+
### Configuring ports
27+
2628
If you want to use a different port or are running the ML endpoint at a different location
2729
you can change them with command-line options:
2830

2931
python app.py --port=[new port] --ml-endpoint=[endpoint url including protocol and port]
3032

3133
## Instructions for Docker
3234

33-
To run the web app with Docker you need to allow the containers running the web
34-
server and the REST endpoint to share the same network stack. This is done in
35-
the following steps.
35+
To run the web app with Docker the containers running the webserver and the REST
36+
endpoint need to share the same network stack. This is done in the following steps.
3637

3738
Modify the command that runs the Image Caption Generator REST endpoint
38-
to map the 8088 port:
39+
to map an additional port in the container to a port on the host machine.
40+
In the example below it is mapped to port 8088 on the host but other ports
41+
can also be used.
3942

4043
docker run -it -p 5000:5000 -p 8088:8088 --name max-im2txt max-im2txt
4144

0 commit comments

Comments
 (0)