rust-bert 0.7.6

Ready-to-use NLP pipelines and transformer-based models (BERT, DistilBERT, GPT2,...)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

// Copyright 2020 The Facebook AI Research Team Authors
// Copyright 2020-present, the HuggingFace Inc. team.
// Copyright 2020 Guillaume Becquin
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//     http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use tch::{nn, Tensor};
use tch::nn::{EmbeddingConfig, embedding};
use tch::kind::Kind::Int64;


/// # Abstraction that holds a embeddings configuration
pub enum EmbeddingOption {
    /// PositionalEmbedding
    LearnedPositionalEmbedding(LearnedPositionalEmbedding),
    SinusoidalPositionalEmbedding(SinusoidalPositionalEmbedding),
}

impl EmbeddingOption {
    /// Interface method to forward_t() of the particular models.
    pub fn forward(&self, input: &Tensor, generation_mode: bool) -> Tensor {
        match *self {
            Self::LearnedPositionalEmbedding(ref embeddings) => embeddings.forward(input, generation_mode),
            Self::SinusoidalPositionalEmbedding(ref embeddings) => embeddings.forward(input, generation_mode)
        }
    }
}

#[derive(Debug)]
pub struct LearnedPositionalEmbedding {
    embedding: nn::Embedding,
    padding_index: i64,
}

impl LearnedPositionalEmbedding {
    pub fn new(p: nn::Path, num_embeddings: i64, embedding_dim: i64, padding_index: i64) -> LearnedPositionalEmbedding {
        let embedding_config = EmbeddingConfig { padding_idx: padding_index, ..Default::default() };
        let num_embeddings = num_embeddings + padding_index + 1;

        let embedding: nn::Embedding = embedding(p,
                                                 num_embeddings,
                                                 embedding_dim,
                                                 embedding_config);
        LearnedPositionalEmbedding { embedding, padding_index }
    }

    pub fn forward(&self, input: &Tensor, generation_mode: bool) -> Tensor {
        let positions = if generation_mode {
            let positions = self.padding_index + input.size()[1];
            input.new_full(&[1, 1], positions, (Int64, input.device()))
        } else {
            self.create_position_ids_from_input_ids(input, self.padding_index)
        };
        positions.apply(&self.embedding)
    }

    fn create_position_ids_from_input_ids(&self, input_ids: &Tensor, padding_index: i64) -> Tensor {
        let mask = input_ids.ne(padding_index).to_kind(Int64);
        let position_ids: Tensor = mask.cumsum(1, Int64) * mask + padding_index;
        position_ids
    }
}

#[derive(Debug)]
pub struct SinusoidalPositionalEmbedding {
    embedding: nn::Embedding,
}

impl SinusoidalPositionalEmbedding {
    pub fn new(p: nn::Path, num_embeddings: i64, embedding_dim: i64) -> SinusoidalPositionalEmbedding {
        let embedding: nn::Embedding = embedding(p,
                                                 num_embeddings,
                                                 embedding_dim,
                                                 Default::default());
        SinusoidalPositionalEmbedding { embedding }
    }

    pub fn forward(&self, input: &Tensor, generation_mode: bool) -> Tensor {
        let positions = if generation_mode {
            Tensor::full(&[1, 1], input.size()[1] - 1, (Int64, input.device()))
        } else {
            Tensor::arange(input.size()[1],(Int64, input.device()))
        };
        positions.apply(&self.embedding)
    }
}