pub struct DistilBertModel { /* private fields */ }
Expand description
§DistilBERT Base model
Base architecture for DistilBERT models. Task-specific models will be built from this common base model It is made of the following blocks:
embeddings
:token
,position
embeddingstransformer
: Transformer made of a vector of layers. Each layer is made of a multi-head self-attention layer, layer norm and linear layers.
Implementations§
Source§impl DistilBertModel
Defines the implementation of the DistilBertModel.
impl DistilBertModel
Defines the implementation of the DistilBertModel.
Sourcepub fn new<'p, P>(p: P, config: &DistilBertConfig) -> DistilBertModel
pub fn new<'p, P>(p: P, config: &DistilBertConfig) -> DistilBertModel
Build a new DistilBertModel
§Arguments
p
- Variable store path for the root of the DistilBERT modelconfig
-DistilBertConfig
object defining the model architecture
§Example
use rust_bert::distilbert::{DistilBertConfig, DistilBertModel};
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 = DistilBertConfig::from_file(config_path);
let distil_bert: DistilBertModel = DistilBertModel::new(&p.root() / "distilbert", &config);
Sourcepub fn forward_t(
&self,
input: Option<&Tensor>,
mask: Option<&Tensor>,
input_embeds: Option<&Tensor>,
train: bool,
) -> Result<DistilBertTransformerOutput, RustBertError>
pub fn forward_t( &self, input: Option<&Tensor>, mask: Option<&Tensor>, input_embeds: Option<&Tensor>, train: bool, ) -> Result<DistilBertTransformerOutput, RustBertError>
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 (seeinput_embeds
)mask
- Optional mask of shape (batch size, sequence_length). Masked position have value 0, non-masked value 1. If None set to 1input_embeds
- Optional pre-computed input embeddings of shape (batch size, sequence_length, hidden_size). If None, input ids must be provided (seeinput_ids
)train
- boolean flag to turn on/off the dropout layers in the model. Should be set to false for inference.
§Returns
DistilBertTransformerOutput
containing:hidden_state
-Tensor
of shape (batch size, sequence_length, hidden_size)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::distilbert::{DistilBertConfig, DistilBertModel};
let (batch_size, sequence_length) = (64, 128);
let input_tensor = Tensor::rand(&[batch_size, sequence_length], (Int64, device));
let mask = Tensor::zeros(&[batch_size, sequence_length], (Int64, device));
let model_output = no_grad(|| {
distilbert_model
.forward_t(Some(&input_tensor), Some(&mask), None, false)
.unwrap()
});
Auto Trait Implementations§
impl Freeze for DistilBertModel
impl RefUnwindSafe for DistilBertModel
impl Send for DistilBertModel
impl !Sync for DistilBertModel
impl Unpin for DistilBertModel
impl UnwindSafe for DistilBertModel
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more