diff --git a/doc/benchmark.md b/doc/benchmark.md index 4dfab1239b322fed507f9e504672f2cedcd292f1..789c32211ceffd67948b59d4dcc64e6de4795b82 100644 --- a/doc/benchmark.md +++ b/doc/benchmark.md @@ -6,8 +6,28 @@ SPDX-License-Identifier: Apache-2.0 # Benchmarking KleidiCV -Building of KleidiCV's benchmarks can be enabled with the `cmake` argument `-DKLEIDICV_BENCHMARK=ON`. +KleidiCV has a small set of benchmarks to test the performance of some of its APIs. + +Building of the benchmarks can be enabled with the `cmake` argument `-DKLEIDICV_BENCHMARK=ON`. + +Benchmarks should be built in Release mode via the `CMAKE_BUILD_TYPE` parameter. +Building is otherwise as described in the [building documentation](building.md). + +For example, on Linux: +``` +cmake -S /path/to/kleidicv -B build-kleidicv-linux \ + -DCMAKE_BUILD_TYPE=Release \ + -DKLEIDICV_BENCHMARK=ON +cmake --build build-kleidicv-linux --parallel +``` + +The resulting benchmark binary will be available in the build folder at `benchmark/kleidicv-benchmark`. + The benchmarks are based on [Google Benchmark](https://github.com/google/benchmark). -All the standard Google Benchmark command line arguments can be used. In addition, -the image size on which the tests will be run can be set with the command line -options `--image_width=123` and `--image_height=123`. +All the standard Google Benchmark command line arguments can be used. + +By default, benchmarks will be run on an image size of 1280*720. +The image size can be changed via the command line options +`--image_width=` and `--image_height=`. For example, to run the +benchmarks for a "4K" image size use the options +`--image_width=3840 --image_height=2160`. diff --git a/doc/test.md b/doc/test.md index a2bebb5ea54c94d82a2b5d905a7586ff3a6ce798..51738cc31e87ec56b0c01895968fbad3978ac8c8 100644 --- a/doc/test.md +++ b/doc/test.md @@ -6,10 +6,17 @@ SPDX-License-Identifier: Apache-2.0 # Testing KleidiCV -[Build](build.md) KleidiCV API tests using the target `kleidicv-api-test`. +To verify whether all KleidiCV APIs behave as expected without running +OpenCV or any sample applications, you can run KleidiCV's API tests. -The tests use the [GoogleTest](https://github.com/google/googletest) -testing framework and accept the standard GoogleTest arguments. +These tests are based on the [GoogleTest](https://github.com/google/googletest) +test framework. -A [coverage report](https://kleidi.sites.arm.com/kleidicv/coverage/coverage_report.html) -is generated based on this testing. +Creating a standalone build as described in the [build documentation](build.md) +will create a command line executable in the build folder at +`test/api/kleidicv-api-test`. + +Running the executable with no arguments will run all the tests. The +executable also accepts the standard GoogleTest command line options. +Run the executable with the argument `--help` to see the full list of +accepted options.