summaryrefslogtreecommitdiff
path: root/candle-examples/examples/mamba/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'candle-examples/examples/mamba/README.md')
-rw-r--r--candle-examples/examples/mamba/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/candle-examples/examples/mamba/README.md b/candle-examples/examples/mamba/README.md
new file mode 100644
index 00000000..507434a1
--- /dev/null
+++ b/candle-examples/examples/mamba/README.md
@@ -0,0 +1,17 @@
+# candle-mamba: Mamba implementation
+
+Candle implementation of *Mamba* [1] inference only. Mamba is an alternative to
+the transformer architecture. It leverages State Space Models (SSMs) with the
+goal of being computationally efficient on long sequences. The implementation is
+based on [mamba.rs](https://github.com/LaurentMazare/mamba.rs).
+
+- [1]. [Mamba: Linear-Time Sequence Modeling with Selective State Spaces](https://arxiv.org/abs/2312.00752).
+
+Compared to the mamba-minimal example, this version is far more efficient but
+would only work for inference.
+## Running the example
+
+```bash
+$ cargo run --example mamba-minimal --release -- --prompt "Mamba is the"
+```
+