Updated Readme.md

README.md

@@ -1,3 +1,35 @@
 ---
+language:
+- en
+tags:
+- toxicity
 license: cc-by-nc-sa-4.0
 ---
+
+This model is an ONNX optimized variant of the original [roberta_toxicity_classifier](https://huggingface.co/s-nlp/roberta_toxicity_classifier) model.
+The model is specifically optimized for GPUs and may have performance differences when executed on CPUs.
+
+## How to use
+```python
+from transformers import AutoTokenizer
+from optimum.onnxruntime import ORTModelForSequenceClassification
+from optimum.pipelines import pipeline
+
+# load tokenizer and model weights
+tokenizer = AutoTokenizer.from_pretrained('Deepchecks/roberta_toxicity_classifier_onnx')
+model = ORTModelForSequenceClassification.from_pretrained('Deepchecks/roberta_toxicity_classifier_onnx')
+
+# prepare the pipeline and generate inferences
+pip = pipeline(task='text-classification', model=onnx_model, tokenizer=tokenizer, device=device, accelerator="ort")
+res = pip(user_inputs, batch_size=64, truncation="only_first")
+
+```
+
+## Licensing Information
+
+[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa].
+
+[![CC BY-NC-SA 4.0][cc-by-nc-sa-image]][cc-by-nc-sa]
+
+[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/
+[cc-by-nc-sa-image]: https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png