summaryrefslogtreecommitdiff
path: root/candle-examples/examples/modernbert/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'candle-examples/examples/modernbert/README.md')
-rw-r--r--candle-examples/examples/modernbert/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/candle-examples/examples/modernbert/README.md b/candle-examples/examples/modernbert/README.md
new file mode 100644
index 00000000..4eba2d7d
--- /dev/null
+++ b/candle-examples/examples/modernbert/README.md
@@ -0,0 +1,12 @@
+# candle-modernbert
+
+ModernBERT is a bidirectional encoder-only language model. In this example it is used for the fill-mask task:
+
+## Usage
+
+```bash
+cargo run --example modernbert --release -- --model modern-bert-large --prompt 'The capital of France is [MASK].'
+```
+```markdown
+Sentence: 1 : The capital of France is Paris.
+```