README

Easily use powerful face recognition and analysis in your PHP projects by connecting to the DeepFace Python library—no need to learn Python!

What is this?

This package lets you verify if two faces match or analyze faces in images using the popular DeepFace library, all from PHP. It works by running a Python script behind the scenes and giving you the results in PHP.

Features

Face Verification: Check if two images are of the same person.
Face Analysis: Detect age, gender, emotion, and more from a single image.

Requirements

PHP 7.2 or higher
Python 3 with the deepface , tf-keras library installed
Composer (for PHP dependencies)

Installation

Install the PHP library:
```
composer require theranken/deepface-php
```
Install Python dependencies: Make sure you have Python 3 and pip installed, then run:
```
pip install deepface, tf-keras
```

Usage

1. Prepare your images

Make sure your images are accessible by file path (local files).

2. Example: Face Verification (Instance Method)

use DeepFacePHP\DeepFace;

$deepface = new DeepFace();
$result = $deepface->compare('path/to/image1.jpg', 'path/to/image2.jpg');

if ($result['verified']) {
    echo "Faces match!";
} else {
    echo "Faces do not match.";
}

3. Example: Face Verification (Static Method)

use DeepFacePHP\DeepFace;

$result = DeepFace::compareImages('path/to/image1.jpg', 'path/to/image2.jpg');

if ($result['verified']) {
    echo "Faces match!";
} else {
    echo "Faces do not match.";
}

4. Example: Face Analysis (Instance Method)

use DeepFacePHP\DeepFace;

$deepface = new DeepFace();
$result = $deepface->analyze('path/to/image.jpg', ['age', 'gender', 'emotion']);

print_r($result);

5. Example: Face Analysis (Static Method)

use DeepFacePHP\DeepFace;

$result = DeepFace::analyzeImage('path/to/image.jpg', ['age', 'gender', 'emotion']);

print_r($result);

6. Customizing Python Path

If your Python or script path is different, you can specify them:

$deepface = new DeepFace('python3', '/custom/path/deepface_cli.py');
// Or for static methods:
$result = DeepFace::compareImages('img1.jpg', 'img2.jpg', 'python3', '/custom/path/deepface_cli.py');

7. Interact with the library

You can interact with the library by running the following command:

php interact

How does it work?

The PHP library runs a Python script using shell commands.
The Python script uses DeepFace to process the images and returns the results as JSON.
The PHP library reads and parses the results for you.

Troubleshooting

Make sure Python and DeepFace are installed and accessible from your command line.
If you get errors, check the output for details (e.g., missing dependencies, wrong image paths).
If you're using Docker please symlink the python3 folder to a python folder like this:

RUN ln -s /usr/bin/python3 /usr/bin/python

License

MIT

Enjoy using DeepFace in your PHP projects!

theranken / deepfacephp

Maintainers

Details