- metadata:
- source: https://deepstack.readthedocs.io/en/latest/
- related:
- [[2023-05-07 Object Detection]]
---
# DeepStack Documentation!
> ## Excerpt
> DeepStack is an AI server that empowers every developer in the world to easily build state-of-the-art AI systems both on premise and in the cloud. The promises of Artificial Intelligence are huge but becoming a machine learning engineer is hard. DeepStack is device and language agnostic. You can run it on Windows, Mac OS, Linux, Raspberry PI and use it with any programming language.
---
## Official Documentation and Guide for DeepStack AI Server.[¶](https://deepstack.readthedocs.io/en/latest/#official-documentation-and-guide-for-deepstack-ai-server "Permalink to this headline")
**DeepStack** is an AI server that empowers every developer in the world to easily build state-of-the-art AI systems both on premise and in the cloud. The promises of Artificial Intelligence are huge but becoming a machine learning engineer is hard. **DeepStack** is device and language agnostic. You can run it on **Windows**, **Mac OS**, **Linux**, **Raspberry PI** and use it with any programming language.
DeepStack’s source code is available on GitHub via [https://github.com/johnolafenwa/DeepStack](https://github.com/johnolafenwa/DeepStack)
**DeepStack** is developed and maintained by [DeepQuest AI](https://deepquestai.com/) .
## Top Features[¶](https://deepstack.readthedocs.io/en/latest/#top-features "Permalink to this headline")
- [FACE DETECTION & RECOGNITION](https://deepstack.readthedocs.io/en/latest/face-recognition)
- [OBJECT DETECTION](https://deepstack.readthedocs.io/en/latest/object-detection)
- [IMAGE ENHANCE](https://deepstack.readthedocs.io/en/latest/image-enhance)
- [SCENE RECOGNITION](https://deepstack.readthedocs.io/en/latest/scene-recognition)
- [SUPPORT FOR CUSTOM OBJECT DETECTION](https://deepstack.readthedocs.io/en/latest/custom-models)
- [IN-BUILT SECURITY](https://deepstack.readthedocs.io/en/latest/security)
- [API REFERENCE](https://deepstack.readthedocs.io/en/latest/api-reference)
## Example Code[¶](https://deepstack.readthedocs.io/en/latest/#example-code "Permalink to this headline")
Using DeepStack, we can classify the scene of the above image as seen below.
```
import requests
image_data = open("image.jpg","rb").read()
response = requests.post("http://localhost:80/v1/vision/scene",
files={"image":image_data}).json()
print(response)
```
**Response**
```
{ 'success': true, label: 'highway', confidence: 0.63377846 }
```
## Installation[¶](https://deepstack.readthedocs.io/en/latest/#installation "Permalink to this headline")
**DeepStack** is available in three variants, **CPU Version**, **GPU Version**, **NVIDIA Jetson** and **Raspberry PI Version** (With Support for Intel Neural Compute Stick)
[Installation Guide for GPU Version](https://deepstack.readthedocs.io/en/latest/using-deepstack-with-nvidia-gpus)
[Installation Guide for NVIDIA Jetson](https://deepstack.readthedocs.io/en/latest/nvidia-jetson)
[Installation Guide for Windows ( CPU and GPU )](https://deepstack.readthedocs.io/en/latest/windows)
[Installation Guide for Raspberry Pi and Other Arm64 Devices](https://deepstack.readthedocs.io/en/latest/arm64)
## Installation Guide for CPU Version[¶](https://deepstack.readthedocs.io/en/latest/#installation-guide-for-cpu-version "Permalink to this headline")
Step 1: Install Docker (If not already installed) Mac OS and Windows Users can install docker from [Docker’s Website](https://www.docker.com/products/docker-desktop) .
To install on a **Linux** operating system, run the commands below
```
sudo apt-get update
sudo apt-get install docker.io
```
Step 2: Install DeepStack
```
docker pull deepquestai/deepstack
```
## Run DeepStack with Scene Recognition API enabled[¶](https://deepstack.readthedocs.io/en/latest/#run-deepstack-with-scene-recognition-api-enabled "Permalink to this headline")
Run the command below as it applies to the version you have installed
```
docker run -e VISION-SCENE=True -v localstorage:/datastore -p 80:5000 deepquestai/deepstack
```
_Basic Parameters_
**\-e VISION-SCENE=True** This enables the scene recognition API.
**\-p 80:5000** This makes DeepStack accessible via port 80 of the machine.
Run the **example scene recognition** code at the begining of this page to verify your installation is working.
Contents:
- [Getting Started](https://deepstack.readthedocs.io/en/latest/getting-started/index.html)
- [Setting Up DeepStack](https://deepstack.readthedocs.io/en/latest/getting-started/index.html#setting-up-deepstack)
- [Starting DeepStack](https://deepstack.readthedocs.io/en/latest/getting-started/index.html#starting-deepstack)
- [Face Recognition](https://deepstack.readthedocs.io/en/latest/getting-started/index.html#face-recognition)
- [Performance](https://deepstack.readthedocs.io/en/latest/getting-started/index.html#performance)
- [Face Recognition](https://deepstack.readthedocs.io/en/latest/face-recognition/index.html)
- [Starting DeepStack on Docker](https://deepstack.readthedocs.io/en/latest/face-recognition/index.html#starting-deepstack-on-docker)
- [Face Registration](https://deepstack.readthedocs.io/en/latest/face-recognition/index.html#face-registration)
- [Face Recognition](https://deepstack.readthedocs.io/en/latest/face-recognition/index.html#id1)
- [Extracting Faces](https://deepstack.readthedocs.io/en/latest/face-recognition/index.html#extracting-faces)
- [Setting Minimum Confidence](https://deepstack.readthedocs.io/en/latest/face-recognition/index.html#setting-minimum-confidence)
- [Managing Registered Faces](https://deepstack.readthedocs.io/en/latest/face-recognition/index.html#managing-registered-faces)
- [Performance](https://deepstack.readthedocs.io/en/latest/face-recognition/index.html#performance)
- [Face Detection](https://deepstack.readthedocs.io/en/latest/face-detection/index.html)
- [Face Match](https://deepstack.readthedocs.io/en/latest/face-match/index.html)
- [Performance](https://deepstack.readthedocs.io/en/latest/face-match/index.html#performance)
- [Object Detection](https://deepstack.readthedocs.io/en/latest/object-detection/index.html)
- [Starting DeepStack](https://deepstack.readthedocs.io/en/latest/object-detection/index.html#starting-deepstack)
- [Setting Minimum Confidence](https://deepstack.readthedocs.io/en/latest/object-detection/index.html#setting-minimum-confidence)
- [CLASSES](https://deepstack.readthedocs.io/en/latest/object-detection/index.html#classes)
- [Performance](https://deepstack.readthedocs.io/en/latest/object-detection/index.html#performance)
- [Image Enhance](https://deepstack.readthedocs.io/en/latest/image-enhance/index.html)
- [Starting DeepStack](https://deepstack.readthedocs.io/en/latest/image-enhance/index.html#starting-deepstack)
- [Scene Recognition](https://deepstack.readthedocs.io/en/latest/scene-recognition/index.html)
- [Starting DeepStack](https://deepstack.readthedocs.io/en/latest/scene-recognition/index.html#starting-deepstack)
- [Custom Models](https://deepstack.readthedocs.io/en/latest/custom-models/index.html)
- [Preparing Your Dataset](https://deepstack.readthedocs.io/en/latest/custom-models/datasetprep/index.html)
- [Step 1: Install LabelIMG](https://deepstack.readthedocs.io/en/latest/custom-models/datasetprep/index.html#step-1-install-labelimg)
- [Step 2: Organize Your Dataset](https://deepstack.readthedocs.io/en/latest/custom-models/datasetprep/index.html#step-2-organize-your-dataset)
- [Step 3: Run LabelIMG](https://deepstack.readthedocs.io/en/latest/custom-models/datasetprep/index.html#step-3-run-labelimg)
- [Change Annotation to YOLO Format](https://deepstack.readthedocs.io/en/latest/custom-models/datasetprep/index.html#change-annotation-to-yolo-format)
- [Step 4: Annotate Your Dataset](https://deepstack.readthedocs.io/en/latest/custom-models/datasetprep/index.html#step-4-annotate-your-dataset)
- [Annotate Your Test Dataset](https://deepstack.readthedocs.io/en/latest/custom-models/datasetprep/index.html#annotate-your-test-dataset)
- [Training Your Custom Model](https://deepstack.readthedocs.io/en/latest/custom-models/training/index.html)
- [Option 1: Training on Google Colab with Free GPUS](https://deepstack.readthedocs.io/en/latest/custom-models/training/index.html#option-1-training-on-google-colab-with-free-gpus)
- [Option 2: Training Locally](https://deepstack.readthedocs.io/en/latest/custom-models/training/index.html#option-2-training-locally)
- [Deploying Your Model With DeepStack](https://deepstack.readthedocs.io/en/latest/custom-models/deployment/index.html)
- [Run DeepStack](https://deepstack.readthedocs.io/en/latest/custom-models/deployment/index.html#run-deepstack)
- [Run Inference](https://deepstack.readthedocs.io/en/latest/custom-models/deployment/index.html#run-inference)
- [Custom Models: Samples](https://deepstack.readthedocs.io/en/latest/custom-models-samples/index.html)
- [1\. Licence Plate Detection](https://deepstack.readthedocs.io/en/latest/custom-models-samples/index.html#licence-plate-detection)
- [2\. Logo Detection](https://deepstack.readthedocs.io/en/latest/custom-models-samples/index.html#logo-detection)
- [3\. Dark/Night scene objects Detection](https://deepstack.readthedocs.io/en/latest/custom-models-samples/index.html#dark-night-scene-objects-detection)
- [4\. Human action Detection/Recognition](https://deepstack.readthedocs.io/en/latest/custom-models-samples/index.html#human-action-detection-recognition)
- [5\. DeepStack-Security-Camera-Models](https://deepstack.readthedocs.io/en/latest/custom-models-samples/index.html#deepstack-security-camera-models)
- [Security](https://deepstack.readthedocs.io/en/latest/security/index.html)
- [Setting API Key](https://deepstack.readthedocs.io/en/latest/security/index.html#setting-api-key)
- [Setting Admin keys](https://deepstack.readthedocs.io/en/latest/security/index.html#setting-admin-keys)
- [SSL Support](https://deepstack.readthedocs.io/en/latest/ssl/index.html)
- [Create a Certificate](https://deepstack.readthedocs.io/en/latest/ssl/index.html#create-a-certificate)
- [Run DeepStack with SSL](https://deepstack.readthedocs.io/en/latest/ssl/index.html#run-deepstack-with-ssl)
- [Multithreading](https://deepstack.readthedocs.io/en/latest/multithreading/index.html)
- [Run DeepStack on Multiple Threads](https://deepstack.readthedocs.io/en/latest/multithreading/index.html#run-deepstack-on-multiple-threads)
- [Debugging](https://deepstack.readthedocs.io/en/latest/debugging/index.html)
- [DeepStack Docker](https://deepstack.readthedocs.io/en/latest/debugging/index.html#deepstack-docker)
- [DeepStack Windows](https://deepstack.readthedocs.io/en/latest/debugging/index.html#deepstack-windows)
- [Backup](https://deepstack.readthedocs.io/en/latest/backup/index.html)
- [Backups](https://deepstack.readthedocs.io/en/latest/backup/index.html#backups)
- [Restore](https://deepstack.readthedocs.io/en/latest/backup/index.html#restore)
- [Python SDK](https://deepstack.readthedocs.io/en/latest/python-sdk/index.html)
- [Install DeepStack](https://deepstack.readthedocs.io/en/latest/python-sdk/index.html#install-deepstack)
- [Install Python SDK](https://deepstack.readthedocs.io/en/latest/python-sdk/index.html#install-python-sdk)
- [Object Detection](https://deepstack.readthedocs.io/en/latest/python-sdk/index.html#object-detection)
- [Face API](https://deepstack.readthedocs.io/en/latest/python-sdk/index.html#face-api)
- [Custom Object Detection](https://deepstack.readthedocs.io/en/latest/python-sdk/index.html#custom-object-detection)
- [Scene Recognition](https://deepstack.readthedocs.io/en/latest/python-sdk/index.html#scene-recognition)
- [Image Enhance](https://deepstack.readthedocs.io/en/latest/python-sdk/index.html#image-enhance)
- [Using DeepStack with NVIDIA GPUs](https://deepstack.readthedocs.io/en/latest/using-deepstack-with-nvidia-gpus/index.html)
- [Step 1: Install Docker](https://deepstack.readthedocs.io/en/latest/using-deepstack-with-nvidia-gpus/index.html#step-1-install-docker)
- [Step 2: Setup NVIDIA Drivers](https://deepstack.readthedocs.io/en/latest/using-deepstack-with-nvidia-gpus/index.html#step-2-setup-nvidia-drivers)
- [Step 3: Install NVIDIA Container Toolkit](https://deepstack.readthedocs.io/en/latest/using-deepstack-with-nvidia-gpus/index.html#step-3-install-nvidia-container-toolkit)
- [Step 4: Install DeepStack GPU Version](https://deepstack.readthedocs.io/en/latest/using-deepstack-with-nvidia-gpus/index.html#step-4-install-deepstack-gpu-version)
- [Step 5: RUN DeepStack with GPU Access](https://deepstack.readthedocs.io/en/latest/using-deepstack-with-nvidia-gpus/index.html#step-5-run-deepstack-with-gpu-access)
- [RUN with All APIs](https://deepstack.readthedocs.io/en/latest/using-deepstack-with-nvidia-gpus/index.html#run-with-all-apis)
- [Using DeepStack with Windows 10 (CPU and GPU)](https://deepstack.readthedocs.io/en/latest/windows/index.html)
- [Install DeepStack CPU](https://deepstack.readthedocs.io/en/latest/windows/index.html#install-deepstack-cpu)
- [Install DeepStack GPU](https://deepstack.readthedocs.io/en/latest/windows/index.html#install-deepstack-gpu)
- [Using DeepStack on Windows](https://deepstack.readthedocs.io/en/latest/windows/index.html#using-deepstack-on-windows)
- [Custom Models](https://deepstack.readthedocs.io/en/latest/windows/index.html#custom-models)
- [RUN with All APIs](https://deepstack.readthedocs.io/en/latest/windows/index.html#run-with-all-apis)
- [Speed Modes](https://deepstack.readthedocs.io/en/latest/windows/index.html#speed-modes)
- [API and Admin Keys](https://deepstack.readthedocs.io/en/latest/windows/index.html#api-and-admin-keys)
- [Using DeepStack with NVIDIA Jetson](https://deepstack.readthedocs.io/en/latest/nvidia-jetson/index.html)
- [Step 1: Install Docker](https://deepstack.readthedocs.io/en/latest/nvidia-jetson/index.html#step-1-install-docker)
- [Step 2: Install DeepStack GPU for Jetson](https://deepstack.readthedocs.io/en/latest/nvidia-jetson/index.html#step-2-install-deepstack-gpu-for-jetson)
- [Step 3: RUN DeepStack GPU on Jetson](https://deepstack.readthedocs.io/en/latest/nvidia-jetson/index.html#step-3-run-deepstack-gpu-on-jetson)
- [RUN with All APIs](https://deepstack.readthedocs.io/en/latest/nvidia-jetson/index.html#run-with-all-apis)
- [Using DeepStack with Arm64 Devices](https://deepstack.readthedocs.io/en/latest/arm64/index.html)
- [Step 1: Install Docker](https://deepstack.readthedocs.io/en/latest/arm64/index.html#step-1-install-docker)
- [Step 2: Install DeepStack](https://deepstack.readthedocs.io/en/latest/arm64/index.html#step-2-install-deepstack)
- [Step 3: RUN DeepStack](https://deepstack.readthedocs.io/en/latest/arm64/index.html#step-3-run-deepstack)
- [DeepStack on Arm64 Servers](https://deepstack.readthedocs.io/en/latest/arm64/index.html#deepstack-on-arm64-servers)
- [RUN with All APIs](https://deepstack.readthedocs.io/en/latest/arm64/index.html#run-with-all-apis)
- [FAQ](https://deepstack.readthedocs.io/en/latest/faq/index.html)
- [General questions](https://deepstack.readthedocs.io/en/latest/faq/index.html#general-questions)
- [Installation & starting issues](https://deepstack.readthedocs.io/en/latest/faq/index.html#installation-starting-issues)
- [APIs: Face](https://deepstack.readthedocs.io/en/latest/faq/index.html#apis-face)
- [APIs: Object Detection](https://deepstack.readthedocs.io/en/latest/faq/index.html#apis-object-detection)
- [APIs: Scene Recognition](https://deepstack.readthedocs.io/en/latest/faq/index.html#apis-scene-recognition)
- [APIs: Custom Models](https://deepstack.readthedocs.io/en/latest/faq/index.html#apis-custom-models)
- [APIs: Security](https://deepstack.readthedocs.io/en/latest/faq/index.html#apis-security)
- [Best Practices](https://deepstack.readthedocs.io/en/latest/best-practices/index.html)
- [API Reference](https://deepstack.readthedocs.io/en/latest/api-reference/index.html)
- [Face Detection](https://deepstack.readthedocs.io/en/latest/api-reference/index.html#face-detection)
- [Face Registration](https://deepstack.readthedocs.io/en/latest/api-reference/index.html#face-registration)
- [Face Recognition](https://deepstack.readthedocs.io/en/latest/api-reference/index.html#face-recognition)
- [Face Match](https://deepstack.readthedocs.io/en/latest/api-reference/index.html#face-match)
- [Object Detection](https://deepstack.readthedocs.io/en/latest/api-reference/index.html#object-detection)
- [Image Enhance](https://deepstack.readthedocs.io/en/latest/api-reference/index.html#image-enhance)
- [Scene Recognition](https://deepstack.readthedocs.io/en/latest/api-reference/index.html#scene-recognition)
- [Indices and tables](https://deepstack.readthedocs.io/en/latest/api-reference/index.html#indices-and-tables)
- [Release Notes](https://deepstack.readthedocs.io/en/latest/release-notes/index.html)
- [Index](https://deepstack.readthedocs.io/en/latest/genindex.html)
- [Module Index](https://deepstack.readthedocs.io/en/latest/py-modindex.html)
- [Search Page](https://deepstack.readthedocs.io/en/latest/search.html)