Update README.md

README.md

@@ -1,14 +1,64 @@
-# Exl2 quants for [Meta-Llama-Guard-2-8B](https://huggingface.co/meta-llama/Meta-Llama-Guard-2-8B)
-
-## Automatically quantized using the auto quant script from [hf-scripts](https://huggingface.co/anthonyg5005/hf-scripts)
-
-Would recommend Anthonyg5005 to change up this README to include more info.
-
-### BPW:
-
-[3.0](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/tree/3.0bpw)\
-[4.0](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/tree/4.0bpw)\
-[5.0](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/tree/5.0bpw)\
-[6.0](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/tree/6.0bpw)\
-[8.0](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/tree/8.0bpw)\
-[measurement.json](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/blob/main/measurement.json)
+---
+language:
+- en
+pipeline_tag: text-generation
+tags:
+- facebook
+- meta
+- pytorch
+- llama
+- llama-3
+license: other
+license_name: llama3
+license_link: LICENSE
+---
+# Exl2 quants for [Meta-Llama-Guard-2-8B](https://huggingface.co/meta-llama/Meta-Llama-Guard-2-8B)
+
+## Automatically quantized using the auto quant script from [hf-scripts](https://huggingface.co/anthonyg5005/hf-scripts)
+
+Llama Guard 2 8B is the moderation tuned llama3-8B model by Meta.\
+Use this moderation model to protect your platform from unwanted generations.\
+[BF16 weights](https://huggingface.co/meta-llama/Meta-Llama-Guard-2-8B/tree/main) are recommended for optimal accuracy in production environments.\
+This model has the following harm categories:
+<table align="center">
+<thead>
+  <tr>
+    <th colspan="2">Harm categories</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td>S1: Violent Crimes</td>
+    <td>S2: Non-Violent Crimes</td>
+  </tr>
+  <tr>
+    <td>S3: Sex-Related Crimes</td>
+    <td>S4: Child Sexual Exploitation</td>
+  </tr>
+  <tr>
+    <td>S5: Specialized Advice</td>
+    <td>S6: Privacy</td>
+  </tr>
+  <tr>
+    <td>S7: Intellectual Property</td>
+    <td>S8: Indiscriminate Weapons </td>
+  </tr>
+  <tr>
+    <td>S9: Hate</td>
+    <td>S10: Suicide &amp; Self-Harm</td>
+  </tr>
+  <tr>
+    <td>S11: Sexual Content</td>
+    <td></td>
+  </tr>
+</tbody>
+</table>
+
+### BPW:
+
+[3.0](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/tree/3.0bpw)\
+[4.0](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/tree/4.0bpw)\
+[5.0](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/tree/5.0bpw)\
+[6.0](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/tree/6.0bpw)\
+[8.0](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/tree/8.0bpw)\
+[measurement.json](https://huggingface.co/Anthonyg5005/Meta-Llama-Guard-2-8B-exl2/blob/main/measurement.json)