Struct FillMaskPipeline

pub struct FillMaskPipeline { /* private fields */ }

A ready-to-use pipeline for filling masked tokens using ModernBERT.

After building with FillMaskPipelineBuilder, call fill_mask(text) to predict the masked token.

Example:

use transformers::pipelines::fill_mask_pipeline::{FillMaskPipelineBuilder, ModernBertSize};

let pipeline = FillMaskPipelineBuilder::new(ModernBertSize::Base)
   .build()?;

let output = pipeline.fill_mask("The capital of France is [MASK].")?;
// output might be "The capital of France is Paris."
println!("{}", output);

Implementations

impl FillMaskPipeline

pub fn fill_mask(&self, text: &str) -> Result<String>

Fills the [MASK] token in a given text string.

Expects the input text to contain exactly one instance of "[MASK]". Returns the text with the mask replaced by the predicted token.

Examples found in repository

examples/fill_mask_pipeline.rs (line 18)

fn main() -> Result<()> {
    println!("Building fill-mask pipeline...");

    // 1. Create the pipeline, selecting the desired model size
    let pipeline = FillMaskPipelineBuilder::new(ModernBertSize::Base)
        // Optionally configure other settings like .revision("..."), .cpu(), etc.
        .build()?;
    println!("Pipeline built successfully.");

    // 2. Define the prompt with a [MASK] token
    let prompt = "The capital of France is [MASK].";
    println!("\nFilling mask for prompt: '{}'", prompt);

    // 3. Fill the mask
    let filled_text = pipeline.fill_mask(prompt)?;

    println!("\n--- Result ---");
    println!("{}", filled_text);
    println!("--- End ---\n");

    // Example 2
    let prompt2 = "I'm a [MASK] model.";
    println!("Filling mask for prompt: '{}'", prompt2);
    let filled_text2 = pipeline.fill_mask(prompt2)?;
    println!("\n--- Result 2 ---");
    println!("{}", filled_text2);
    println!("--- End 2 ---\n");

    Ok(())
}