Skip to content

Commit cd48189

Browse files
committed
Be more explicit about how to install the models
1 parent 42a55f2 commit cd48189

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ pip
2929
## Models
3030

3131
1. Download models from [the latest release of this repository](https://github.com/GateNLP/ToxicClassifier/releases/latest) (currently available `kaggle.tar.gz`, `olid.tar.gz`)
32-
2. Decompress file inside `models/en/`
32+
2. Decompress file inside `models/en/` (which will create `models/en/kaggle` or `models/en/olid` respectively)
3333

3434
## Basic Usage
3535

docker/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The toxic and offensive classifiers are deployed on GATE Cloud via a two step pr
44

55
## Building the Python classifier images
66

7-
The Python-based classifiers for toxic and offensive language can be built using the `./build.sh` script in this directory. The images are pushed to the GitHub container registry:
7+
The Python-based classifiers for toxic (kaggle dataset) and offensive (olid dataset) language can be built using the `./build.sh` script in this directory. The relevant model files must be downloaded and unpacked in `../models` as described in [the main README](../README.md). The images are pushed to the GitHub container registry:
88

99
```
1010
TAG=ghcr.io/gatenlp/toxicclassifier/toxic-classifier:latest ./build.sh en/kaggle Toxic

0 commit comments

Comments
 (0)