Skip to content

Commit 36ff890

Browse files
committed
docs(docker): list export_onnx.py and clarify HF_TOKEN for model download
1 parent edd6eed commit 36ff890

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

docker/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ docker/
2828
├── .env.example # copy to .env, add your API key
2929
├── piguard/ # PIGuard model download helper
3030
│ ├── download-model.sh
31+
│ ├── export_onnx.py # non-interactive ONNX exporter
3132
│ └── models/ # populated once by download-model.sh
3233
└── workspace/ # the dir the agent works in (mounted in)
3334
```
@@ -284,9 +285,13 @@ first time, run:
284285
./piguard/download-model.sh
285286
```
286287

287-
This downloads the export script and requirements from the guard repo, exports the ONNX
288-
model and tokenizer inside a disposable Python container, and copies the result to
289-
`docker/piguard/models/`. It is safe to re-run; it skips if the model is already present.
288+
This runs a self-contained Python container that downloads the model from HuggingFace
289+
and converts it to ONNX. It can take **5–15 minutes** depending on bandwidth and CPU.
290+
Set `HF_TOKEN` if you have one (higher rate limits):
291+
292+
```bash
293+
HF_TOKEN=hf_xxx ./piguard/download-model.sh
294+
```
290295

291296
### Running with the guard
292297

0 commit comments

Comments
 (0)