summaryrefslogtreecommitdiff
path: root/candle-examples/examples/quantized-t5/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'candle-examples/examples/quantized-t5/README.md')
-rw-r--r--candle-examples/examples/quantized-t5/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/candle-examples/examples/quantized-t5/README.md b/candle-examples/examples/quantized-t5/README.md
new file mode 100644
index 00000000..1f6b99eb
--- /dev/null
+++ b/candle-examples/examples/quantized-t5/README.md
@@ -0,0 +1,17 @@
+# candle-quantized-t5
+
+This example uses a quantized version of the t5 model.
+
+```bash
+$ cargo run --example quantized-t5 --release -- --prompt "translate to German: A beautiful candle."
+...
+ Eine schöne Kerze.
+```
+
+The weight file is automatically retrieved from the hub. It is also possible to
+generate quantized weight files from the original safetensors file by using the
+`tensor-tools` command line utility via:
+
+```bash
+cargo run --example tensor-tools --release -- quantize --quantization q6k PATH/TO/T5/model.safetensors /tmp/model.gguf
+```