summaryrefslogtreecommitdiff
path: root/examples/train-text-from-scratch/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/train-text-from-scratch/README.md')
-rw-r--r--examples/train-text-from-scratch/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/examples/train-text-from-scratch/README.md b/examples/train-text-from-scratch/README.md
new file mode 100644
index 00000000..5344d1f5
--- /dev/null
+++ b/examples/train-text-from-scratch/README.md
@@ -0,0 +1,22 @@
+# train-text-from-scratch
+
+Basic usage instructions:
+
+```bash
+# get training data
+wget https://github.com/brunoklein99/deep-learning-notes/blob/master/shakespeare.txt
+
+# train
+./bin/train-text-from-scratch \
+ --vocab-model ../models/ggml-vocab.bin \
+ --ctx 64 --embd 256 --head 8 --layer 16 \
+ --checkpoint-in chk-shakespeare-256x16.bin \
+ --checkpoint-out chk-shakespeare-256x16.bin \
+ --model-out ggml-shakespeare-256x16-f32.bin \
+ --train-data "shakespeare.txt" \
+ -t 6 -b 16 -n 32 --seed 1 --adam-iter 16 \
+ --print-details-interval 0 --predict 16 --use-flash
+
+# predict
+./bin/main -m ggml-shakespeare-256x16-f32.bin
+```