Update README.md
Browse files
README.md
CHANGED
|
@@ -1,21 +1,23 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: other
|
| 3 |
-
license_name: govtech-singapore
|
| 4 |
-
license_link: LICENSE
|
| 5 |
-
---
|
| 6 |
-
|
| 7 |
-
# LionGuard
|
| 8 |
-
|
| 9 |
-
LionGuard is a classifier for detecting unsafe content in the Singapore context. It uses pre-trained BAAI English embeddings and performs classification with a trained Ridge Classification model.
|
| 10 |
-
|
| 11 |
-
# Usage
|
| 12 |
-
|
| 13 |
-
1. Install `transformers` , `onnxruntime` and `huggingface_hub` libraries.
|
| 14 |
-
```
|
| 15 |
-
pip install transformers onnxruntime huggingface_hub
|
| 16 |
-
```
|
| 17 |
-
|
| 18 |
-
2. Run inference.
|
| 19 |
-
```
|
| 20 |
-
python inference.py '["Example text 1"]'
|
| 21 |
-
```
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: other
|
| 3 |
+
license_name: govtech-singapore
|
| 4 |
+
license_link: LICENSE
|
| 5 |
+
---
|
| 6 |
+
|
| 7 |
+
# LionGuard
|
| 8 |
+
|
| 9 |
+
LionGuard is a classifier for detecting unsafe content in the Singapore context. It uses pre-trained BAAI English embeddings and performs classification with a trained Ridge Classification model.
|
| 10 |
+
|
| 11 |
+
# Usage
|
| 12 |
+
|
| 13 |
+
1. Install `transformers` , `onnxruntime` and `huggingface_hub` libraries.
|
| 14 |
+
```
|
| 15 |
+
pip install transformers onnxruntime huggingface_hub
|
| 16 |
+
```
|
| 17 |
+
|
| 18 |
+
2. Run inference.
|
| 19 |
+
```
|
| 20 |
+
python inference.py '["Example text 1"]'
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
Technical report is available [here](https://arxiv.org/abs/2407.10995).
|