https://github.com/enebin/mentalist

Read face with a line of code 🎭
https://github.com/enebin/mentalist

coreml face-detection face-recognition ios machine-learning spm swift swiftui uikit

Last synced: about 1 month ago
JSON representation

Read face with a line of code 🎭

• Host: GitHub
• URL: https://github.com/enebin/mentalist
• Owner: enebin
• License: mit
• Created: 2024-06-13T11:28:37.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-06-16T11:04:46.000Z (5 months ago)
• Last Synced: 2024-10-14T19:40:17.586Z (about 1 month ago)
• Topics: coreml, face-detection, face-recognition, ios, machine-learning, spm, swift, swiftui, uikit
• Language: Swift
• Homepage:
• Size: 6.73 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Mentalist

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fenebin%2FMentalist%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/enebin/Mentalist)

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fenebin%2FMentalist%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/enebin/Mentalist)

[![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)

![banner](Assets/banner.jpg)



 Read face with a line of code 



```swift

let analysis = try Mentalist.analyze(image: Image("my_face")).first!

print("The emotion on your face is... '\(analysis.dominantEmotion)!'")

// "The emotion on your face is... 'happy'!

```

## Features

**Mentalist** is a Swift-based library designed for analyzing and identifying emotions within a picture.

### 1. Seven Emotion Categories

Mentalist classifies the emotions on faces in a photo into **one of seven categories**. Internally, it utilizes a CoreML model based on FER2013 to analyze emotions displayed in a picture into seven categories: 'happy', 'angry', 'disgust', 'fear', 'sad', 'surprise', and 'neutral'.

### 2. Optimized for Mobile Environment

Mentalist has an optimal size for mobile environments. It also takes approximately **0.06 seconds per analysis** with an **accuracy rate of about 57%**.

### 3. Supports Multi-Face Analysis

Mentalist can detect multiple faces. If multiple faces are detected, it returns a list of multiple analysis results.

## Installation

### Swift Package Manager (SPM)

Follow these steps to install Mentalist using SPM:

1. From within Xcode 13 or later, choose File > Swift Packages > Add Package Dependency.

2. At the next screen, enter the URL for the Mentalist repository(https://github.com/enebin/Mentalist) in the search bar then click Next.

3. For the version rule, select 'Up to Next Minor' and specify the current Mentalist version then click 'Next'.

4. On the final screen, select the Mentalist library and then click 'Finish'.

Mentalist should now be integrated into your project 🚀.

## Usage

```swift

import Mentalist

let analysis = try Mentalist.analyze(image: Image("my_face"))

```

Done!

## Contributing

We welcome contributions to Mentalist! If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

## License

Mentalist is released under the MIT License. See [LICENSE](LICENSE) for details.

## Contact

For any questions or suggestions, please feel free to contact me. My email's on my Github profile.