Welcome to the Facial Attendance API! This open-source project is designed to provide advanced facial recognition functionalities. Whether you're building a attendance management system or a security application, this API has got you covered.
The Facial Attendance API is built using Flask, a lightweight web framework for Python. It leverages the power of facial recognition algorithms to provide accurate and efficient face-related functionalities. With this API, you can easily enroll faces, search for faces, find similar faces, and verify faces.
To get started with the Facial Attendance API, follow these simple steps:
-
Clone the repository to your local machine:
git clone https://github.com/richardar/facial-attendance-api.git -
Install the required packages by running the following command:
pip install -r requirements.txt -
Start the Flask app by running the following command in the terminal:
flask run -
(Optional) Run as Docker container instead
docker build -t facialAttendence .docker run -p 0.0.0.0:5000:5000 facialAttendence
Congratulations! You have successfully set up the Facial Attendance API on your local machine.
The Facial Attendance API provides the following powerful functionalities:
You can use the API to enroll a face into the provided database. During the enrollment process, the API captures various face attributes such as age, gender, race, and emotion. This information can be used for further analysis or identification purposes.
The API allows you to search for a face in the database. If a match is found, it will return the details of the matched face. In case no match is found, the API will provide the top 109 similar faces available. This feature is particularly useful for attendance management systems or security applications.
The Facial Attendance API also provides a functionality to find similar faces in the database. If an accurate match within the threshold is not found, it will return the top 10 most similar faces. This feature can be used for various applications, such as identifying potential duplicates or finding look-alikes.
Additionally, the API allows you to verify a face by providing a face image and an ID. It will compare the provided face with the enrolled face associated with the given ID to determine if they belong to the same person. This feature is crucial for identity verification and access control systems.
Please note that this project is a work in progress, and additional features may be added in the future.
We welcome contributions to the Facial Attendance API! If you have any ideas, bug fixes, or improvements, please feel free to submit a pull request. Together, we can make this project even better.
This project is licensed under the MIT License. For more details, please refer to the LICENSE file.
This is an open-source project that I created for fun. The Facial Attendance API is built using Flask and provides various functionalities related to facial recognition.
This project is licensed under the MIT License. See the LICENSE file for more details.