# -*- coding: utf-8 -*-
# Copyright (C) 2020 Unbabel
#
# 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.
r"""
XLM-RoBERTa Encoder
==============
Pretrained XLM-RoBERTa encoder from Hugging Face.
"""
from typing import Dict
import torch
from comet.encoders.base import Encoder
from comet.encoders.bert import BERTEncoder
from transformers import XLMRobertaModel, XLMRobertaTokenizer
[docs]class XLMREncoder(BERTEncoder):
"""XLM-RoBERTA Encoder encoder.
:param pretrained_model: Pretrained model from hugging face.
"""
def __init__(self, pretrained_model: str) -> None:
super(Encoder, self).__init__()
self.tokenizer = XLMRobertaTokenizer.from_pretrained(pretrained_model)
self.model = XLMRobertaModel.from_pretrained(
pretrained_model, add_pooling_layer=False
)
self.model.encoder.output_hidden_states = True
[docs] @classmethod
def from_pretrained(cls, pretrained_model: str) -> Encoder:
"""Function that loads a pretrained encoder from Hugging Face.
:param pretrained_model: Name of the pretrain model to be loaded.
:return: Encoder model
"""
return XLMREncoder(pretrained_model)
[docs] def forward(
self, input_ids: torch.Tensor, attention_mask: torch.Tensor, **kwargs
) -> Dict[str, torch.Tensor]:
last_hidden_states, _, all_layers = self.model(
input_ids=input_ids,
attention_mask=attention_mask,
output_hidden_states=True,
return_dict=False,
)
return {
"sentemb": last_hidden_states[:, 0, :],
"wordemb": last_hidden_states,
"all_layers": all_layers,
"attention_mask": attention_mask,
}