cpp-package/inspireface/doc/CMake-Option.md

# Overview of CMake Option for Compilation

Here are the translation details for the compilation parameters as per your requirement:

| **Parameter**                         | **Default Value** | **Description**                                                                                                                                            |
|---------------------------------------| :---: |------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ISF_THIRD_PARTY_DIR                   | 3rdparty | Path for required third-party libraries                                                                                                                    |
| ISF_SANITIZE_ADDRESS                      | OFF | Enable AddressSanitizer for memory error detection                                                                                                         |
| ISF_SANITIZE_LEAK                         | OFF | Enable LeakSanitizer to detect memory leaks                                                                                                                |
| ISF_ENABLE_RKNN                           | OFF | Enable RKNN for Rockchip embedded devices                                                                                                                  |
| ISF_RK_DEVICE_TYPE                        | RV1109RV1126 | Target device model for Rockchip(Supports RV1109RV1126, RV1106, RV356X) |
| ISF_RK_COMPILER_TYPE | armhf | The **armhf**, **armhf-uclibc** and aarch64 compilers are supported. Select one based on the actual situation |
| ISF_ENABLE_RGA | OFF | Enable **RGA** image acceleration on Rockchip devices (currently only supported on devices using **RKNPU2**) |
| ISF_BUILD_LINUX_ARM7                      | OFF | Compile for ARM7 architecture                                                                                                                              |
| ISF_BUILD_LINUX_AARCH64                   | OFF | Compile for AARCH64 architecture                                                                                                                           |
| ISF_BUILD_WITH_TEST                       | OFF | Compile test case programs                                                                                                                                 |
| ISF_BUILD_WITH_SAMPLE                     | ON | Compile sample programs                                                                                                                                    |
| ISF_BUILD_SHARED_LIBS                     | ON | Compile shared libraries                                                                                                                                   |
| ISF_ENABLE_BENCHMARK                      | OFF | Enable Benchmark tests for test cases                                                                                                                      |
| ISF_ENABLE_USE_LFW_DATA                   | OFF | Enable using LFW data for test cases                                                                                                                       |
| ISF_ENABLE_TEST_EVALUATION                | OFF | Enable evaluation functionality for test cases, must be used together with ISF_ENABLE_USE_LFW_DATA                                                         |
| ISF_ENABLE_TENSORRT | OFF | Enable the backend of inference using TensorRT, Linux must be on **NVIDIA devices**, and **CUDA**, **TensorRT-10** must be installed |
| TENSORRT_ROOT | /usr/local/TensorRT | **TensorRT-10** installation path |
| ISF_GLOBAL_INFERENCE_BACKEND_USE_MNN_CUDA | OFF | Enable global MNN_CUDA inference mode, requires device support for CUDA                                                                                    |
| ISF_LINUX_MNN_CUDA                        | "" | Specific MNN library path, requires pre-compiled MNN library supporting MNN_CUDA, only effective when ISF_GLOBAL_INFERENCE_BACKEND_USE_MNN_CUDA is enabled |
| ISF_ENABLE_APPLE_EXTENSION | OFF | If you are using an **Apple device (MacOS/iOS)**, you can enable it to allow some parts of the SDK's models to switch to certain backend neural network acceleration inference on Apple devices, such as Metal and ANE |
| ISF_MNN_CUSTOM_SOURCE | "" | Using this option to replace different versions of MNN, the input must be the root directory of the MNN source code |
| INSPIRECV_BACKEND_OPENCV | OFF | The image processing backend relies on OpenCV and is **not recommended** |
| ISF_ENABLE_COST_TIME | OFF | This parameter can be used to print the time of some important compute nodes in the Debug state |
| ISF_NEVER_USE_OPENCV | ON | When you need to use OpenCV as the image processing engine, you need to turn this option off |
Add the inspireface project to cpp-package. 2024-05-02 01:27:29 +08:00			`# Overview of CMake Option for Compilation`

			`Here are the translation details for the compilation parameters as per your requirement:`

Update InspireFace to 1.0.1 2024-05-08 14:19:31 +08:00			`\| Parameter \| Default Value \| Description \|`
Update inspireface to 1.2.0 2025-03-25 00:51:26 +08:00			`\|---------------------------------------\| :---: \|------------------------------------------------------------------------------------------------------------------------------------------------------------\|`
Update InspireFace to 1.0.1 2024-05-08 14:19:31 +08:00			`\| ISF_THIRD_PARTY_DIR \| 3rdparty \| Path for required third-party libraries \|`
			`\| ISF_SANITIZE_ADDRESS \| OFF \| Enable AddressSanitizer for memory error detection \|`
			`\| ISF_SANITIZE_LEAK \| OFF \| Enable LeakSanitizer to detect memory leaks \|`
			`\| ISF_ENABLE_RKNN \| OFF \| Enable RKNN for Rockchip embedded devices \|`
Update inspireface to 1.2.0 2025-03-25 00:51:26 +08:00			`\| ISF_RK_DEVICE_TYPE \| RV1109RV1126 \| Target device model for Rockchip(Supports RV1109RV1126, RV1106, RV356X) \|`
			`\| ISF_RK_COMPILER_TYPE \| armhf \| The armhf, armhf-uclibc and aarch64 compilers are supported. Select one based on the actual situation \|`
			`\| ISF_ENABLE_RGA \| OFF \| Enable RGA image acceleration on Rockchip devices (currently only supported on devices using RKNPU2) \|`
Update InspireFace to 1.0.1 2024-05-08 14:19:31 +08:00			`\| ISF_BUILD_LINUX_ARM7 \| OFF \| Compile for ARM7 architecture \|`
			`\| ISF_BUILD_LINUX_AARCH64 \| OFF \| Compile for AARCH64 architecture \|`
			`\| ISF_BUILD_WITH_TEST \| OFF \| Compile test case programs \|`
			`\| ISF_BUILD_WITH_SAMPLE \| ON \| Compile sample programs \|`
			`\| ISF_BUILD_SHARED_LIBS \| ON \| Compile shared libraries \|`
			`\| ISF_ENABLE_BENCHMARK \| OFF \| Enable Benchmark tests for test cases \|`
			`\| ISF_ENABLE_USE_LFW_DATA \| OFF \| Enable using LFW data for test cases \|`
			`\| ISF_ENABLE_TEST_EVALUATION \| OFF \| Enable evaluation functionality for test cases, must be used together with ISF_ENABLE_USE_LFW_DATA \|`
Update inspireface to 1.2.0 2025-03-25 00:51:26 +08:00			`\| ISF_ENABLE_TENSORRT \| OFF \| Enable the backend of inference using TensorRT, Linux must be on NVIDIA devices, and CUDA, TensorRT-10 must be installed \|`
			`\| TENSORRT_ROOT \| /usr/local/TensorRT \| TensorRT-10 installation path \|`
Update InspireFace to 1.0.1 2024-05-08 14:19:31 +08:00			`\| ISF_GLOBAL_INFERENCE_BACKEND_USE_MNN_CUDA \| OFF \| Enable global MNN_CUDA inference mode, requires device support for CUDA \|`
			`\| ISF_LINUX_MNN_CUDA \| "" \| Specific MNN library path, requires pre-compiled MNN library supporting MNN_CUDA, only effective when ISF_GLOBAL_INFERENCE_BACKEND_USE_MNN_CUDA is enabled \|`
Update inspireface to 1.2.0 2025-03-25 00:51:26 +08:00			`\| ISF_ENABLE_APPLE_EXTENSION \| OFF \| If you are using an Apple device (MacOS/iOS), you can enable it to allow some parts of the SDK's models to switch to certain backend neural network acceleration inference on Apple devices, such as Metal and ANE \|`
			`\| ISF_MNN_CUSTOM_SOURCE \| "" \| Using this option to replace different versions of MNN, the input must be the root directory of the MNN source code \|`
			`\| INSPIRECV_BACKEND_OPENCV \| OFF \| The image processing backend relies on OpenCV and is not recommended \|`
			`\| ISF_ENABLE_COST_TIME \| OFF \| This parameter can be used to print the time of some important compute nodes in the Debug state \|`
			`\| ISF_NEVER_USE_OPENCV \| ON \| When you need to use OpenCV as the image processing engine, you need to turn this option off \|`