update

.dockerignore

@@ -0,0 +1,8 @@
+Dockerfile
+node_modules
+build
+.eslintrc.js
+.git
+.gitattributes
+.gitignore
+.github

.eslintrc.js

@@ -0,0 +1,48 @@
+module.exports = {
+  env: {node: true},
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: [
+    '@typescript-eslint',
+  ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  rules: {
+    'no-async-promise-executor': 0,
+    'no-case-declarations': ['warn'],
+    'no-irregular-whitespace': 0,
+    'require-await': 1,
+    'no-console': 0,
+    'indent': 'off',
+    '@typescript-eslint/indent': [
+      'error',
+      2,
+      {
+        'SwitchCase': 1,
+        'ignoredNodes': [
+          'FunctionExpression > .params[decorators.length > 0]',
+          'FunctionExpression > .params > :matches(Decorator, :not(:first-child))',
+          'ClassBody.body > PropertyDefinition[decorators.length > 0] > .key'
+        ]
+      }
+    ],
+    'linebreak-style': ['error', 'unix'],
+    'quotes': ['error', 'single'],
+    'semi': ['error', 'always'],
+    'prefer-const': ['warn'],
+    '@typescript-eslint/no-unused-vars': [
+      'warn',
+      {'vars': 'all', 'args': 'after-used', 'ignoreRestSiblings': false}
+    ],
+    'switch-colon-spacing': [
+      'error',
+      {'after': false, 'before': false}
+    ],
+    '@typescript-eslint/no-explicit-any': 0,
+    '@typescript-eslint/explicit-module-boundary-types': 0,
+    '@typescript-eslint/no-var-requires': 0,
+    '@typescript-eslint/ban-ts-comment': 0,
+  },
+};

.gitignore

@@ -0,0 +1,5 @@
+.idea
+node_modules
+build
+.env
+yarn-error.log

Dockerfile

@@ -1,5 +1,21 @@
-FROM ghcr.io/arnidan/nsfw-api:latest
+FROM node:lts-slim
 
+RUN apt-get update && apt-get install -y python3 build-essential \
+    && rm -rf /var/lib/apt/lists/*
 
-# 暴露7860端口
-EXPOSE 7860
+COPY yarn.lock package.json ./
+
+RUN npm_config_build_from_source=true yarn install --prod
+
+COPY src ./src
+COPY tsconfig.json ./
+
+ARG modelType=default
+
+COPY ./models/$modelType ./model
+
+RUN yarn build
+
+EXPOSE 3000
+
+ENTRYPOINT ["yarn", "start"]

NSFW-API/.gitattributes

@@ -0,0 +1,35 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

NSFW-API/Dockerfile

@@ -0,0 +1,5 @@
+FROM ghcr.io/arnidan/nsfw-api:latest
+
+
+# 暴露7860端口
+EXPOSE 7860

NSFW-API/README.md

@@ -0,0 +1,11 @@
+---
+title: NSFW API
+emoji: 😻
+colorFrom: red
+colorTo: purple
+sdk: docker
+pinned: false
+license: mit
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

README.md

@@ -1,11 +1,122 @@
----
-title: NSFW API
-emoji: 😻
-colorFrom: red
-colorTo: purple
-sdk: docker
-pinned: false
-license: mit
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# NSFW API
+
+[![build](https://github.com/arnidan/nsfw-api/actions/workflows/build.yml/badge.svg)](https://github.com/arnidan/nsfw-api/actions/workflows/build.yml)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
+
+Wrapper around [NSFWJS](https://github.com/infinitered/nsfwjs) to provide API.
+
+## Usage
+
+### Docker
+
+There are docker images bundled with models v3 from https://github.com/gantman/nsfw_model:
+
+* `ghcr.io/arnidan/nsfw-api:latest` - bundled with TensorflowJS 299x299 Image Model (better detection, as for me)
+* `ghcr.io/arnidan/nsfw-api:latest-min` - bundled with TensorflowJS Quantized 299x299 Image Model (see [#39](https://github.com/arnidan/nsfw-api/issues/49))
+
+Each image is available for `linux/amd64` and `linux/arm64` platforms.
+
+```
+docker run -p 3000:3000 ghcr.io/arnidan/nsfw-api:latest
+```
+
+<details>
+    <summary>docker-compose.yml example</summary>
+
+```yaml
+version: "3.9"
+
+services:
+  nsfw-api:
+    image: "ghcr.io/arnidan/nsfw-api:latest"
+    ports:
+      - "3000:3000"
+    restart: always
+```
+
+</details>
+
+### Manual deploy
+
+1. Clone the repo
+2. Download and unpack model from [models repo](https://github.com/gantman/nsfw_model) to `model` folder
+3. `yarn`
+4. `yarn build`
+5. `yarn start`
+
+Now app started on port 3000.
+
+## API Methods
+
+- POST /classify
+- POST /classify-many
+
+### POST /classify
+
+#### Example of the request
+
+```http request
+POST /classify HTTP/1.1
+Content-Type: multipart/form-data
+```
+
+Image should be provided in `image` field.
+
+#### Example of the response
+
+```
+HTTP/1.1 200 OK
+Content-Type: application/json
+```
+```json
+{
+    "porn": 0.59248286485672,
+    "sexy": 0.39802199602127075,
+    "hentai": 0.006243097595870495,
+    "neutral": 0.0031403270550072193,
+    "drawing": 0.00011181648733327165
+}
+```
+
+### POST /classify-many
+
+#### Example of the request
+
+```http request
+POST /classify-many HTTP/1.1
+Content-Type: multipart/form-data
+```
+
+Images should be provided in `images` field.
+
+#### Example of the response
+
+```
+HTTP/1.1 200 OK
+Content-Type: application/json
+```
+```json
+[
+    {
+        "porn": 0.3996206820011139,
+        "neutral": 0.388679563999176,
+        "sexy": 0.19470958411693573,
+        "hentai": 0.015063910745084286,
+        "drawing": 0.001926235854625702
+    },
+    {
+        "sexy": 0.8366416692733765,
+        "porn": 0.13645528256893158,
+        "neutral": 0.0222245492041111,
+        "hentai": 0.004213324282318354,
+        "drawing": 0.0004651622730307281
+    },
+    {
+        "sexy": 0.8017168045043945,
+        "porn": 0.1770564466714859,
+        "neutral": 0.015829339623451233,
+        "hentai": 0.005097625777125359,
+        "drawing": 0.00029983260901644826
+    }
+]
+```

models/default/group1-shard10of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2304b6697ffb4e6b812461722dd44d808ec3dbd2b6d584656d802021d089637f
+size 4194304

models/default/group1-shard11of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c3921daff4e77b822d7d0538013dee405b06e721bd24ca32d7d842eaa33df554
+size 4194304

models/default/group1-shard12of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:081ce576fde1d060a49f2908bbd9b2e9df1e266eb014ee79b75be8b654631bc2
+size 4194304

models/default/group1-shard13of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:63a9eb50544d1b606b33b0b13bf8b671fd6871900a8d1e98183f9155c82d2151
+size 4194304

models/default/group1-shard14of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:67b803099de34d091e7dc65adc8963f2a3d1e287590dcccb979becf3929b4d7f
+size 4194304

models/default/group1-shard15of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b3dd86d30dcb4ca5ae80df0a84045ab1c24a2143abeab1c00e4ae6afeb78edc9
+size 4194304

models/default/group1-shard16of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:987f5eaa433a83bbbef9eb239c8a364c071c0f5d2a56e337b3eadb5b9eef8bef
+size 4194304

models/default/group1-shard17of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0b32181ac7995f9f6d25e48f92527b50cbbdb08727205fa577c4576f39a451a6
+size 4194304

models/default/group1-shard18of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:38b08fd98aa97ce5b348978d9a7fd5e94354908faaad5f37ba08a44a1fb9bd03
+size 4194304

models/default/group1-shard19of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:aad15be21400a538b2d21c66a900d73a67afd96f3979cc69d8496fe9e4dc41ce
+size 4194304

models/default/group1-shard1of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6f631596a54b464c305eaa32e43a009fe3cf44332001e37735ff73591b0410d7
+size 4194304

models/default/group1-shard20of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:16ec8baa36f0050b108fd3785d40cedd493adc398eb04b726370931543f1f41a
+size 4194304

models/default/group1-shard21of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b146f6e84f07b7fc5379b639b7dfbe71f955b5a678e7962c079824d4013490d9
+size 4194304

models/default/group1-shard22of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:27c141257999d4b20c4b3e3b0b8bc5b4388db4eb65e202499b27a4e0e16a103c
+size 1363092

models/default/group1-shard2of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c3546b791ad3167e2557d145d319c813a81ce9c9261b9a1b880e249e19880eac
+size 4194304

models/default/group1-shard3of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3736ceb6db2accb3e8f6e44ad0a5b0ab5f68fa4b2a8a1ee7859afd2155f069bf
+size 4194304

models/default/group1-shard4of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8f2b24050c3289cf68c6cae7e9a285be4d441cf69b9488cd64000100dc9b702b
+size 4194304

models/default/group1-shard5of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:45cbfc744817cde12b4c5e105799115611b2155c6f7ed39a1e808d19456da7d6
+size 4194304

models/default/group1-shard6of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ba39e02d47d536b791e522bac126d3573d3fab4c58ffc2e5f5af3351c848d9fe
+size 4194304

models/default/group1-shard7of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:529755427a9b89e68b7c171ad5208d426ebfc43b880c1c1da27d3b69c3ffc26c
+size 4194304

models/default/group1-shard8of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:40887e59f348659ff684f18fba7345887ca6d55cadb32a2e767b483a7f7d4b03
+size 4194304

models/default/group1-shard9of22

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:456c4d41b34bfeadfe9b3781cb752e44f024baa32810b0a50840b0fd2390f994
+size 4194304

models/default/model.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fc4dbb6255feaed52a79d80728b6fa947b014655fe44012c07b16590d7198ef7
+size 179999

models/min/group1-shard1of6

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7a3a4c075cfcaa7f0b095f55b2ba54a288c2f770e504c8537394efda9545994b
+size 4194304

models/min/group1-shard2of6

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8826da12bda0db9415aef0e6a8d1f178a0d950deab28c4e79b9da994748702a4
+size 4194304

models/min/group1-shard3of6

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4557a96cf87ceb8df6c9647b647ac9843251a4455457cb40f35c02250a63e51c
+size 4194304

models/min/group1-shard4of6

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:399b99397ccd64351b59f04cdabe30000a15494c82f75c1e2ccb41c9b6338b7d
+size 4194304

models/min/group1-shard5of6

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:994515b0f73407d71740301e9877511b086609dbdc7ead1b31bcb82b3397ae74
+size 4194304

models/min/group1-shard6of6

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:cfb856c9d8fcefacca87b6063ed4949adf69f0372407d6edca8cec0c1694a28b
+size 1389349

models/min/model.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1220fc23413405858655f9c7342d5e201d9b8e0356904267d59659da71202cc3
+size 215920

nsfw-api

@@ -0,0 +1 @@
+Subproject commit 0155c893c2d688ae4e17aca7dce2de55e4f5602d

package.json

@@ -0,0 +1,37 @@
+{
+  "name": "nsfwjs-api",
+  "version": "1.0.0",
+  "main": "build/index.js",
+  "author": "Andrew",
+  "private": true,
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "start": "node build/index.js",
+    "start-dev": "ts-node --project ./tsconfig.json -T --emit --files src/index.ts",
+    "watch": "ts-node-dev -T src/index.ts",
+    "lint": "eslint src/ --ext .js,.ts"
+  },
+  "dependencies": {
+    "@tensorflow/tfjs-node": "^3.20.0",
+    "@types/body-parser": "^1.19.2",
+    "@types/express": "^4.17.13",
+    "@types/multer": "^1.4.7",
+    "@types/node": "^18.15.11",
+    "body-parser": "^1.20.2",
+    "express": "^4.17.1",
+    "module-alias": "^2.2.2",
+    "multer": "^1.4.4",
+    "nsfwjs": "^2.4.2",
+    "reflect-metadata": "^0.1.13",
+    "simple-ts-express-decorators": "1.3.0",
+    "typescript": "^5.0.3"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
+    "eslint": "^8.37.0"
+  },
+  "_moduleAliases": {
+    "app": "./build"
+  }
+}

src/NsfwImageClassifier.ts

@@ -0,0 +1,46 @@
+import * as tf from '@tensorflow/tfjs-node';
+import * as nsfwjs from 'nsfwjs';
+import {NSFWJS} from 'nsfwjs';
+import {Tensor3D} from '@tensorflow/tfjs';
+import {model as config} from 'app/config/model';
+
+tf.enableProdMode();
+
+export class NsfwImageClassifier {
+  #model?: NSFWJS;
+
+  async classify(imageBuffer: Buffer) {
+    const [model, image] = await Promise.all([
+      this.#getModel(),
+      tf.node.decodeImage(imageBuffer, 3),
+    ]);
+
+    const predictions = await model.classify(image as Tensor3D);
+
+    image.dispose();
+
+    return this.#transformData(predictions);
+  }
+
+  async classifyMany(imagesBuffers: Buffer[]) {
+    return await Promise.all(imagesBuffers.map(buffer => this.classify(buffer)));
+  }
+
+  async #getModel(): Promise<NSFWJS> {
+    if (!this.#model) {
+      this.#model = await nsfwjs.load('file://model/', {size: config.size});
+    }
+
+    return this.#model;
+  }
+
+  #transformData(data: { className: string; probability: number }[]): Record<string, number> {
+    const result: Record<string, number> = {};
+
+    for (const item of data) {
+      result[item.className.toLowerCase()] = item.probability;
+    }
+
+    return result;
+  }
+}

src/config/model.ts

@@ -0,0 +1,5 @@
+const DEFAULT_MODEL_SIZE = 299;
+
+export const model = {
+  size: Number(process.env.MODEL_SIZE) || DEFAULT_MODEL_SIZE,
+};

src/controllers/NsfwController.ts

@@ -0,0 +1,42 @@
+import {Controller, Post} from 'simple-ts-express-decorators';
+import multer, {memoryStorage} from 'multer';
+import {Request, Response} from 'express';
+import {NsfwImageClassifier} from 'app/NsfwImageClassifier';
+
+const upload = multer({storage: memoryStorage()});
+
+@Controller()
+export class NsfwController {
+  classifier: NsfwImageClassifier;
+
+  constructor() {
+    this.classifier = new NsfwImageClassifier();
+  }
+
+  @Post('/classify', upload.single('image'))
+  async classify(request: Request, response: Response) {
+    if (!request.file) {
+      return response
+        .status(410)
+        .json({error: 'Specify image'});
+    }
+
+    const data = await this.classifier.classify(request.file.buffer);
+
+    return response.json(data);
+  }
+
+  @Post('/classify-many', upload.array('images', 10))
+  async classifyMany(request: Request, response: Response) {
+    if (!request.files || !request.files.length) {
+      return response
+        .status(410)
+        .json({error: 'Specify images'});
+    }
+
+    const buffers = (request.files as Express.Multer.File[]).map(file => file.buffer);
+    const data = await this.classifier.classifyMany(buffers);
+
+    return response.json(data);
+  }
+}

src/index.ts

@@ -0,0 +1,17 @@
+import 'reflect-metadata';
+import 'module-alias/register';
+
+import express from 'express';
+import bodyParser from 'body-parser';
+import {ControllersLoader} from 'simple-ts-express-decorators';
+import {NsfwController} from 'app/controllers/NsfwController';
+
+const app = express();
+
+app.use(bodyParser.json());
+
+new ControllersLoader({
+  controllers: [NsfwController]
+}).load(app);
+
+app.listen(3000);

tsconfig.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "commonjs",
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "outDir": "./build",
+    "removeComments": true,
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": true,
+    "noEmitOnError": true,
+    "baseUrl": ".",
+    "strict": true,
+    "strictFunctionTypes": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": true,
+    "strictBindCallApply": true,
+    "paths": {
+      "app/*": ["./src/*"]
+    },
+    "incremental": true,
+    "types": ["reflect-metadata", "node"],
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "include": [
+    "./src/**/*.ts",
+  ],
+  "exclude": [
+    "./node_modules"
+  ]
+}