Add external server return format to ReadMe (#175)

This adds the Doods2 json format as an example of the required return data from the external server.

Signed-off-by: Test Account <azgeorgi@noreply.localhost>

Reviewed-on: #175
Co-authored-by: Test Account <azgeorgi@noreply.localhost>
Co-committed-by: Test Account <azgeorgi@noreply.localhost>
This commit is contained in:
2024-04-19 14:03:51 -07:00
committed by Justin Georgi
parent 8ca4932177
commit d090d955d2

View File

@@ -58,3 +58,13 @@ ALVINN can use an external object detection server instead of the built in model
| `name` | identifier for external server | *none* | | `name` | identifier for external server | *none* |
| `address` | ip or url of external server | *none* | | `address` | ip or url of external server | *none* |
| `port` | port to access on external server | 9001 | | `port` | port to access on external server | 9001 |
The external server's response must be json with a `detections` key that contains an array of the detected structure labels, bounding box data, and confidence values.
```
{
"detections": [
{"top": 0.1, "left": 0.1, "bottom": 0.9, "right": 0.9, "label": "dog", "confidence": 90.0 }
...
],
}
```