feat: add license and readme
Browse files
LICENSE
CHANGED
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
Except for any logos, trade marks, service marks, names, insignias, emblems, the Singapore state crest and Singapore national coat of arms, and/or any other graphic, image or sound which is used to identify any Singapore public sector agency or is associated with any Singapore public sector agency, or which belongs to a third party such as Shutterstock, Inc., and/or any asset or code identified by the Government Technology Agency (“GovTech”) as not licensed to you (such identification may come in the form of a filename labelled with “restricted” or similar phrasing), the contents of this repository are provided under the MIT License SUBJECT FURTHER TO THE FOLLOWING:
|
2 |
+
|
3 |
+
(1) The MIT License and the terms herein (collectively, the “Terms”) shall be governed by the laws of Singapore. Any dispute arising out of or in connection with the Terms, including any question regarding its existence, validity or termination, shall be referred to and finally resolved by arbitration administered by the Singapore International Arbitration Centre (“SIAC”) in accordance with the Arbitration Rules of the Singapore International Arbitration Centre (“SIAC Rules”) for the time being in force, which rules are deemed to be incorporated by reference in this clause. The seat of arbitration shall be Singapore. The Tribunal shall consist of one (1) arbitrator. The language of the arbitration shall be English.
|
4 |
+
|
5 |
+
MIT License
|
6 |
+
|
7 |
+
Copyright 2020 Government Technology Agency.
|
8 |
+
|
9 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
10 |
+
|
11 |
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
12 |
+
|
13 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
README.md
CHANGED
@@ -3,3 +3,19 @@ license: other
|
|
3 |
license_name: govtech-singapore
|
4 |
license_link: LICENSE
|
5 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 |
+
```
|