diff options
Diffstat (limited to 'candle-examples/examples/xlm-roberta/Readme.md')
| -rw-r--r-- | candle-examples/examples/xlm-roberta/Readme.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/candle-examples/examples/xlm-roberta/Readme.md b/candle-examples/examples/xlm-roberta/Readme.md new file mode 100644 index 00000000..496b14e3 --- /dev/null +++ b/candle-examples/examples/xlm-roberta/Readme.md @@ -0,0 +1,30 @@ +# candle-xlm-roberta + +This example demonstrates how to use the XLM-RoBERTa model in Candle especially known for their use in reranking. It uses the `fill-mask` task to generate a word for a masked token. And a `reranker` task to rerank a list of documents for a given query. + +## Usage + +Fill Mask: +```bash +cargo run --example xlm-roberta --release -- --task fill-mask --model xlm-roberta-base +``` +```markdown +Sentence: 0 : Hello I'm a fashion model. +Sentence: 1 : I'm a little boy. +Sentence: 2 : I'm living in berlin. +``` + +Reranker: +```bash +cargo run --example xlm-roberta --release -- --task reranker --model bge-reranker-base +``` +```markdown +Ranking Results: +-------------------------------------------------------------------------------- +> Rank #4 | Score: 0.0001 | South Korea is a country in East Asia. +> Rank #5 | Score: 0.0000 | There are forests in the mountains. +> Rank #2 | Score: 0.7314 | Pandas look like bears. +> Rank #3 | Score: 0.6948 | There are some animals with black and white fur. +> Rank #1 | Score: 0.9990 | The giant panda (Ailuropoda melanoleuca), sometimes called a panda bear or simply panda, is a bear species endemic to China. +-------------------------------------------------------------------------------- +``` |