{"id":13586513,"url":"https://github.com/robmarkcole/deepstack-ui","last_synced_at":"2025-04-07T15:32:10.711Z","repository":{"id":37480395,"uuid":"208959065","full_name":"robmarkcole/deepstack-ui","owner":"robmarkcole","description":"UI for working with Deepstack","archived":true,"fork":false,"pushed_at":"2022-07-05T04:22:21.000Z","size":15499,"stargazers_count":138,"open_issues_count":13,"forks_count":43,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-02T17:16:56.370Z","etag":null,"topics":["deep-learning","face-detection","face-recognition","image-classification","image-processing","object-detection","streamlit"],"latest_commit_sha":null,"homepage":"https://github.com/johnolafenwa/DeepStack","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robmarkcole.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"robmarkcole"}},"created_at":"2019-09-17T04:26:27.000Z","updated_at":"2025-03-19T08:14:47.000Z","dependencies_parsed_at":"2022-07-21T09:02:48.931Z","dependency_job_id":null,"html_url":"https://github.com/robmarkcole/deepstack-ui","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robmarkcole%2Fdeepstack-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robmarkcole%2Fdeepstack-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robmarkcole%2Fdeepstack-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robmarkcole%2Fdeepstack-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robmarkcole","download_url":"https://codeload.github.com/robmarkcole/deepstack-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247679663,"owners_count":20978095,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deep-learning","face-detection","face-recognition","image-classification","image-processing","object-detection","streamlit"],"created_at":"2024-08-01T15:05:37.415Z","updated_at":"2025-04-07T15:32:08.323Z","avatar_url":"https://github.com/robmarkcole.png","language":"Python","funding_links":["https://github.com/sponsors/robmarkcole"],"categories":["Python"],"sub_categories":[],"readme":"# deepstack-ui\nUI 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.\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://github.com/robmarkcole/deepstack-ui/blob/master/usage.png\" width=\"1000\"\u003e\n\u003c/p\u003e\n\n## Run deepstack\nRun deepstack object detection:\n```\ndocker run -e VISION-DETECTION=True -p 80:5000 deepquestai/deepstack:latest\n```\n\nYou will need the ip address of the machine running deepstack, which in my case is `192.168.1.133`.\n\n## Run deepstack-ui with Docker\nThe `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:\n```\n- DEEPSTACK_IP : the IP address of your deepstack instance, default \"localhost\"\n- DEEPSTACK_PORT : the PORT of your deepstack instance, default 80\n- DEEPSTACK_API_KEY : the API key of your deepstack instance, if you have set one\n- DEEPSTACK_TIMEOUT : the timeout to wait for deepstack, default 30 seconds\n- DEEPSTACK_CUSTOM_MODEL : the name of a custom model, if you wish to use one\n- DEEPSTACK_UI_DEBUG_MODE : options `True` or `False` (default). Lowers the minimum confidence threshold to 1%\n```\n\nFrom the root dir, build the deepstack-ui container from source and then run the UI, passing the `DEEPSTACK_IP` environment variable:\n```\n    docker build -t deepstack-ui .\n    OR\n    docker pull robmarkcole/deepstack-ui:latest\n\n    docker run -p 8501:8501 -e DEEPSTACK_IP='192.168.1.133' deepstack-ui\n```\nThe 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)\n\nAlternatively if you are running deepstack with non default parameters, an example would be:\n```\ndocker run -p 8501:8501 \\\n-e DEEPSTACK_IP='192.168.1.133' \\\n-e DEEPSTACK_PORT=80 \\\n-e DEEPSTACK_TIMEOUT=20 \\\n-e DEEPSTACK_CUSTOM_MODEL=mask \\\ndeepstack-ui\n```\n\n## Docker-compose\nAn 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`.\n\n### FAQ\nQ1: I get the error: `TypeError: cannot unpack non-iterable DeepstackException object`\n\nA1: You probably didn't pass the required environment variables (`DEEPSTACK_IP` etc.)\n\n------\n\n## Development\n* Create and activate a venv: `python3 -m venv venv` and `source venv/bin/activate`\n* Install requirements: `pip3 install -r requirements.txt`\n* Export required environment variables: `export DEEPSTACK_CUSTOM_MODEL='mask'`\n* Run streamlit from `app` folder: `streamlit run deepstack-ui.py`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobmarkcole%2Fdeepstack-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobmarkcole%2Fdeepstack-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobmarkcole%2Fdeepstack-ui/lists"}