Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/younis-ali/photo-validation

Using the openCV models perform phot validation, face detection, age detection, and gender detection.
https://github.com/younis-ali/photo-validation

age-detection face-detection fastapi gender-detection opencv

Last synced: 16 days ago
JSON representation

Using the openCV models perform phot validation, face detection, age detection, and gender detection.

Host: GitHub
URL: https://github.com/younis-ali/photo-validation
Owner: younis-ali
Created: 2024-03-21T10:21:36.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-07-18T06:11:37.000Z (4 months ago)
Last Synced: 2024-07-19T10:34:58.341Z (4 months ago)
Topics: age-detection, face-detection, fastapi, gender-detection, opencv
Language: Python
Homepage:
Size: 81.1 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Photo Validation API

This FastAPI application allows users to upload a profile photo and validate the user's age and gender, with an optional age verification flag.

## Features

- Upload a profile photo
- Validate user's age and gender
- Optional age parameter, if given then age will be detected otherwise not

## Requirements

- Python 3.7+
- FastAPI
- Pydantic
- Uvicorn

## Installation

1. Clone the repository:

```bash
git clone https://github.com/yourusername/photo-validation.git
cd photo-validation
```

2. Create a virtual environment and activate it:

```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```

3. Install the required dependencies:

```bash
pip install -r requirements.txt
```

The `requirements.txt` should include:
```
fastapi
uvicorn
```

## Running the Application

1. Start the FastAPI application using Uvicorn:

```bash
uvicorn main:app --reload
```

The endpoints will be available at `http://127.0.0.1:8000/docs`.

## Usage

### Endpoint: `/validate_profile_photo`

**Method:** POST

**Description:** Validate the user's profile photo, age, gender, and optionally verify the age.

**Request:**
- `photo` (UploadFile): The profile photo file.
- `age` (int): The user's age optional.
- `gender` (str): The user's gender. Must be either "Male" or "Female".
- `slack` (bool): predicted age flexibility value. Default is `0.25`.

**Example Request:**

- When `age` is `Given`
```bash
curl -X 'POST' \
'http://127.0.0.1:8000/validate_profile_photo' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'age=42' \
-F 'gender=' \
-F 'slack=0.80' \
-F '[email protected];type=image/jpeg'
```
Resonse Body
```json
{
"response": {
"message": "Profile photo successfully varified",
"is_valid": true,
"number_of_faces": 1,
"predicted_age_range": "(50-60)",
"predicted_gender": "male"
}
}
```

- When `age` is none
```bash
curl -X 'POST' \
'http://127.0.0.1:8000/validate_profile_photo' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'age=' \
-F 'gender=male' \
-F 'slack=0.25' \
-F '[email protected];type=image/jpeg'
```
Response Body
```json
{
"response": {
"message": "Profile photo successfully varified",
"is_valid": true,
"number_of_faces": 1,
"predicted_gender": "male"
}
}
```
Some more examples of responses in different senarios

- When non-human face image is given

```json
{
"response": {
"message": "No face detected or multiple faces detected.",
"is_valid": false
}
}
```
- When predicted age does not matches with given age
```json
{
"response": {
"message": "Profile photo not verified because the predicted age is outside the acceptable range. You can reconfigure the slack value",
"is_valid": false,
"number_of_faces": 1,
"predicted_age_range": "(50-60)",
"predicted_gender": "male"
}
}
```

- When predicted gender does not matches with given gender
``` json
{
"response": {
"message": "Profile photo not verified because the predicted gender does not match the given gender value",
"is_valid": false,
"number_of_faces": 1,
"predicted_age_range": "(50-60)",
"predicted_gender": "male"
}
}
```