# Open Source Face Recognition React SDK

### Code <a href="#setup" id="setup"></a>

{% embed url="<https://github.com/Faceplugin-ltd/FaceRecognition-React>" %}

### Overview <a href="#setup" id="setup"></a>

The world's 1st **Completely Free** and **Open Source** **Face Recognition React SDK** for developers to integrate face recognition and liveness detection capabilities into web frontend. Supports real-time, high-accuracy face recognition with deep learning models.\
This is **on-premise face recognition SDK** which means everything is processed in your browser and **NO** data leaves it.\
\
**Please contact us if you need the SDK with higher accuracy.**

### How to Run

### Install dependencies

```
npm i
```

#### Copy the pretrained weight files

```
node post-install.js
```

#### Execute the react app

```
npm start
```

### APIs

* **Face Detection**

  ```
  loadDetectionModel()
  detectFace(session, canvas_id)
  ```
* **Face Landmark Extraction**

  ```
  loadLandmarkModel()
  predictLandmark(session, canvas_id, bbox)
  ```
* **Face Liveness Detection**

  ```
  loadDetectionModel()
  detectFace(session, canvas_id)
  ```
* **Face Expression Detection**

  ```
  loadExpressionModel()
  predictExpression(session, canvas_id, bbox)
  ```
* **Face Pose Estimation**

  ```
  loadPoseModel()
  predictPose(session, canvas_id, bbox, question)
  ```
* **Eye Closeness Detection**

  ```
  loadEyeModel()
  predictEye(session, canvas_id, landmark)
  ```
* **Gender Detection**

  ```
  loadGenderModel()
  predictGender(session, canvas_id, landmark)
  ```
* **Age Estimation**

  ```
  loadAgeModel()
  predictAge(session, canvas_id, landmark)
  ```
* **Face Recognition**

  ```
  loadFeatureModel()
  extractFeature(session, canvas_id, landmarks)
  ```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.faceplugin.com/face-recognition-sdk/open-source-face-recognition-javascript-sdk-1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.