add files

README.md

@@ -0,0 +1,137 @@
+---
+library_name: generic
+license: cc-by-sa-3.0
+pipeline_tag: image-classification
+tags:
+- ai_or_not
+- sumsub
+- image_classification
+- sumsubaiornot
+- aiornot
+- deepfake
+- synthetic
+- generated
+- pytorch
+metrics:
+- accuracy
+---
+
+# For Fake's Sake: a set of models for detecting generated and synthetic images
+
+Many people on the internet have recently been tricked by fake images of Pope Francis wearing a coat or of Donald Trump's arrest. 
+To help combat this issue, we provide detectors for such images generated by popular tools like Midjourney and Stable Diffusion.
+
+| ![Image1](images/3.jpg) | ![Image2](images/2.jpg) | ![Image3](images/4.webp) |
+|-------------------------|-------------------------|--------------------------|
+
+## Model Details
+
+### Model Description
+
+- **Developed by:** [Sumsub AI team](https://sumsub.com/)
+- **Model type:** Image classification
+- **License:** CC-By-SA-3.0
+- **Types:** *diffusions_5m*(Size: 5M parameters, Description: Designed to detect photos created using different versions of Stable Diffusion (1.4, 1.5, 2.1))
+- **Finetuned from model:** *tf_mobilenetv3_large_100.in1k*
+
+## Demo
+
+The demo page can be found [here](https://huggingface.co/spaces/Sumsub/Sumsub-ffs-demo).
+
+## How to Get Started with the Model & Model Sources
+
+Use the code below to get started with the model:
+
+```bash
+git lfs install
+git clone https://huggingface.co/Sumsub/Sumsub-ffs-synthetic-1.0_sd_5 sumsub_synthetic_sd_5
+```
+
+```python
+from sumsub_synthetic_sd_5.pipeline import PreTrainedPipeline
+from PIL import Image
+
+pipe = PreTrainedPipeline("sumsub_synthetic_sd_5/")
+
+img = Image.open("sumsub_synthetic_sd_5/images/2.jpg")
+
+result = pipe(img)
+print(result)
+```
+
+You may need these prerequsites installed:
+
+```bash
+pip install -r requirements.txt
+pip install "git+https://github.com/rwightman/pytorch-image-models"
+pip install "git+https://github.com/huggingface/huggingface_hub"
+```
+
+## Training Details
+
+### Training Data
+
+The models were trained on the following datasets:
+
+**Stable Diffusion datasets:**
+
+- *Real photos* : [MS COCO](https://cocodataset.org/#home).
+- *AI photos* : [aiornot HuggingFace contest data](https://huggingface.co/datasets/competitions/aiornot), [Stable Diffusion Wordnet Dataset](https://www.kaggle.com/datasets/astoeckl/stable-diffusion-wordnet-dataset).
+
+### Training Procedure
+
+To improve the performance metrics, we used data augmentations such as rotation, crop, Mixup and CutMix. Each model was trained for 30 epochs using early stopping with batch size equal to 32.
+
+## Evaluation
+
+For evaluation we used the following datasets:
+
+**Stable Diffusion datasets:**
+
+- [DiffusionDB](https://github.com/poloclub/diffusiondb): a set of 2 million images generated by Stable Diffusion using prompts and hyperparameters specified by real users.
+- [Kaggel SD Faces](https://www.kaggle.com/datasets/bwandowando/faces-dataset-using-stable-diffusion-v14): set of 4k human face images generated using Stable Diffusion 1.4.
+- [Stable Diffusion Wordnet Dataset](https://www.kaggle.com/datasets/astoeckl/stable-diffusion-wordnet-dataset): set of 200K images generated by Stable Diffusion.
+
+**Realistic images:**
+
+- [MS COCO](https://cocodataset.org/#home): set of 120k real world images.
+
+## Metrics
+
+<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+
+| Model           | Dataset                                                                                                       | Accuracy |
+|-----------------|---------------------------------------------------------------------------------------------------------------|----------|
+| diffusions_5M   | [Kaggel SD Faces](https://www.kaggle.com/datasets/bwandowando/faces-dataset-using-stable-diffusion-v14)       | 0.984    |
+| diffusions_5M   | [DiffusionDB](https://github.com/poloclub/diffusiondb)                                                        | 0.912    |
+| diffusions_5M   | [Stable Diffusion Wordnet Dataset](https://www.kaggle.com/datasets/astoeckl/stable-diffusion-wordnet-dataset) | 0.919    |
+| diffusions_5M   | [MS COCO](https://cocodataset.org/#home)                                                                      | 0.877    |
+
+## Limitations
+
+- It should be noted that achieving 100% accuracy is not possible. Therefore, the model output should only be used as an indication that an image may have been (but not definitely) artificially generated.
+- Our models may face challenges in accurately predicting the class for real-world examples that are extremely vibrant and of exceptionally high quality. In such cases, the richness of colors and fine details may lead to misclassifications due to the complexity of the input. This could potentially cause the model to focus on visual aspects that are not necessarily indicative of the true class.
+
+![Image1](images/1.jpg)
+
+## Citation
+
+If you find this useful, please cite as:
+
+```text
+@misc{sumsubaiornot, 
+    publisher = {Sumsub},
+    url       = {https://huggingface.co/Sumsub/Sumsub-ffs-synthetic-1.0_sd_5},
+    year      = {2023},
+    author    = {Savelyev, Alexander and Toropov, Alexey and Goldman-Kalaydin, Pavel and Samarin, Alexey},
+    title     = {For Fake's Sake: a set of models for detecting deepfakes, generated images and synthetic images}
+}
+```
+
+## References
+
+- Stöckl, Andreas. (2022). Evaluating a Synthetic Image Dataset Generated with Stable Diffusion. 10.48550/arXiv.2211.01777.
+- Lin, Tsung-Yi & Maire, Michael & Belongie, Serge & Hays, James & Perona, Pietro & Ramanan, Deva & Dollár, Piotr & Zitnick, C.. (2014). Microsoft COCO: Common Objects in Context.
+- Howard, Andrew & Zhu, Menglong & Chen, Bo & Kalenichenko, Dmitry & Wang, Weijun & Weyand, Tobias & Andreetto, Marco & Adam, Hartwig. (2017). MobileNets: Efficient Convolutional Neural Networks for Mobile Vision Applications.
+- Liu, Zhuang & Mao, Hanzi & Wu, Chao-Yuan & Feichtenhofer, Christoph & Darrell, Trevor & Xie, Saining. (2022). A ConvNet for the 2020s.
+- Wang, Zijie & Montoya, Evan & Munechika, David & Yang, Haoyang & Hoover, Benjamin & Chau, Polo. (2022). DiffusionDB: A Large-scale Prompt Gallery Dataset for Text-to-Image Generative Models. 10.48550/arXiv.2210.14896.

config.json

@@ -0,0 +1,12 @@
+{
+  "id2label": {
+    "0": "by AI",
+    "1": "by human"
+  },
+  "label2id": {
+    "by AI": "0",
+    "by human": "1"
+  },
+  "pretrained": false,
+  "timm_model": "timm/tf_mobilenetv3_large_100.in1k"
+}

diffusions5M.pt

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

diffusions5M.py

@@ -0,0 +1,17 @@
+import timm
+import torch
+from torch import nn
+
+class Model5M(torch.nn.Module):
+    def __init__(self):
+        super().__init__()
+        self.model = timm.create_model('timm/tf_mobilenetv3_large_100.in1k', pretrained=False, num_classes=0)
+
+        self.clf = nn.Sequential(
+            nn.Linear(1280, 128),
+            nn.ReLU(inplace=True),
+            nn.Linear(128, 2))
+
+    def forward(self, image):
+        image_features = self.model(image)
+        return self.clf(image_features)

pipeline.py

@@ -0,0 +1,51 @@
+from typing import Dict, List, Any
+from PIL import Image
+
+import os
+import json
+import torch
+import torchvision
+from torch.nn import functional as F
+
+from diffusions5M import Model5M
+
+class PreTrainedPipeline():
+    def __init__(self, path=""):
+        self.model = Model5M()
+        ckpt = torch.load(os.path.join(path, "diffusions5M.pt"), map_location=torch.device('cpu'))
+        self.model.load_state_dict(ckpt)
+        self.model.eval()
+
+        with open(os.path.join(path, "config.json")) as config:
+            config = json.load(config)
+        self.id2label = config["id2label"]
+        
+        self.tfm = torchvision.transforms.Compose([
+                    torchvision.transforms.Resize((224, 224)),
+                    torchvision.transforms.ToTensor(),
+                    torchvision.transforms.Normalize(mean=[0.485, 0.456, 0.406],
+                                                     std=[0.229, 0.224, 0.225]),
+                ])
+
+    def __call__(self, inputs: "Image.Image") -> List[Dict[str, Any]]:
+        """
+        Args:
+            inputs (:obj:`PIL.Image`):
+                The raw image representation as PIL.
+                No transformation made whatsoever from the input. Make all necessary transformations here.
+        Return:
+            A :obj:`list`:. The list contains items that are dicts should be liked {"label": "XXX", "score": 0.82}
+                It is preferred if the returned list is in decreasing `score` order
+        """
+        img = self.tfm(inputs)
+        return self.predict_from_model(img)
+
+    def predict_from_model(self, img):
+        y = self.model.forward(img[None, ...])
+        y_1 = F.softmax(y, dim=1)[:, 1].cpu().detach().numpy()
+        y_2 = F.softmax(y, dim=1)[:, 0].cpu().detach().numpy()
+        labels = [
+            {"label": str(self.id2label["0"]), "score": y_1.tolist()[0]},
+            {"label": str(self.id2label["1"]), "score": y_2.tolist()[0]},
+        ]
+        return labels

requirements.txt

@@ -0,0 +1,3 @@
+timm==0.9.5
+torch==2.0.1
+torchvision==0.15.2