Skip to content
Simple Profanity (Obnoxious) Filter written in Swift.
Swift Ruby
Branch: master
Clone or download
Latest commit 1bfc5fa May 31, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
AAObnoxiousFilter CoreML Support Mar 2, 2019
Example Swift 5 May 31, 2019
.gitignore CoreML Support Mar 2, 2019
.swift-version CoreML Support Mar 2, 2019
.travis.yml CoreML Support Mar 2, 2019
AAObnoxiousFilter.podspec Swift 5 May 31, 2019
LICENSE CoreML Support Mar 2, 2019
README.md Update ReadMe Mar 3, 2019
_Pods.xcodeproj CoreML Support Mar 2, 2019

README.md

Table of Contents

#AAObnoxiousFilter

Swift 4.2 Carthage compatible CocoaPods License MIT Build Status License MIT CocoaPods AA-Creations Country

##Description

AAObnoxiousFilter is a profanity filter for images written in CoreML and Swift. Its a lightweight framework that can detect the inappropriation in UIImage with a single line of code.

##Demonstration

To run the example project, clone the repo, and run pod install from the Example directory first.

##Requirements

  • iOS 11.0+
  • Xcode 10.0+
  • Swift 4.2+

Installation

AAObnoxiousFilter can be installed using CocoaPods, Carthage, or manually.

##CocoaPods

AAObnoxiousFilter is available through CocoaPods. To install CocoaPods, run:

$ gem install cocoapods

Then create a Podfile with the following contents:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '11.0'
use_frameworks!

target '<Your Target Name>' do
pod 'AAObnoxiousFilter'
end

Finally, run the following command to install it:

$ pod install

##Carthage

To install Carthage, run (using Homebrew):

$ brew update
$ brew install carthage

Then add the following line to your Cartfile:

github "EngrAhsanAli/AAObnoxiousFilter" "master"

Then import the library in all files where you use it:

import AAObnoxiousFilter

##Manual Installation

If you prefer not to use either of the above mentioned dependency managers, you can integrate AAObnoxiousFilter into your project manually by adding the files contained in the Classes folder to your project.

#Getting Started

##Detect the Image

if let prediction = image.predictImage() {
    // prediction if greater than 0.5, the image will have inappropriate look
}
else {
    // Exception in any other case if the Image is not valid to predict
}

#Contributions & License

AAObnoxiousFilter is available under the MIT license. See the LICENSE file for more info.

Pull requests are welcome! The best contributions will consist of substitutions or configurations for classes/methods known to block the main thread during a typical app lifecycle.

I would love to know if you are using AAObnoxiousFilter in your app, send an email to Engr. Ahsan Ali

You can’t perform that action at this time.