readme yaml

README.md

@@ -1,3 +1,37 @@
+---
+language: 
+  - en
+tags:
+  - image-classification
+  - font-detection
+  - resnet
+  - fine-tuning
+datasets:
+  - custom
+license: mit
+library_name: transformers
+base_model: resnet-18
+---
+
+# Comic Sans Detector
+
+This repository contains a fine-tuned ResNet-18 model, specifically trained to detect whether an image contains Comic Sans font. It is a fine-tuning of a previously fine-tuned font classification model, based on the ResNet-18 foundation model.
+
+## Features
+- Distinguishes between Comic Sans and non-Comic Sans images.
+- Built using a custom dataset with two classes: `comic` and `not-comic`.
+
+## Usage
+To use this model with the Hugging Face Inference API:
+
+```python
+from transformers import pipeline
+
+classifier = pipeline("image-classification", model="shoni/comic-sans-detector")
+result = classifier("path/to/image.jpg")
+print(result)
+
+
 # Comic Sans Detector
 
 This repository contains a fine-tuned ResNet-18 model, specifically trained to detect whether an image contains Comic Sans font. It is a fine-tuning of a previously fine-tuned font classification model, based on the ResNet-18 foundation model.