Skip to content

Commit

Permalink
Merge pull request #6 from lovoo/add-logo-to-library
Browse files Browse the repository at this point in the history
Add Header Image and Feedback section to README
  • Loading branch information
absolute-heike authored Sep 14, 2018
2 parents fc5b159 + 94322e4 commit ada75f5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# NSFWDetector
# ![NSFWDetector](assets/header.png)

[![Version](https://img.shields.io/cocoapods/v/NSFWDetector.svg?style=flat)](https://cocoapods.org/pods/NSFWDetector)
<!-- [![Version](https://img.shields.io/cocoapods/v/NSFWDetector.svg?style=flat)](https://cocoapods.org/pods/NSFWDetector)
[![License](https://img.shields.io/cocoapods/l/NSFWDetector.svg?style=flat)](https://cocoapods.org/pods/NSFWDetector)
[![Platform](https://img.shields.io/cocoapods/p/NSFWDetector.svg?style=flat)](https://cocoapods.org/pods/NSFWDetector)
[![Platform](https://img.shields.io/cocoapods/p/NSFWDetector.svg?style=flat)](https://cocoapods.org/pods/NSFWDetector) -->

NSFWDetector is able to scan images for nudity. It was trained using CreateML to distinguish between porn/nudity and appropriate pictures. With the main focus on distinguishing between instagram model like pictures and porn.

Expand Down Expand Up @@ -40,15 +40,19 @@ pod 'NSFWDetector', :git => 'https://github.com/lovoo/NSFWDetector.git'

## App Size

The Machine Learning Model is only **17 kB**, so App size won't be affected compared to other libraries using the [yahoo model](https://github.com/yahoo/open_nsfw).
The Machine Learning Model is only **17 kB** in size, so App size won't be affected compared to other libraries using the [yahoo model](https://github.com/yahoo/open_nsfw).

## Using just the Model

If you don't want to use the Detection Code, you can also just download the MLModel file directly from the latest [Release](https://github.com/lovoo/NSFWDetector/releases).

## Feedback

If you recognize issues with certain kind of pictures, feel free to reach out via [Mail](mailto:[email protected]) or [Twitter](https://twitter.com/LOVOOEng).

## Author

Michael Berg, [email protected]
Michael Berg, [[email protected]](mailto:[email protected])

## License

Expand Down
Binary file added assets/header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ada75f5

Please sign in to comment.