https://github.com/hoyaaaa/nsfw_detector_flutter
A Flutter package to detect NSFW 🔞 (Not Safe For Work / NUDE / adults) contents and classify SAFE 🛡️ contents without downloading or setting any assets
https://github.com/hoyaaaa/nsfw_detector_flutter
adult dart flutter image-processing mobile-development nsfw nsfw-detection open-source safe-content tensoflow-lite
Last synced: 12 months ago
JSON representation
A Flutter package to detect NSFW 🔞 (Not Safe For Work / NUDE / adults) contents and classify SAFE 🛡️ contents without downloading or setting any assets
- Host: GitHub
- URL: https://github.com/hoyaaaa/nsfw_detector_flutter
- Owner: hoyaaaa
- License: mit
- Created: 2024-07-06T14:01:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-29T10:40:50.000Z (over 1 year ago)
- Last Synced: 2024-10-14T02:42:17.738Z (over 1 year ago)
- Topics: adult, dart, flutter, image-processing, mobile-development, nsfw, nsfw-detection, open-source, safe-content, tensoflow-lite
- Language: Dart
- Homepage: https://pub.dev/packages/nsfw_detector_flutter
- Size: 20.7 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 🙈 nsfw_detector_flutter
A Flutter package to detect NSFW 🔞 (Not Safe For Work / NUDE / adults) contents and classify SAFE 🛡️ contents __without downloading or setting any assets__
## 🛠️ Installation
```sh
flutter pub add nsfw_detector_flutter
```
That's it! You don't need any assets. 😎
## 🏃 Simple usage
```dart
import 'package:nsfw_detector_flutter/nsfw_detector_flutter.dart';
File imageFile = File('path/to/image.jpg');
NsfwDetector detector = await NsfwDetector.load();
NsfwResult? result = await detector.detectNSFWFromFile(imageFile);
// whether it is over threshold (default: 0.7)
print("NSFW detected: ${result?.isNsfw}");
// float value from 0 to 1
print("NSFW score: ${result?.score}");
```
## 📙 Usage
### Load and initialize the detector
The `NsfwDetector` can be initialized with default parameters:
```dart
NsfwDetector detector = await NsfwDetector.load(); // default threshold: 0.7
```
| Parameter | Type | Default | Description |
|---------------|---------|---------|---------------------------------------------------------------|
| `threshold` | Float | 0.7 | The threshold to classify an image as NSFW | |
### NsfwResult
The `NsfwResult` class contains the following properties:
| Parameter | Type | Description |
|---------------|-------- |---------------------------------------------------------------|
| `score` | Float | The NSFW score of the image (0 to 1, higher indicates more NSFW) |
| `isNsfw` | Boolean | Indicates if the image is classified as NSFW based on the threshold |
### Detect NSFW content
```dart
// from bytes
final ByteData data = await rootBundle.load('assets/nsfw.jpeg');
final Uint8List imageData = data.buffer.asUint8List();
NsfwResult? result = await detector.detectNSFWFromBytes(imageData);
// from file
File imageFile = File('path/to/image.jpg');
NsfwResult? result = await detector.detectNSFWFromFile(imageFile);
// from image
import 'package:image/image.dart' as img;
img.Image image = img.decodeImage(File('path/to/image.jpg').readAsBytesSync())!;
NsfwResult? result = await detector.detectNSFWFromImage(image);
```
## ⚠️ Warnings
### iOS
If there are issues related to the library on iOS and it doesn't work, check the following setting in XCode:
1. Ensure that **XCode > Build Settings > Deployment > Strip Linked Product** is set to **No**.
### Android
#### 1. Min SDK Version:
This package uses the `tflite_flutter` package, so the Android `minSdkVersion` must be set to 26 or higher. Check and update the following in your `android/app/build.gradle` file:
```gradle
android {
defaultConfig {
minSdkVersion 26
}
}
```
#### 2. ProGuard / R8 Configuration:
If you encounter issues during release builds due to R8 (ProGuard), ensure that the following rules are added to your `android/app/proguard-rules.pro` file:
```pro
# TensorFlow Lite GPU Delegate
-keep class org.tensorflow.lite.gpu.GpuDelegateFactory$Options { *; }
-dontwarn org.tensorflow.lite.gpu.GpuDelegateFactory$Options
```
Also, verify that ProGuard or R8 is enabled in your `android/app/build.gradle` file:
```gradle
buildTypes {
release {
minifyEnabled true
shrinkResources true
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
```
## 🧪 Test
For information on how to run integration tests for this package, please refer to the [example README](example/README.md).
## 💳 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
### Model Information
The default model used in this package is referenced from the [open_nsfw_android](https://github.com/devzwy/open_nsfw_android) repository, which is a port of the [yahoo/open_nsfw](https://github.com/yahoo/open_nsfw) model. This package complies with the license terms of the yahoo/open_nsfw repository.
### BSD 3-Clause License
```
Copyright 2016, Yahoo Inc.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of the Yahoo Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
```