-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #45 from HyperInspire/feature/3rd
Fix 3rdparty
- Loading branch information
Showing
17 changed files
with
37 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,3 +7,4 @@ test_res/* | |
resource/* | ||
pack/* | ||
*.zip | ||
3rdparty |
This file was deleted.
Oops, something went wrong.
Submodule Catch2
deleted from
182c91
Submodule MNN
deleted from
d20f37
Submodule indicators
deleted from
222382
Submodule inspireface-precompile
deleted from
09c66d
Submodule spdlog
deleted from
27cb4c
Submodule yaml-cpp
deleted from
1d8ca1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,19 +9,30 @@ If you require further information on tracking development branches, CI/CD proce | |
Please contact [[email protected]](mailto:[email protected]?subject=InspireFace) for commercial support, including obtaining and integrating higher accuracy models, as well as custom development. | ||
|
||
## 1. Preparation | ||
### 1.1. Downloading 3rdparty Files | ||
### 1.1. Pull 3rdparty Files | ||
|
||
After pulling the project to your local machine, you need to execute the command to fetch or update the submodules, retrieving the latest submodules online to your local environment. | ||
Clone the `3rdparty` repository from the remote repository into the root directory of the project. Note that this repository contains some submodules. When cloning, you should use the `--recurse-submodules` parameter, or after entering the directory, use `git submodule update --init --recursive` to fetch and synchronize the latest submodules: | ||
|
||
```Bash | ||
# Go to the project root directory | ||
cd InspireFace/ | ||
# Pull the submodule project | ||
# Clone the repository and pull submodules | ||
git clone --recurse-submodules https://github.com/HyperInspire/3rdparty.git | ||
``` | ||
|
||
If you need to update the `3rdparty` repository to ensure it is current, or if you didn't use the `--recursive` parameter during the initial pull, you can run `git submodule update --init --recursive`: | ||
|
||
```bash | ||
# If you're not using recursive pull | ||
git clone https://github.com/HyperInspire/3rdparty.git | ||
|
||
cd 3rdparty | ||
git pull | ||
# Update submodules | ||
git submodule update --init --recursive | ||
``` | ||
|
||
### 1.2. Downloading Pack Files | ||
You can download the pack files containing models and configurations needed for compilation from [Google Drive](https://drive.google.com/drive/folders/1krmv9Pj0XEZXR1GRPHjW_Sl7t4l0dNSS?usp=sharing) and extract them to any location. | ||
### 1.2. Downloading Model Package Files | ||
|
||
You can download the model package files containing models and configurations needed for compilation from [Google Drive](https://drive.google.com/drive/folders/1krmv9Pj0XEZXR1GRPHjW_Sl7t4l0dNSS?usp=sharing) and extract them to any location. | ||
|
||
### 1.3. Installing OpenCV | ||
If you intend to use the SDK locally or on a server, ensure that OpenCV is installed on the host device beforehand to enable successful linking during the compilation process. For cross-compilation targets like Android or ARM embedded boards, you can use the pre-compiled OpenCV libraries provided by **3rdparty/inspireface-precompile/opencv/**. | ||
|
@@ -53,7 +64,7 @@ The '3rdparty' directory already includes the MNN library and specifies a partic | |
CMake option are used to control the various details of the compilation phase. Please select according to your actual requirements. [Parameter table](doc/CMake-Option.md). | ||
|
||
### 2.1. Local Compilation | ||
Make sure OpenCV is installed, you can begin the compilation process. If you are using macOS or Linux, you can quickly compile using the shell scripts provided in the **command/** folder at the project root: | ||
Make sure OpenCV is installed, you can begin the compilation process. If you are using macOS or Linux, you can quickly compile using the shell scripts provided in the `command` folder at the project root: | ||
```bash | ||
cd InspireFace/ | ||
# Execute the local compilation script | ||
|
@@ -80,7 +91,7 @@ export ARM_CROSS_COMPILE_TOOLCHAIN=YOUR_DIR/gcc-arm-8.3-2019.03-x86_64-arm-linux | |
# Execute the cross-compilation script for RV1109/RV1126 | ||
bash command/build_cross_rv1109rv1126_armhf.sh | ||
``` | ||
After the compilation is complete, you can find the compiled results in the **build/inspireface-linux-armv7-rv1109rv1126-armhf** directory. | ||
After the compilation is complete, you can find the compiled results in the `build/inspireface-linux-armv7-rv1109rv1126-armhf` directory. | ||
### 2.3. Supported Platforms and Architectures | ||
We have completed the adaptation and testing of the software across various operating systems and CPU architectures. This includes compatibility verification for platforms such as Linux, macOS, iOS, and Android, as well as testing for specific hardware support to ensure stable operation in diverse environments. | ||
|
||
|
@@ -189,12 +200,12 @@ if (ret != HSUCCEED) { | |
return ret; | ||
} | ||
``` | ||
For more examples, you can refer to the **cpp/sample** sub-project located in the root directory. You can compile these sample executables by enabling the **ISF_BUILD_WITH_SAMPLE** option during the compilation process. | ||
For more examples, you can refer to the `cpp/sample` sub-project located in the root directory. You can compile these sample executables by enabling the `ISF_BUILD_WITH_SAMPLE` option during the compilation process. | ||
|
||
**Note**: For each error code feedback, you can click on this [link](doc/Error-Feedback-Codes.md) to view detailed explanations. | ||
|
||
### 3.2. Python Native Sample | ||
We provide a Python API that allows for more efficient use of the InspireFace library. After compiling the dynamic link library, you need to either symlink or copy it to the **python/inspireface/modules/core** directory within the root directory. You can then start testing by navigating to the **[python/](python/)** directory. Your Python environment will need to have some dependencies installed: | ||
We provide a Python API that allows for more efficient use of the InspireFace library. After compiling the dynamic link library, you need to either symlink or copy it to the `python/inspireface/modules/core` directory within the root directory. You can then start testing by navigating to the **[python/](python/)** directory. Your Python environment will need to have some dependencies installed: | ||
|
||
- python >= 3.7 | ||
- opencv-python | ||
|
@@ -256,7 +267,7 @@ In the project, there is a subproject called cpp/test. To compile it, you need t | |
```bash | ||
cmake -DISF_BUILD_WITH_TEST=ON .. | ||
``` | ||
If you need to run test cases, you will need to download the required [resource files](https://drive.google.com/file/d/1i4uC-dZTQxdVgn2rP0ZdfJTMkJIXgYY4/view?usp=sharing), which are **test_res** and **pack** respectively. Unzip the pack file into the test_res folder. The directory structure of test_res should be prepared as follows before testing: | ||
If you need to run test cases, you will need to download the required [resource files](https://drive.google.com/file/d/1i4uC-dZTQxdVgn2rP0ZdfJTMkJIXgYY4/view?usp=sharing), which are **test_res** and **Model Package** respectively. Unzip the pack file into the test_res folder. The directory structure of test_res should be prepared as follows before testing: | ||
|
||
```bash | ||
|
||
|
@@ -270,7 +281,7 @@ test_res | |
└── video_frames | ||
|
||
``` | ||
After compilation, you can find the executable program "Test" in **YOUR_BUILD_FOLDER/test**. The program accepts two optional parameters: | ||
After compilation, you can find the executable program "**Test**" in `YOUR_BUILD_FOLDER/test`. The program accepts two optional parameters: | ||
|
||
- **test_dir**:Path to the test resource files | ||
- **pack**:Name of the model to be tested | ||
|
@@ -298,7 +309,7 @@ The following functionalities and technologies are currently supported. | |
| 10 | Cooperative Liveness Detection |  | | | ||
|
||
|
||
## 6. Models Pack List | ||
## 6. Models Package List | ||
|
||
For different scenarios, we currently provide several Packs, each containing multiple models and configurations. | ||
|
||
|