Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Commit a2a1fc3

Browse files
committed
computer-vision-sdk-apis: Align section level to native api page
1 parent 34a5405 commit a2a1fc3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/api/computer-vision-sdk-apis.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ For practical examples of applications using the Computer Vision APIs, refer to
5151
To find compatibility between the ACAP Computer Vision solution and AXIS OS version,
5252
refer to [Find the right SDK for software compatibility](../axis-devices-and-compatibility/#find-the-right-sdk-for-software-compatibility).
5353

54-
## Axis APIs
54+
# Axis APIs
5555

5656
The ACAP Runtime service provides the Axis APIs:
5757

@@ -72,17 +72,17 @@ Additionally, the ACAP Runtime repository provides pre-built gRPC Python wrapper
7272

7373
By utilizing these wrappers, you can avoid building the gRPC client-side code for Python yourself, streamlining the process of integrating and using the ACAP Runtime APIs in your application.
7474

75-
### Video capture API
7675
---
7776

77+
## Video capture API
7878

7979
The Video capture API is one of the services of ACAP Runtime.
8080

8181
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.
8282

8383
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.
8484

85-
#### The VideoCapture object
85+
### The VideoCapture object
8686

8787
To instantiate a VideoCaptureClient object, you need to provide the ACAP runtime communication socket, along with the desired stream dimensions and framerate.
8888
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
9898
frame = capture_client.get_frame()
9999
```
100100

101-
#### VideoCapture requirements
101+
### VideoCapture requirements
102102

103103
For the video capture client to work, it is required that the ACAP runtime is installed and running.
104104
The application and the ACAP runtime need to share a socket file to allow the gRPC communication.
105105
To achieve this, a volume needs to be mounted between the application and the ACAP runtime container.
106106

107-
#### Code Examples
107+
### Code Examples
108108

109109
- [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.
110110
- [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,25 +115,25 @@ To achieve this, a volume needs to be mounted between the application and the AC
115115

116116
---
117117

118-
### Machine learning API
118+
## Machine learning API
119119

120120
The Machine learning API is one of the services of ACAP Runtime.
121121

122122
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.
123123

124124
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.
125125

126-
#### Code Examples
126+
### Code Examples
127127

128128
- [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.
129129
- [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:
130130
- Run a video streaming inference on camera.
131131
- Run a still image inference on camera.
132132
- [pose-estimator-with-flask](https://github.com/AxisCommunications/acap-computer-vision-sdk-examples/tree/main/pose-estimator-with-flask) - An example written in Python that implements a pose estimator, that publishes the output using Flask.
133133

134-
### BETA - Parameter API
135134
---
136135

136+
## BETA - Parameter API
137137

138138
**This API is a [Beta version](./beta-api) and developers are encouraged to test and leave feedback.**
139139

@@ -151,13 +151,13 @@ root.Brand.ProdFullName
151151
root.Brand.ProdNbr
152152
```
153153

154-
#### Code Examples
154+
### Code Examples
155155

156156
- [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.
157157

158-
## Python packages
159158
---
160159

160+
# Python packages
161161

162162
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:
163163

0 commit comments

Comments
 (0)