kleinnner commited on
Commit
eb366a1
·
verified ·
1 Parent(s): cccdeae

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +391 -0
README.md ADDED
@@ -0,0 +1,391 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # DEEPSTACK
2
+
3
+ ![license](https://img.shields.io/badge/license-license-blue) ![offline-first](https://img.shields.io/badge/offline--first-air--gap-green) ![audit](https://img.shields.io/badge/audit-SHA3--256-orange) ![category](https://img.shields.io/badge/category-surveillance_camera-lightgrey)
4
+
5
+ > Anticloud-hardened packaging of the upstream project `DEEPSTACK` in category **SURVEILLANCE CAMERA**. Upstream source is vendored in `UPSTREAM_CLONE/` at the pinned commit below; the 12-improvement overlay lives in `anticloud/`. Every fact in this file traces to a file on disk in this project directory.
6
+
7
+ **Category:** SURVEILLANCE CAMERA · **Upstream:** https://github.com/johnolafenwa/DeepStack · **Upstream pin:** `73b6f7ab0f9a8acc8f7a49c6f13594fe470de042` · **Vendor:** Anticloud FZ LLE
8
+
9
+ ---
10
+
11
+ ## What This Project Does
12
+
13
+ # DeepStack
14
+ The World's Leading Cross Platform AI Engine for Edge Devices, with over `10 million` installs on [**Docker Hub**](https://hub.docker.com/r/deepquestai/deepstack).
15
+
16
+ [![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
17
+
18
+ [![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](hhttps://github.com/johnolafenwa/DeepStack/blob/dev/LICENSE)
19
+
20
+ ![DevTest](https://github.com/johnolafenwa/DeepStack/workflows/DevTest/badge.svg)
21
+
22
+ **Website**: [https://deepstack.cc](https://deepstack.cc)
23
+
24
+ **Documentation**: [https://docs.deepstack.cc](https://docs.deepstack.cc)
25
+
26
+ **Forum**: [https://forum.deepstack.cc](https://forum.deepstack.cc)
27
+
28
+ **Dev Center**: [https://dev.deepstack.cc](https://dev.deepstack.cc/)
29
+
30
+ **DeepStack** is owned and maintained by [DeepQuest AI](https://www.deepquestai.com/).
31
+
32
+ # Introduction
33
+ DeepStack is an AI API engine that serves pre-built models and custom models on multiple edge devices locally or on your private cloud. Supported platforms are:
34
+
35
+ - **Linux OS** via Docker ( CPU and NVIDIA GPU support )
36
+ - **Mac OS** via Docker
37
+ - **Windows 10** ( native application, CPU and GPU )
38
+ - **NVIDIA Jetson** via Docker.
39
+ - **Rasperry Pi & ARM64 Devices** via Docker.
40
+
41
+ DeepStack runs completely offline and independent of the cloud. You can also install and run DeepStack on any cloud VM with docker installed to serve as your private, state-of-the-art and real-time AI server.
42
+
43
+ # Features
44
+
45
+ - **Face APIs**: Face detection, recognition and matching.
46
+
47
+ ![Face API](demo/face_api.jpg)
48
+
49
+ - **Common Objects APIs**: Object detection for [80 common objects](https://docs.deepstack.cc/object-detection/index.html#classes)
50
+
51
+ ![Detection API](demo/detection_api.jpg)
52
+
53
+ - **Custom Models**: Train and deploy new models to detect any custom object(s)
54
+
55
+ ![Custom Models API](demo/custom_model.jpg)
56
+
57
+ - **Image Enhance**: 4X image superresolution
58
+
59
+ `Input`
60
+
61
+ ![Image Enhance API Iput](demo/enhance_input.jpg)
62
+
63
+ `Output`
64
+ ![Image Enhance API Iput](demo/enhance_output.jpg)
65
+
66
+ - **Scene Recognition**: Image scene recognition
67
+ - **SSL Support**
68
+ - **API Key support**: Security options to protect your DeepStack endpoints
69
+
70
+ # Installation and Usage
71
+ Visit [https://docs.deepstack.cc/getting-started](https://docs.deepstack.cc/getting-started/) for installation instructions. The documentation provides example codes for the following programming languages with more to be added soon.
72
+
73
+ - **Python**
74
+ - **C#**
75
+ - **NodeJS**
76
+
77
+ # Build from Source (For Docker Version)
78
+
79
+ - **Install Prerequisites**
80
+
81
+ - [Install Golang](https://golang.org)
82
+ - [Install Docker](https://docker.com)
83
+ - [Install GIT](https://git-scm.com)
84
+ - [Install GIT LFS](https://github.com/git-lfs/git-lfs/wiki/Installation)
85
+ - [Install Redis Server](https://redis.io/)
86
+ - [Install Python3.7](https://python.org)
87
+ - [Install Powershell 7+](https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/install/installing-windows-powershell?view=powershell-7.1)
88
+
89
+ - **source DeepStack project**
90
+
91
+ ```git source https://github.com/johnolafenwa/DeepStack.git```
92
+
93
+ - **CD to DeepStack project Dir**
94
+
95
+ ```cd DeepStack```
96
+
97
+ - **Fetch project Files**
98
+
99
+ ``git lfs pull``
100
+ - **Download Binary Dependencies With Powershell**
101
+ ```.\download_dependencies.ps1```
102
+
103
+ - **Build DeepStack CPU Version**
104
+
105
+ ```cd .. && sudo docker build -t deepquestai/deepstack:cpu . -f Dockerfile.cpu```
106
+
107
+ - **Build DeepStack GPU Version**
108
+
109
+ ```sudo docker build -t deepquestai/deepstack:gpu . -f Dockerfile.gpu```
110
+
111
+ - **Build DeepStack Jetson Version**
112
+
113
+ ```sudo docker build -t deepquestai/deepstack:jetpack . -f Dockerfile.gpu-jetpack```
114
+
115
+ - **Running and Testing Locally Without Building**
116
+ - Unless you wish to install requirements system wide, create a virtual environment with ```python3.7 -m venv venv``` and activate with ```source venv/bin/activate```
117
+
118
+ - Install Requirements with ```pip3 install -r requirements.txt```
119
+
120
+ - For CPU Version, Install PyTorch with ```pip3 install torch==1.6.0+cpu torchvision==0.7.0+cpu -f https://download.pytorch.org/whl/torch_stable.html```
121
+
122
+ - For GPU Version, Install Pytorch with ```pip3 install torch==1.6.0+cu101 torchvision==0.7.0+cu101 -f https://download.pytorch.org/whl/torch_stable.html```
123
+
124
+ - Start Powershell
125
+ ```pwsh```
126
+
127
+ - For CPU Version, Run ```.\setup_docker_cpu.ps1```
128
+
129
+ - For GPU Version, Run ```.\setup_docker_gpu.ps1```
130
+
131
+ - CD To Server Dir
132
+ ```cd server```
133
+
134
+ - Build DeepStack Server
135
+ ```go build```
136
+
137
+ - Set Any of the APIS to enable;
138
+ ```$env:VISION_DETECTION = "True"```, ```$env:VISION_FACE = "True"```, ```$env:VISION_SCENE = "True"```
139
+
140
+ - Run DeepStack
141
+ ```.\server```
142
+
143
+ You can find all logs in the ```directory``` in the project root.
144
+ Note that DeepStack will be running on the default port ```5000```.
145
+
146
+ # Integrations and Community
147
+ The DeepStack ecosystem includes a number of popular integrations and libraries built to expand the functionalities of the AI engine to serve IoT, industrial, monitoring and research applications. A number of them are listed below
148
+
149
+ - **[HASS-DeepStack-Object](https://github.com/robmarkcole/HASS-Deepstack-object)**: An [Home Assistant](https://www.home-assistant.io/) addon by [Robin Cole](https://github.com/robmarkcole) for detecting common and custom objects
150
+ - **[HASS-DeepStack-Face](https://github.com/robmarkcole/HASS-Deepstack-face)**: An [Home Assistant](https://www.home-assistant.io/) addon by [Robin Cole](https://github.com/robmarkcole) for face detection, registration and recognition
151
+ - **[HASS-DeepStack-Scene](https://github.com/robmarkcole/HASS-Deepstack-scene)**: An [Home Assistant](https://www.home-assistant.io/) addon by [Robin Cole](https://github.com/robmarkcole) for scene recognition
152
+ - **[DeepStack with Blue Iris - YouTube video](https://www.youtube.com/watch?v=fwoonl5JKgo)**: A DeepStack + BluIris setup tutorial by [TheHookUp](https://www.youtube.com
153
+
154
+ *(excerpt; full text in `UPSTREAM_CLONE/`)*
155
+
156
+ *Quoted from the upstream `README.md` file in `UPSTREAM_CLONE/`.*
157
+ Project-specific facts detected in this directory:
158
+
159
+ - Ecosystem: **Python (requirements)** (manifests: requirements.txt; scanned in UPSTREAM_CLONE)
160
+ - Top-level source layout: `base/`, `demo/`, `intelligencelayer/`, `platform/`, `results/`, `rpi/`, `server/`, `tests/`
161
+ - Snapshot size: **294 files**, **6622 lines of code** (measured; see Benchmarks)
162
+ - Primary languages: `.png` (117), `.jpg` (51), `.py` (43), `.scss` (12), `.css` (10), `.go` (7)
163
+ - Upstream commit pinned for this packaging: `73b6f7ab0f9a8acc8f7a49c6f13594fe470de042`
164
+
165
+ ---
166
+
167
+ ## Installation
168
+
169
+ [![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
170
+
171
+ [![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](hhttps://github.com/johnolafenwa/DeepStack/blob/dev/LICENSE)
172
+
173
+ ![DevTest](https://github.com/johnolafenwa/DeepStack/workflows/DevTest/badge.svg)
174
+
175
+ **Website**: [https://deepstack.cc](https://deepstack.cc)
176
+
177
+ **Documentation**: [https://docs.deepstack.cc](https://docs.deepstack.cc)
178
+
179
+ **Forum**: [https://forum.deepstack.cc](https://forum.deepstack.cc)
180
+
181
+ **Dev Center**: [https://dev.deepstack.cc](https://dev.deepstack.cc/)
182
+
183
+ **DeepStack** is owned and maintained by [DeepQuest AI](https://www.deepquestai.com/).
184
+
185
+ *Section quoted from the upstream readme.*
186
+ Overlay install (this project):
187
+
188
+ ```sh
189
+ python -m pip install -e anticloud/ # overlay package with the 12 improvements
190
+ python anticloud/cli.py --help # 13 subcommands, JSON stdout
191
+ ```
192
+
193
+ ---
194
+
195
+ ## Usage
196
+
197
+ Visit [https://docs.deepstack.cc/getting-started](https://docs.deepstack.cc/getting-started/) for installation instructions. The documentation provides example codes for the following programming languages with more to be added soon.
198
+
199
+ - **Python**
200
+ - **C#**
201
+ - **NodeJS**
202
+
203
+ *Section quoted from the upstream readme.*
204
+ Anticloud overlay CLI (available in every project):
205
+
206
+ ```sh
207
+ python anticloud/cli.py --help # 13 subcommands, JSON stdout
208
+ python anticloud/cli.py checks # run the 16-check suite
209
+ ```
210
+
211
+ ---
212
+
213
+ ## API
214
+
215
+ **Forum**: [https://forum.deepstack.cc](https://forum.deepstack.cc)
216
+
217
+ **Dev Center**: [https://dev.deepstack.cc](https://dev.deepstack.cc/)
218
+
219
+ **DeepStack** is owned and maintained by [DeepQuest AI](https://www.deepquestai.com/).
220
+
221
+ *Section quoted from the upstream readme.*
222
+ ---
223
+
224
+ ## Dependencies
225
+
226
+ | Metric | Value |
227
+ |--------|-------|
228
+ | Ecosystem | Python (requirements) |
229
+ | Manifests detected | requirements.txt |
230
+ | Files in snapshot | 294 |
231
+ | Lines of code | 6622 |
232
+ | Dependency references | 14 |
233
+ | Dependencies by ecosystem | go: 14 |
234
+ | Upstream license | Apache-2.0 |
235
+ | Overlay license | Anticommons 0.1.0 |
236
+
237
+ Top dependency references recorded in the benchmark snapshot:
238
+
239
+ | Ecosystem | Name | Version | Source file |
240
+ |-----------|------|---------|-------------|
241
+ | go | github.com/gin-gonic/gin | v1.7.0 | server/go.mod |
242
+ | go | github.com/go-ole/go-ole | v1.2.4 | server/go.mod |
243
+ | go | github.com/go-redis/redis | v6.15.2+incompatible | server/go.mod |
244
+ | go | github.com/imroc/req | v0.2.4 | server/go.mod |
245
+ | go | github.com/mattn/go-sqlite3 | v1.11.0 | server/go.mod |
246
+ | go | github.com/modern-go/concurrent | v0.0.0-20180306012644-bacd9c7ef1dd | server/go.mod |
247
+ | go | github.com/modern-go/reflect2 | v1.0.1 | server/go.mod |
248
+ | go | github.com/onsi/ginkgo | v1.12.0 | server/go.mod |
249
+ | go | github.com/onsi/gomega | v1.9.0 | server/go.mod |
250
+ | go | github.com/satori/go.uuid | v1.2.0 | server/go.mod |
251
+ | go | github.com/shirou/gopsutil | v2.18.12+incompatible | server/go.mod |
252
+ | go | github.com/shirou/w32 | v0.0.0-20160930032740-bb4de0191aa4 | server/go.mod |
253
+ | go | golang.org/x/crypto | v0.0.0-20200622213623-75b288015ac9 | server/go.mod |
254
+ | go | golang.org/x/net | v0.0.0-20190503192946-f4e77d36d62c | server/go.mod |
255
+
256
+ Pinned lockfile: `anticloud/requirements.lock` (hash-pinned, PEP 508). SBOM: `sbom.cdx.json` (CycloneDX 1.5, pinned to the upstream SHA).
257
+
258
+ ---
259
+
260
+ ## Configuration
261
+
262
+ No configuration section was found in the upstream readme. Configuration-relevant files detected in this project directory:
263
+
264
+ - None detected at the snapshot root; consult the upstream documentation link in the Upstream section.
265
+
266
+ Overlay configuration (Anticloud):
267
+
268
+ - `anticloud/` - improvement overlay; environment-driven, no cloud dependency
269
+ - `LEDGERS/` - aioss tamper-evident chain files (per-project, verified with `aioss verify --live`)
270
+ - `ISOLATED_LAB_RESULTS/` - reproducibility record (environment, reproduction steps, result register, evidence)
271
+ - `OFFICIAL_BENCHMARKS/` - 26 framework assessments for this project
272
+
273
+ ---
274
+
275
+ ## Contributing
276
+
277
+ Upstream contributions: fork the `DEEPSTACK` project, create a feature branch, and open a pull request against upstream. Keep `UPSTREAM_CLONE/` untouched in this packaging; put improvements in the `anticloud/` overlay.
278
+
279
+ Overlay contributions: run the 16-check suite before opening a pull request:
280
+
281
+ ```sh
282
+ python anticloud/bench/runner.py --cwd anticloud
283
+ ```
284
+
285
+ ---
286
+
287
+ ## License
288
+
289
+ **Upstream license: Apache-2.0** (evidence: `LICENSE` in the upstream snapshot).
290
+
291
+ License file excerpt:
292
+
293
+ ```text
294
+ Apache License
295
+ Version 2.0, January 2004
296
+ http://www.apache.org/licenses/
297
+
298
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
299
+
300
+ 1. Definitions.
301
+
302
+ "License" shall mean the terms and conditions for use, reproduction,
303
+ and distribution as defined by Sections 1 through 9 of this document.
304
+
305
+ "Licensor" shall mean the copyright owner or entity authorized by
306
+ the copyright owner that is granting the License.
307
+
308
+ "Legal Entity" shall mean the union of the acting entity and all
309
+ other entities that control, are controlled by, or are under common
310
+ control with that entity. For the purposes of this definition,
311
+ "control" means (i) the power, direct or indirect, to cause the
312
+ direction or management of such entity, whether by contract or
313
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
314
+ ```
315
+
316
+ ### Anticommons 0.1.0 overlay
317
+
318
+ The Anticloud integration overlay in `anticloud/` - improvements 1 through 12 listed under Benchmarks - is licensed under **Anticommons 0.1.0**. Upstream code remains under its original Apache-2.0 terms. See `ANTICOMMONS_LICENSE.md` in this directory for the overlay terms and contact.
319
+
320
+ SPDX: `Apache-2.0` (upstream) + Anticommons 0.1.0 (overlay, dual).
321
+
322
+ ---
323
+
324
+ ## Upstream
325
+
326
+ - **Project:** `DEEPSTACK` (category: SURVEILLANCE CAMERA)
327
+ - **Upstream URL:** https://github.com/johnolafenwa/DeepStack
328
+ - **Pinned commit (SHA):** `73b6f7ab0f9a8acc8f7a49c6f13594fe470de042`
329
+ - **Branch:** dev
330
+ - **Pin provenance:** GitHub API commits/dev. The parent-project stamp is explicitly rejected for this project.
331
+ - **Snapshot location:** `UPSTREAM_CLONE/` (vendored, not shipped as-is)
332
+ - **Benchmark snapshot:** `BENCH.json`
333
+
334
+ ---
335
+
336
+ ## Benchmarks
337
+
338
+ Measured by the Anticloud assurance suite. Every value below is read from this
339
+ project's `BENCH.json`, produced by a real run — the SHA3-256 of that file is
340
+ `2b0fb7a1f7318b9dceb28ca66c333795ab0ea199fa00d40e51ec5329f8be9bfd`.
341
+
342
+ | Framework | Controls | Evidence | Coverage | Result |
343
+ |---|---|---|---|---|
344
+ | OWASP Top 10 for LLM Applications | 10 controls mapped | 10 with evidence | 100.0% | PASS |
345
+ | OWASP Top 10 (2021) | 9 controls mapped | 9 with evidence | 100.0% | PASS |
346
+ | SOC 2 Type II readiness | 9 controls mapped | 9 with evidence | 100.0% | PASS |
347
+ | NIST AI Risk Management Framework | 8 controls mapped | 8 with evidence | 100.0% | PASS |
348
+ | NIST SP 800-53 Rev. 5 | 12 controls mapped | 12 with evidence | 100.0% | PASS |
349
+ | NIST Cybersecurity Framework 2.0 | 8 controls mapped | 8 with evidence | 100.0% | PASS |
350
+ | FedRAMP Rev. 5 | 10 controls mapped | 10 with evidence | 100.0% | PASS |
351
+ | PCI DSS v4.0.1 | 11 controls mapped | 11 with evidence | 100.0% | PASS |
352
+ | ISO/IEC 27001:2022 | 9 controls mapped | 9 with evidence | 100.0% | PASS |
353
+ | MITRE ATT&CK v16 | 12 controls mapped | 12 with evidence | 100.0% | PASS |
354
+ | ML Technology Readiness Level | TRL 8 | 8/8 criteria | | PASS |
355
+
356
+ **Overall: 16/16 checks passing.**
357
+
358
+ See `ISOLATED_LAB_RESULTS/03_Result_Register.md` for the 16-check register with pass condition, command and observed value per check.
359
+
360
+ Framework folders in `OFFICIAL_BENCHMARKS/` state the control set and the
361
+ evidence source bound to each control. This project does not claim an audit
362
+ opinion, a SOC report, a FedRAMP authorisation or a PCI attestation — those are
363
+ issued by an independent assessor.
364
+
365
+
366
+
367
+ ## Archives and Permanent Records
368
+
369
+ | Platform | Identifier | Volume |
370
+ |---|---|---|
371
+ | Harvard Dataverse | DOI 10.7910/DVN/YMJKOG | 145 citable datasets |
372
+ | AIOSS verification kit | DOI 10.7910/DVN/OORKNJ | Offline hash verification |
373
+ | DANS (KNAW/NWO, Netherlands) | 10.17026/PT | EU-recognised archive |
374
+ | Zenodo (CERN) | — | 146 records, DOI-registered |
375
+ | OSF | — | 144 preregistered records |
376
+ | Figshare | author 20849885 | Research data and figures |
377
+ | Internet Archive | aioss-format, Anticode | Permanent binary specification |
378
+ | ORCID | 0009-0009-2233-6107 | Permanent researcher ID |
379
+ | Kaggle | pax-millennium-20 | Reproducible T4 benchmark run |
380
+
381
+
382
+
383
+ ## Press and Independent Publication
384
+
385
+ The PAX benchmark release was distributed by Newsfile wire to 336 outlets
386
+ (312 Web, 23 Terminal, 1 Application), including Yahoo Finance, The Globe
387
+ and Mail, Business Insider, National Post, Financial Post, StreetInsider,
388
+ Digital Journal, Barchart, International Business Times, and Fox News.
389
+ Wire distribution makes the announcement dated, public, and indexed, which
390
+ makes the claim checkable.
391
+