https://github.com/rahiel/open_nsfw--

API to classify images as SFW/NSFW.
https://github.com/rahiel/open_nsfw--

deep-learning docker-image nudity-detection

Last synced: about 2 months ago
JSON representation

API to classify images as SFW/NSFW.

• Host: GitHub
• URL: https://github.com/rahiel/open_nsfw--
• Owner: rahiel
• License: bsd-3-clause
• Created: 2017-06-12T14:21:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-04-15T11:48:42.000Z (over 1 year ago)
• Last Synced: 2023-05-31T02:45:20.666Z (over 1 year ago)
• Topics: deep-learning, docker-image, nudity-detection
• Language: Python
• Homepage:
• Size: 20.6 MB
• Stars: 59
• Watchers: 8
• Forks: 22
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-yahoo.txt

Awesome Lists containing this project

README

        
# open_nsfw--

This is a fork of Yahoo's [open_nsfw][]. The goal is to make the *Not Suitable

for Work* (NSFW) classification model easily accessible through an HTTP API

deployable with Docker.

As I couldn't make this work on Buster due to insufficient knowledge of the

tread system, I have edited the requirements to support Python 3.5.

# Install

First [install Docker][docker] (available in Debian as [docker.io][dpkg]), then

give the user you want to run the API as permission to use Docker:

``` shell

sudo gpasswd -a $USER docker

```

You need to logout and login again for this to take effect.

Now build the image, this might take a while:

``` shell

docker build -t open_nsfw https://raw.githubusercontent.com/rahiel/open_nsfw--/master/Dockerfile

```

Then you can start the API:

``` shell

docker run -p :8080 open_nsfw

```

where you replace `` with the port number you want to have the API

accessible on your local machine.

[open_nsfw]: https://github.com/yahoo/open_nsfw

[docker]: https://docs.docker.com/engine/installation/

[dpkg]: https://packages.debian.org/sid/docker.io

# Usage

The API is very simple, you POST an `url` of an image and the API will then

fetch it, classify it and return the probability that it's NSFW. The probability

is expressed as a real number between 0 and 1.

In the following examples I assume you picked 8080 for the port number, so the

API is running at `localhost:8080`.

With curl:

``` shell

curl -d 'url=http://example.com/image.jpg' localhost:8080

```

With Python:

``` python

import requests

r = requests.post("http://localhost:8080", data={"url": "http://example.com/image.jpg"})

nsfw_prob = float(r.text)

```

# HTTP Errors

## 400 Bad Request: Missing `url` POST parameter

You need to specify `url` as a POST parameter.

## 404 Not Found

The requested `url` leads to an HTTP 404 Not Found error.

## 415 Unsupported Media Type: Invalid image

The requested `url` is not a valid image.