Skip to content

Commit 4234a33

Browse files
Refactor documentation for KleidiCV build options and standardize test section headings
1 parent ea52c7b commit 4234a33

File tree

2 files changed

+6
-17
lines changed

2 files changed

+6
-17
lines changed

content/learning-paths/laptops-and-desktops/kleidicv-on-mac/build-1.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -151,26 +151,15 @@ KleidiCV provides several CMake options to control which instruction sets and fe
151151

152152
Here are the most important options for Arm systems:
153153

154-
- **KLEIDICV_ENABLE_SVE2**
155-
Enables Scalable Vector Extension 2 (SVE2) code paths. This is on by default for popular compilers that support SVE2, but off otherwise.
156-
157-
- **KLEIDICV_LIMIT_SVE2_TO_SELECTED_ALGORITHMS**
158-
Limits SVE2 code paths to algorithms where SVE2 is expected to outperform other options. This is on by default. It has no effect if SVE2 is disabled.
159-
160-
- **KLEIDICV_BENCHMARK**
161-
Enables building KleidiCV benchmarks. The benchmarks use Google Benchmark, which is downloaded automatically. This is off by default.
162-
163-
- **KLEIDICV_ENABLE_SME2**
164-
Enables Scalable Matrix Extension 2 (SME2) and Streaming SVE code paths. This is off by default while the ACLE SME specification is in beta.
165-
166-
- **KLEIDICV_LIMIT_SME2_TO_SELECTED_ALGORITHMS**
167-
Limits SME2 code paths to cases where SME2 is expected to provide a benefit. This is on by default. It has no effect if SME2 is disabled.
154+
- KLEIDICV_ENABLE_SVE2 enables Scalable Vector Extension 2 (SVE2) code paths. This is on by default for popular compilers that support SVE2, but off otherwise.
155+
- KLEIDICV_LIMIT_SVE2_TO_SELECTED_ALGORITHMS limits SVE2 code paths to algorithms where SVE2 is expected to outperform other options. This is on by default. It has no effect if SVE2 is disabled.
156+
- KLEIDICV_BENCHMARK enables building KleidiCV benchmarks. The benchmarks use Google Benchmark, which is downloaded automatically. This is off by default.
157+
- KLEIDICV_ENABLE_SME2 enables Scalable Matrix Extension 2 (SME2) and Streaming SVE code paths. This is off by default while the ACLE SME specification is in beta.
158+
- KLEIDICV_LIMIT_SME2_TO_SELECTED_ALGORITHMS limits SME2 code paths to cases where SME2 is expected to provide a benefit. This is on by default. It has no effect if SME2 is disabled.
168159

169160
You can set these options when running `cmake` to customize your build for your hardware and use case.
170161

171-
{{% notice Note %}}
172162
KleidiCV automatically selects the fastest available code path for your hardware. If the library detects that SVE2 (Scalable Vector Extension 2) or SME2 (Scalable Matrix Extension 2) is slower than NEON for a specific function, it defaults to NEON—unless you explicitly turn off this behavior by setting `-DKLEIDICV_LIMIT_SVE2_TO_SELECTED_ALGORITHMS=OFF` or `-DKLEIDICV_LIMIT_SME2_TO_SELECTED_ALGORITHMS=OFF`.
173-
{{% /notice %}}
174163

175164
## Build the KleidiCV standalone
176165

content/learning-paths/laptops-and-desktops/kleidicv-on-mac/run-test-2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 3
66
layout: learningpathall
77
---
88

9-
## Run the Test
9+
## Run the test
1010

1111
Once the build steps are complete, you can run the KleidiCV and OpenCV tests.
1212
The KleidiCV API test checks the public C++ API and confirms that the build is working as expected. To run the test, use the following command:

0 commit comments

Comments
 (0)