mirror of
https://github.com/huggingface/candle.git
synced 2025-06-18 19:47:12 +00:00
91f1f019b1
* add xlm-roberta-base * Add task enum for fill-mask and reranker in xlm-roberta example; update README and fix attention mask dimensions - Introduced a new `Task` enum to replace string task identifiers in the xlm-roberta example. - Updated the logic in `main.rs` to handle tasks using the new enum. - Enhanced README with example output for fill-mask task. - Fixed dimension retrieval in `prepare_4d_attention_mask` function for better clarity and safety. * Clippy fix. --------- Co-authored-by: laurent <laurent.mazare@gmail.com>
31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
# 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.
|
|
--------------------------------------------------------------------------------
|
|
```
|