Update README.md

README.md

@@ -1,3 +1,30 @@
 ---
 license: cc-by-4.0
 ---
+# MarkupLM-Phish
+
+The [MarkupLM]('https://huggingface.co/docs/transformers/v4.39.1/model_doc/markuplm') base model fine-tuned for phish classification!
+
+## Example Pipeline
+```python
+import requests
+from transformers import AutoProcessor, pipeline
+
+phish_processor = AutoProcessor.from_pretrained(
+    "pogzyb/markuplm-phish", trust_remote_code=True
+)
+phish_pipeline = pipeline(
+    "text-classification",
+    model="pogzyb/markuplm-phish",
+    tokenizer=phish_processor,
+    max_length=512,
+    padding="max_length",
+    truncation=True,
+)
+html_string = requests.get("https://huggingface.co").text
+phish_pipeline(html_string)
+```
+
+```
+[{'label': 'negative', 'score': 0.9991624355316162}]
+```