summaryrefslogtreecommitdiff
path: root/candle-examples
diff options
context:
space:
mode:
authorLaurent Mazare <laurent.mazare@gmail.com>2024-02-14 15:31:33 +0100
committerGitHub <noreply@github.com>2024-02-14 15:31:33 +0100
commit058a910d0e1e9bb511209b1f756a6cd07a347889 (patch)
tree74ffad40d0845dfb5c0693f97638adc0b9b1b392 /candle-examples
parent26fe162ab5e64faca39cf6ccaa6a8513ce1240f0 (diff)
downloadcandle-058a910d0e1e9bb511209b1f756a6cd07a347889.tar.gz
candle-058a910d0e1e9bb511209b1f756a6cd07a347889.tar.bz2
candle-058a910d0e1e9bb511209b1f756a6cd07a347889.zip
Add a readme for rwkv. (#1712)
Diffstat (limited to 'candle-examples')
-rw-r--r--candle-examples/examples/rwkv/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/candle-examples/examples/rwkv/README.md b/candle-examples/examples/rwkv/README.md
new file mode 100644
index 00000000..f17a1d98
--- /dev/null
+++ b/candle-examples/examples/rwkv/README.md
@@ -0,0 +1,17 @@
+## candle-rwkv
+
+The [RWKV model](https://wiki.rwkv.com/) is a recurrent neural network model
+with performance on par with transformer architectures. Several variants are
+available, candle implements the v5 version and can be used with Eagle 7B([blog
+post](https://blog.rwkv.com/p/eagle-7b-soaring-past-transformers)).
+
+```bash
+$ cargo run --example rwkv --release -- --prompt "The smallest prime is "
+avx: true, neon: false, simd128: false, f16c: true
+temp: 0.00 repeat-penalty: 1.10 repeat-last-n: 64
+The smallest prime is ϕ(2) = 2.
+The smallest composite is ϕ(3) = 3.
+The smallest perfect number is ϕ(5) = 5.
+The smallest perfect square is ϕ(4) = 4.
+The smallest perfect cube is ϕ(6) = 6.
+```