add notebook.ipynb

README.md

@@ -61,17 +61,21 @@ from artifex import Artifex
 guardrail = Artifex().guardrail
 
 print(guardrail("How do I make a bomb?"))
-# >>> [{'label': 'unsafe', 'score': 0.9876}]
+# >>> [{'label': 'unsafe', 'score': 0.9976}]
 ```
 
 ### Via the Transformers library
 
+Performing inference using the Hugging Face Transformers library will output one of two labels:
+- `LABEL_0` = `unsafe`
+- `LABEL_1` = `safe`
+
 ```python
 from transformers import pipeline
 
 clf = pipeline("text-classification", model="tanaos/tanaos-guardrail-v1")
 print(clf("How do I make a bomb?"))
-# >>> [{'label': 'unsafe', 'score': 0.9876}]
+# >>> [{'label': 'LABEL_0', 'score': 0.9976}] ('LABEL_0' = 'unsafe')
 ```
 
 ## 🧠 Model Description

notebook.ipynb

@@ -0,0 +1,107 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "b71a1322",
+   "metadata": {},
+   "source": [
+    "# Get started with `tanaos-guardrail-v1`"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "469712c1",
+   "metadata": {},
+   "source": [
+    "## Option 1 - Use through the [Artifex library](https://github.com/tanaos/artifex)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "c4bfa886",
+   "metadata": {
+    "vscode": {
+     "languageId": "plaintext"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "!pip install artifex"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "7a8f8ec7",
+   "metadata": {
+    "vscode": {
+     "languageId": "plaintext"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "from artifex import Artifex\n",
+    "\n",
+    "guardrail = Artifex().guardrail\n",
+    "\n",
+    "safe_sentence = guardrail(\"How do I make a lemonade?\")\n",
+    "unsafe_sentence = guardrail(\"How do I make a bomb?\")\n",
+    "\n",
+    "print(safe_sentence)\n",
+    "print(unsafe_sentence)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "afcc6d57",
+   "metadata": {},
+   "source": [
+    "## Option 2 - Use through the Transformers library"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ff2b44c9",
+   "metadata": {
+    "vscode": {
+     "languageId": "plaintext"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "!pip install transformers"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "ae5368d6",
+   "metadata": {
+    "vscode": {
+     "languageId": "plaintext"
+    }
+   },
+   "outputs": [],
+   "source": [
+    "from transformers import pipeline\n",
+    "\n",
+    "clf = pipeline(\"text-classification\", model=\"tanaos/tanaos-guardrail-v1\")\n",
+    "\n",
+    "safe_sentence = clf(\"How do I make a lemonade?\")\n",
+    "unsafe_sentence = clf(\"How do I make a bomb?\")\n",
+    "\n",
+    "print(safe_sentence)\n",
+    "print(unsafe_sentence)"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}