pub struct MobileBertForMultipleChoice { /* private fields */ }
Expand description

MobileBERT for multiple choices

Multiple choices model using a MobileBERT base model and a linear classifier. Input should be in the form [CLS] Context [SEP] Possible choice [SEP]. The choice is made along the batch axis, assuming all elements of the batch are alternatives to be chosen from for a given context. It is made of the following blocks:

  • mobilebert: Base MobileBertModel
  • dropout: Dropout layer before the last start/end logits prediction
  • classifier: Linear layer for multiple choices

Implementations§

Build a new MobileBertForMultipleChoice

Arguments
  • p - Variable store path for the root of the MobileBERT model
  • config - MobileBertConfig object defining the model architecture and decoder status
Example
use rust_bert::mobilebert::{MobileBertConfig, MobileBertForMultipleChoice};
use rust_bert::Config;
use std::path::Path;
use tch::{nn, Device};

let config_path = Path::new("path/to/config.json");
let device = Device::Cpu;
let p = nn::VarStore::new(device);
let config = MobileBertConfig::from_file(config_path);
let mobilebert = MobileBertForMultipleChoice::new(&p.root(), &config);

Forward pass through the model

Arguments
  • input_ids - Optional input tensor of shape (batch size, sequence_length). If None, pre-computed embeddings must be provided (see input_embeds)
  • token_type_ids - Optional segment id of shape (batch size, sequence_length). Convention is value of 0 for the first sentence (incl. SEP) and 1 for the second sentence. If None set to 0.
  • position_ids - Optional position ids of shape (batch size, sequence_length). If None, will be incremented from 0.
  • input_embeds - Optional pre-computed input embeddings of shape (batch size, sequence_length, hidden_size). If None, input ids must be provided (see input_ids)
  • attention_mask - Optional mask of shape (batch size, sequence_length). Masked position have value 0, non-masked value 1. If None set to 1
  • train - boolean flag to turn on/off the dropout layers in the model. Should be set to false for inference.
Returns
  • MobileBertSequenceClassificationOutput containing:
    • logits - Tensor of shape (1, batch_size) containing the logits for each of the alternatives given
    • all_hidden_states - Option<Vec<Tensor>> of length num_hidden_layers with shape (batch size, sequence_length, hidden_size)
    • all_attentions - Option<Vec<Tensor>> of length num_hidden_layers with shape (batch size, sequence_length, hidden_size)
Example
use rust_bert::mobilebert::{MobileBertConfig, MobileBertForMultipleChoice};
let model = MobileBertForMultipleChoice::new(&vs.root(), &config);
let (batch_size, sequence_length) = (64, 128);
let (num_choices, sequence_length) = (3, 128);
let input_tensor = Tensor::rand(&[num_choices, sequence_length], (Int64, device));
let attention_mask = Tensor::zeros(&[num_choices, sequence_length], (Int64, device));
let token_type_ids = Tensor::zeros(&[num_choices, sequence_length], (Int64, device));
let position_ids = Tensor::arange(sequence_length, (Int64, device))
    .expand(&[num_choices, sequence_length], true);

let model_output = no_grad(|| {
    model
        .forward_t(
            Some(&input_tensor),
            Some(&token_type_ids),
            Some(&position_ids),
            None,
            Some(&attention_mask),
            false,
        )
        .unwrap()
});

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The alignment of pointer.
The type for initializers.
Initializes a with the given initializer. Read more
Dereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
Drops the object pointed to by the given pointer. Read more
Should always be Self
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more