-
Notifications
You must be signed in to change notification settings - Fork 2
/
modulesettings.json
244 lines (231 loc) · 11.7 KB
/
modulesettings.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
{
"Modules": {
"ObjectDetectionYOLOv5-3.1": {
"Name": "Object Detection (YOLOv5 3.1)",
"Version": "1.12.2",
"PublishingInfo" : {
"Description": "Provides Object Detection using YOLOv5 3.1 targeting CUDA 10 or 11 for older GPUs.",
"Category": "Computer Vision",
"Stack": "Python, PyTorch, YOLO",
"License": "GPL-3.0",
"LicenseUrl": "https://opensource.org/licenses/GPL-3.0",
"Author": "Chris Maunder, Matthew Dennis",
"Homepage": "https://github.com/codeproject/CodeProject.AI-Server/",
"BasedOn": "Deepstack",
"BasedOnUrl": "https://github.com/johnolafenwa/DeepStack"
},
"LaunchSettings": {
"AutoStart": false,
"FilePath": "detect_adapter.py",
"Runtime": "python3.8",
"RuntimeLocation": "Local", // Can be Local, Shared or System
"PostStartPauseSecs": 1, // Generally 1 if using GPU, 0 for CPU
"Queue": "objectdetection_queue", // We make all Object detectors use the same queue.
"Parallelism": 0 // 0 = Default = number of CPUs / 2
},
"EnvironmentVariables": {
"PROFILE": "desktop_gpu",
"YOLOv5_VERBOSE": "false",
"USE_CUDA": "True",
"MODE": "MEDIUM",
"APPDIR": "%CURRENT_MODULE_PATH%",
"DATA_DIR": "%DATA_DIR%",
"TEMP_PATH": "%CURRENT_MODULE_PATH%/tempstore",
"MODELS_DIR": "%CURRENT_MODULE_PATH%/assets"
},
"GpuOptions" : {
"InstallGPU": true,
"EnableGPU": true, // Will be coerced to false if InstallGPU = false
"AcceleratorDeviceName": null, // = default
"HalfPrecision": "enable" // 'Force', 'Enable', 'Disable': whether to force on, allow, or disable half-precision ops
},
"InstallOptions" : {
"Platforms": [ "all", "!macos-arm64" ], // macos-arm64 should use the YOLOv5 6.2
"ModuleReleases": [ // Which server version is compatible with each version of this module.
{ "ModuleVersion": "1.0", "ServerVersionRange": [ "1.0", "2.0.8" ], "ReleaseDate": "2022-11-01" },
{ "ModuleVersion": "1.2", "ServerVersionRange": [ "2.1", "2.1.6" ], "ReleaseDate": "2023-03-20", "ReleaseNotes": "Updated for CodeProject.AI Server 2.1" },
{ "ModuleVersion": "1.3", "ServerVersionRange": [ "2.1", "2.1.12" ], "ReleaseDate": "2023-05-17", "ReleaseNotes": "Updated module settings", "Importance": "Minor" },
{ "ModuleVersion": "1.4", "ServerVersionRange": [ "2.2", "2.2.4" ], "ReleaseDate": "2023-09-09", "ReleaseNotes": "Updated installer" },
{ "ModuleVersion": "1.5", "ServerVersionRange": [ "2.2", "2.2.4" ], "ReleaseDate": "2023-09-16", "ReleaseNotes": "Updates to help Blue Iris users" },
{ "ModuleVersion": "1.6", "ServerVersionRange": [ "2.3.0", "2.3.0" ], "ReleaseDate": "2023-10-01", "ReleaseNotes": "Updated to match new installer SDK." },
{ "ModuleVersion": "1.6.1", "ServerVersionRange": [ "2.3.1", "2.3.5" ], "ReleaseDate": "2023-10-10", "ReleaseNotes": "Updated to match new installer SDK." },
{ "ModuleVersion": "1.6.3", "ServerVersionRange": [ "2.3.5", "2.3.5" ], "ReleaseDate": "2023-11-06", "ReleaseNotes": "Installer updates", "Importance": "Minor" },
{ "ModuleVersion": "1.6.4", "ServerVersionRange": [ "2.4.0", "2.4.0" ], "ReleaseDate": "2023-12-04", "ReleaseNotes": "Mesh support and a new module Id" },
{ "ModuleVersion": "1.6.5", "ServerVersionRange": [ "2.4.1", "2.4.1" ], "ReleaseDate": "2023-12-06", "ReleaseNotes": "Updated modulesettings schema", "Importance": "Minor" },
{ "ModuleVersion": "1.6.6", "ServerVersionRange": [ "2.4.2", "2.4.7" ], "ReleaseDate": "2023-12-09", "ReleaseNotes": "Installer updates", "Importance": "Minor" },
{ "ModuleVersion": "1.7", "ServerVersionRange": [ "2.4.2", "2.4.7" ], "ReleaseDate": "2023-12-15", "ReleaseNotes": "Re-enabled CUDA 11 support" },
{ "ModuleVersion": "1.8.0", "ServerVersionRange": [ "2.5.0-RC1", "2.5.0-RC5" ], "ReleaseDate": "2024-01-06", "ReleaseNotes": "Additions for dynamic explorer UI" },
{ "ModuleVersion": "1.8.1", "ServerVersionRange": [ "2.5.0-RC1", "2.5.0-RC1" ], "ReleaseDate": "2024-01-13", "ReleaseNotes": "Changes to SDK" },
{ "ModuleVersion": "1.8.2", "ServerVersionRange": [ "2.5.0-RC6", "" ], "ReleaseDate": "2024-01-16", "ReleaseNotes": "Updated modulesettings schema" },
{ "ModuleVersion": "1.8.3", "ServerVersionRange": [ "2.5.0-RC6", "" ], "ReleaseDate": "2024-01-18", "ReleaseNotes": "Updated explorer" },
{ "ModuleVersion": "1.9.0", "ServerVersionRange": [ "2.5.0-RC6", "" ], "ReleaseDate": "2024-01-21", "ReleaseNotes": "Module performance statistics added" },
{ "ModuleVersion": "1.9.1", "ServerVersionRange": [ "2.5.2", "2.6.0" ], "ReleaseDate": "2024-02-08", "ReleaseNotes": "Support for CodeProject.AI Server 2.5.2" },
{ "ModuleVersion": "1.9.2", "ServerVersionRange": [ "2.6.1", "2.7.0" ], "ReleaseDate": "2024-04-01", "ReleaseNotes": "Tweaked settings for RPi docker" },
{ "ModuleVersion": "1.9.3", "ServerVersionRange": [ "2.6.1", "2.7.0" ], "ReleaseDate": "2024-04-01", "ReleaseNotes": "Corrections to PIPs" },
{ "ModuleVersion": "1.10.0", "ServerVersionRange": [ "2.6.5", "2.7.0" ], "ReleaseDate": "2024-04-25", "ReleaseNotes": "Updated for CodeProject.AI Server 2.7" },
{ "ModuleVersion": "1.11.0", "ServerVersionRange": [ "2.8.0", "2.9.3" ], "ReleaseDate": "2024-08-02", "ReleaseNotes": "Updated for server 2.8" },
{ "ModuleVersion": "1.12.0", "ServerVersionRange": [ "2.8.0", "2.9.3" ], "ReleaseDate": "2024-11-23", "ReleaseNotes": "Improved CUDA 12 support" },
{ "ModuleVersion": "1.12.1", "ServerVersionRange": [ "2.9.4", "" ], "ReleaseDate": "2024-11-26", "ReleaseNotes": "Support for dual Ubuntu/Debian install" },
{ "ModuleVersion": "1.12.2", "ServerVersionRange": [ "2.9.4", "" ], "ReleaseDate": "2024-12-07", "ReleaseNotes": "Tweaked torch.load for CUDA" }
]
},
"ModelRequirements" : [{
"Task": "Object Detection",
"Architecture": "YOLOv5",
"Format": "PyTorch"
}],
"UIElements" : {
"Menus": [
{
"Label": "Half Precision",
"Options": [
{ "Label": "Force on", "Setting": "CPAI_HALF_PRECISION", "Value": "force" },
{ "Label": "Use Default", "Setting": "CPAI_HALF_PRECISION", "Value": "enable" },
{ "Label": "Disable", "Setting": "CPAI_HALF_PRECISION", "Value": "disable" }
]
},
{
"Label": "Model Size",
"Options": [
{ "Label": "Tiny", "Setting": "MODEL_SIZE", "Value": "tiny" },
{ "Label": "Small", "Setting": "MODEL_SIZE", "Value": "small" },
{ "Label": "Medium", "Setting": "MODEL_SIZE", "Value": "medium" },
{ "Label": "Large", "Setting": "MODEL_SIZE", "Value": "large" }
]
}]
},
"RouteMaps": [
{
"Name": "Object Detector (YOLOv5 3.1)",
"Route": "vision/detection",
"Method": "POST",
"Command": "detect",
"Description": "Detects multiple objects of 80 types in an image.",
"Inputs": [
{
"Name": "image",
"Type": "File",
"Description": "The HTTP file object (image) to be analyzed."
},
{
"Name": "min_confidence",
"Type": "Float",
"Description": "The minimum confidence level for an object will be detected. In the range 0.0 to 1.0. Default 0.4.",
"DefaultValue": 0.4,
"MinValue": 0.0,
"MaxValue": 1.0
}
],
"Outputs": [
{
"Name": "success",
"Type": "Boolean",
"Description": "True if successful."
},
{
"Name": "message",
"Type": "String",
"Description": "A summary of the inference operation."
},
{
"Name": "error",
"Type": "String",
"Description": "(Optional) An description of the error if success was false."
},
{
"Name": "predictions",
"Type": "Object",
"Description": "An array of objects with the x_max, x_min, max, y_min, label and confidence."
},
{
"Name": "count",
"Type": "Integer",
"Description": "The number of objects found."
},
{
"Name": "inferenceMs",
"Type": "Integer",
"Description": "The time (ms) to perform the AI inference."
},
{
"Name": "processMs",
"Type": "Integer",
"Description": "The time (ms) to process the image (includes inference and image manipulation operations)."
}
]
},
{
"Name": "Custom Object Detector (YOLOv5 3.1)",
"Route": "vision/custom",
"Method": "POST",
"Command": "custom",
"Description": "Detects objects based on YOLO PyTorch models. Models are stored as .pt files in the /ObjectDetectionYOLOv5-3.1/custom-models directory, and to make a call to a specific model use /vision/custom/model-name, where 'model-name' is the name of the model's .pt file",
"Inputs": [
{
"Name": "image",
"Type": "File",
"Description": "The HTTP file object (image) to be analyzed."
},
{
"Name": "min_confidence",
"Type": "Float",
"Description": "The minimum confidence level for an object will be detected. In the range 0.0 to 1.0. Default 0.4."
}
],
"Outputs": [
{
"Name": "success",
"Type": "Boolean",
"Description": "True if successful."
},
{
"Name": "message",
"Type": "String",
"Description": "A summary of the inference operation."
},
{
"Name": "error",
"Type": "String",
"Description": "(Optional) An description of the error if success was false."
},
{
"Name": "predictions",
"Type": "Object[]",
"Description": "An array of objects with the x_max, x_min, max, y_min, label and confidence."
},
{
"Name": "inferenceMs",
"Type": "Integer",
"Description": "The time (ms) to perform the AI inference."
},
{
"Name": "processMs",
"Type": "Integer",
"Description": "The time (ms) to process the image (includes inference and image manipulation operations)."
}
]
},
{
"Name": "Object Detector List Custom Models (YOLOv5 3.1)",
"Route": "vision/custom/list",
"Method": "POST",
"Command": "list-custom",
"Description": "Returns a list of models available.",
"Inputs": [],
"Outputs": [
{
"Name": "success",
"Type": "Boolean",
"Description": "True if successful."
},
{
"Name": "models",
"Type": "String",
"Description": "An array of strings containing the names of the models installed."
}
]
}
]
}
}
}