Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robmarkcole/deepstack-ui
UI for working with Deepstack
https://github.com/robmarkcole/deepstack-ui
deep-learning face-detection face-recognition image-classification image-processing object-detection streamlit
Last synced: 3 months ago
JSON representation
UI for working with Deepstack
- Host: GitHub
- URL: https://github.com/robmarkcole/deepstack-ui
- Owner: robmarkcole
- License: gpl-3.0
- Archived: true
- Created: 2019-09-17T04:26:27.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-07-05T04:22:21.000Z (over 2 years ago)
- Last Synced: 2024-05-01T14:24:59.705Z (6 months ago)
- Topics: deep-learning, face-detection, face-recognition, image-classification, image-processing, object-detection, streamlit
- Language: Python
- Homepage: https://github.com/johnolafenwa/DeepStack
- Size: 14.8 MB
- Stars: 132
- Watchers: 8
- Forks: 40
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# deepstack-ui
UI for working with [Deepstack](https://github.com/johnolafenwa/DeepStack). Allows uploading an image and performing object detection or face recognition with Deepstack. Also faces can be registered with Deepstack. The effect of various parameters can be explored, including filtering objects by confidence, type and location in the image.
## Run deepstack
Run deepstack object detection:
```
docker run -e VISION-DETECTION=True -p 80:5000 deepquestai/deepstack:latest
```
You will need the ip address of the machine running deepstack, which in my case is `192.168.1.133`.
## Run deepstack-ui with Docker
The `deepstack-ui` is designed to be run in a docker container. The UI picks up the information about your deepstack instance from environment variables which are passed into the container using the `-e VARIABLE=value` approach. All environment variables that can be passed are listed below:
```
- DEEPSTACK_IP : the IP address of your deepstack instance, default "localhost"
- DEEPSTACK_PORT : the PORT of your deepstack instance, default 80
- DEEPSTACK_API_KEY : the API key of your deepstack instance, if you have set one
- DEEPSTACK_TIMEOUT : the timeout to wait for deepstack, default 30 seconds
- DEEPSTACK_CUSTOM_MODEL : the name of a custom model, if you wish to use one
- 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:
```
docker build -t deepstack-ui .
OR
docker pull robmarkcole/deepstack-ui:latest
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:
```
docker run -p 8501:8501 \
-e DEEPSTACK_IP='192.168.1.133' \
-e DEEPSTACK_PORT=80 \
-e DEEPSTACK_TIMEOUT=20 \
-e DEEPSTACK_CUSTOM_MODEL=mask \
deepstack-ui
```
## Docker-compose
An example docker-compose file is provided. For run commands see [here](https://docs.docker.com/compose/gettingstarted/#step-8-experiment-with-some-other-commands) but the main one you need is `docker-compose up`.
### FAQ
Q1: I get the error: `TypeError: cannot unpack non-iterable DeepstackException object`
A1: You probably didn't pass the required environment variables (`DEEPSTACK_IP` etc.)
------
## Development
* 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`