Skip to content

Commit df84c97

Browse files
authored
Update README.md
1 parent 9d52fd0 commit df84c97

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -68,39 +68,40 @@ This repo offers APIs to enroll face, to search face, to see database, to clear
6868
## How to run
6969

7070
### 1. System Requirements
71-
- CPU: 2 cores or more (Recommended: 2 cores)
72-
- RAM: 4 GB or more (Recommended: 8 GB)
73-
- HDD: 4 GB or more (Recommended: 8 GB)
74-
- OS: Ubuntu 20.04 or later
75-
- Dependency: OpenVINO™ Runtime (Version: 2022.3)
71+
- `CPU`: `2` cores or more (Recommended: `2` cores)
72+
- `RAM`: `4GB` or more (Recommended: `8GB`)
73+
- `HDD`: `4GB` or more (Recommended: `8GB`)
74+
- `OS`: `Ubuntu 20.04` or later
75+
- Dependency: `OpenVINO™` Runtime (Version: `2022.3`)
7676

7777
### 2. Setup and Test
7878
- Clone the project:
7979
```bash
80-
git clone https://github.com/kby-ai/FaceRecognition-Docker.git
80+
git clone https://github.com/kby-ai/FaceSearch-Docker.git
8181
```
8282
- Download the model from Google Drive: [click here](https://drive.google.com/file/d/1ExXnc-QMVCFtGoP3xOkjoQFq56hO0PV0/view?usp=sharing)
8383
```bash
84-
cd FaceRecognition-Docker
84+
cd FaceSearch-Docker
8585
8686
wget --load-cookies /tmp/cookies.txt "https://docs.google.com/uc?export=download&confirm=$(wget --quiet --save-cookies /tmp/cookies.txt --keep-session-cookies --no-check-certificate 'https://docs.google.com/uc?export=download&id=19vA7ZOlo19BcW8v4iCoCGahUEbgKCo48' -O- | sed -rn 's/.*confirm=([0-9A-Za-z_]+).*/\1\n/p')&id=19vA7ZOlo19BcW8v4iCoCGahUEbgKCo48" -O data.zip && rm -rf /tmp/cookies.txt
8787
8888
unzip data.zip
8989
```
9090
- Build the `Docker` image:
9191
```bash
92-
sudo docker build --pull --rm -f Dockerfile -t kby-ai-face:latest .
92+
sudo docker build --pull --rm -f Dockerfile -t kby-ai-face-search:latest .
9393
```
94-
- Run the `Docker` container:
94+
- Get `machine code`
9595
```bash
96-
sudo docker run -v ./license.txt:/home/openvino/kby-ai-face/license.txt -p 8081:8080 kby-ai-face
96+
sudo docker run -e LICENSE="xxxxx" kby-ai-face-search:latest
9797
```
98-
- Send us the `machine code` and then we will give you a license key.
99-
100-
After that, update the `license.txt` file by overwriting the license key that you received. Then, run the `Docker` container again.
101-
98+
- Send us the `machine code` obtained.
10299
![image](https://github.com/user-attachments/assets/cb3590a3-2f68-4e68-8ae2-21522a222abc)
103-
100+
- Update the `license.txt` file by overwriting the license key that you received from `KBY-AI` team.
101+
- Run the `Docker` container:
102+
```bash
103+
sudo docker run -v ./license.txt:/root/kby-ai-face/license.txt -p 8081:8080 -p 9001:9000 kby-ai-face-search:latest
104+
```
104105
![image](https://github.com/user-attachments/assets/dd8e2ba2-2121-43e0-b8d9-fa0c2b10dc70)
105106

106107
## About SDK
@@ -164,7 +165,7 @@ This repo offers APIs to enroll face, to search face, to see database, to clear
164165
| 68 points facial landmark | float [68 * 2] | landmarks_68 |
165166
| Face templates | unsigned char [2048] | templates |
166167

167-
### 3. APIs
168+
### 3. Main Functions
168169
- Face Detection
169170

170171
The `Face SDK` provides a single API for detecting faces, determining `face orientation` (yaw, roll, pitch), assessing `face quality`, detecting `facial occlusion`, `eye closure`, `mouth opening`, and identifying `facial landmarks`.

0 commit comments

Comments
 (0)