Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Gummibeer committed Oct 10, 2023
1 parent d08497d commit 5e16ea7
Showing 1 changed file with 62 additions and 0 deletions.
62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,63 @@
# PHP DeepFace

## Installation

```bash
composer install astrotomic/php-deepface
```

## Configuration

```php
use Astrotomic\DeepFace\DeepFace;

$deepface = new DeepFace(
python: '/usr/bin/python3',
);
```

## Usage

### Build Model

```php
$deepface->buildModel(\Astrotomic\DeepFace\Enums\FaceRecognitionModel::VGGFACE);
```

### Face Detection

```php
$deepface->extractFaces(
img_path: '~/test.png',
);
```

### Face Verification

```php
$deepface->verify(
img1_path: '~/test.png',
img2_path: '~/id.jpg',
);
```

### Face recognition

```php
$deepface->find(
img_path: '~/test.png',
db_path: '~/db',
);
```

### Face Embeddings

_ToDo_

### Facial Attribute Analysis

```php
$deepface->analyze(
img_path: '~/test.png',
);
```

0 comments on commit 5e16ea7

Please sign in to comment.