You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 6, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/api/computer-vision-sdk-apis.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ For practical examples of applications using the Computer Vision APIs, refer to
51
51
To find compatibility between the ACAP Computer Vision solution and AXIS OS version,
52
52
refer to [Find the right SDK for software compatibility](../axis-devices-and-compatibility/#find-the-right-sdk-for-software-compatibility).
53
53
54
-
# Axis APIs
54
+
##Axis APIs
55
55
56
56
The ACAP Runtime service provides the Axis APIs:
57
57
@@ -74,15 +74,15 @@ By utilizing these wrappers, you can avoid building the gRPC client-side code fo
74
74
75
75
---
76
76
77
-
## Video capture API
77
+
###Video capture API
78
78
79
79
The Video capture API is one of the services of ACAP Runtime.
80
80
81
81
The ACAP Computer Vision solution offers a mechanism for capturing frames using the ACAP Runtime. By sending a gRPC request to the ACAP runtime, users can establish a video stream and retrieve frames.
82
82
83
83
The Python client is accessible within the ACAP Runtime proto image at `/build/vdo/proto_utils` and is imported into Python as `VideoCaptureClient`, located within the `vdo_proto_utils` module. This client exposes the `get_frame` function, facilitating frame retrieval and parsing.
84
84
85
-
### The VideoCapture object
85
+
####The VideoCapture object
86
86
87
87
To instantiate a VideoCaptureClient object, you need to provide the ACAP runtime communication socket, along with the desired stream dimensions and framerate.
88
88
In some cases, this call could take up to two minutes, if the ACAP runtime is busy doing other tasks like loading a machine learning model on start up.
@@ -98,13 +98,13 @@ An image frame can be read with the following line of code
98
98
frame = capture_client.get_frame()
99
99
```
100
100
101
-
### VideoCapture requirements
101
+
####VideoCapture requirements
102
102
103
103
For the video capture client to work, it is required that the ACAP runtime is installed and running.
104
104
The application and the ACAP runtime need to share a socket file to allow the gRPC communication.
105
105
To achieve this, a volume needs to be mounted between the application and the ACAP runtime container.
106
106
107
-
### Code Examples
107
+
####Code Examples
108
108
109
109
-[opencv-qr-decoder-python](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples-staging/blob/main/opencv-qr-decoder-python/docker-compose.yml) - A minimal example of a QR code detector and decoder application written in Python.
110
110
-[minimal-ml-inference](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/tree/main/minimal-ml-inference) - A minimal, but complete, example of how a Python client and a model server running on the same camera.
@@ -115,15 +115,15 @@ To achieve this, a volume needs to be mounted between the application and the AC
115
115
116
116
---
117
117
118
-
## Machine learning API
118
+
###Machine learning API
119
119
120
120
The Machine learning API is one of the services of ACAP Runtime.
121
121
122
122
The ACAP Computer Vision solution provides a flexible way of allowing machine learning inference in the form of TensorFlow Serving and a TensorFlow Serving client. TensorFlow Serving allows for making inference calls over gRPC to another container, the inference server, and a model server. This has several benefits, including exposing a common API for inference and having a single process handle all apps DLPU communication.
123
123
124
124
The Python client is available in the ACAP runtime proto image under `/build/tf/proto_utils` and imported in Python as `InferenceClient`, which is available in the `tf_proto_utils` module. The client exposes a single `infer(inputs, model_name)` function that enables an easy inference from the main application that will also be connected to the model server.
125
125
126
-
### Code Examples
126
+
####Code Examples
127
127
128
128
-[minimal-ml-inference](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/tree/main/minimal-ml-inference) - A minimal, but complete, example of how a Python client and a model server running on the same camera.
129
129
-[object-detector-python](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/tree/main/object-detector-python) - An example written in Python that implements the following object detection scenarios:
@@ -133,7 +133,7 @@ The Python client is available in the ACAP runtime proto image under `/build/tf/
133
133
134
134
---
135
135
136
-
## BETA - Parameter API
136
+
###BETA - Parameter API
137
137
138
138
**This API is a [Beta version](./beta-api) and developers are encouraged to test and leave feedback.**
139
139
@@ -151,13 +151,13 @@ root.Brand.ProdFullName
151
151
root.Brand.ProdNbr
152
152
```
153
153
154
-
### Code Examples
154
+
####Code Examples
155
155
156
156
-[parameter-api-python](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/tree/main/parameter-api-python) - A Python example which reads device parameters using the Parameter API.
157
157
158
158
---
159
159
160
-
# Python packages
160
+
##Python packages
161
161
162
162
The ACAP Computer Vision solution allows for the installation and use of Python packages that support the ACAP architecture `aarch64`. This includes, but is not limited to:
0 commit comments