Update README.md

pull/55/head
Zach McDonough 2021-02-28 16:40:35 -08:00 committed by GitHub
parent 03d30362b1
commit 070a8823b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 5 deletions

View File

@ -24,14 +24,26 @@ The `deepstack-ui` is designed to be run in a docker container. The UI picks up
- DEEPSTACK_UI_DEBUG_MODE : options `True` or `False` (default). Lowers the minimum confidence threshold to 1%
```
From the root dir, build the deepstack-ui container from source and then run the UI, passing the `DEEPSTACK_IP` environment variable:
From the root dir, either build the deepstack-ui container from source or pull from Docker Hub: and
For x86-64 architecture
```
docker build -t deepstack-ui .
docker build -t deepstack-ui . -f Dockerfile
OR
docker pull robmarkcole/deepstack-ui:latest
docker run -p 8501:8501 -e DEEPSTACK_IP='192.168.1.133' deepstack-ui
```
Or for arm64 architectue (Raspberry Pi):
```
docker build -t deepstack-ui . -f Dockerfile.arm64
OR
docker pull robmarkcole/deepstack-ui:arm64
```
Then run the UI, passing the `DEEPSTACK_IP` environment variable:
`docker run -p 8501:8501 -e DEEPSTACK_IP='192.168.1.133' deepstack-ui`
The UI is now viewable at [http://localhost:8501](http://localhost:8501) (not whatever ip address is shown in the logs, this is the internal docker ip)
Alternatively if you are running deepstack with non default parameters, an example would be:
@ -58,4 +70,4 @@ A1: You probably didn't pass the required environment variables (`DEEPSTACK_IP`
* Create and activate a venv: `python3 -m venv venv` and `source venv/bin/activate`
* Install requirements: `pip3 install -r requirements.txt`
* Export required environment variables: `export DEEPSTACK_CUSTOM_MODEL='mask'`
* Run streamlit from `app` folder: `streamlit run deepstack-ui.py`
* Run streamlit from `app` folder: `streamlit run deepstack-ui.py`