HeHeYeast/bert_base_retriever

Uso (Sentence-Transformers)

Usar este modelo es fácil cuando tienes sentence-transformers instalado:

pip install -U sentence-transformers

Luego puedes usar el modelo de esta manera:

from sentence_transformers import SentenceTransformer
sentences = ["Esta es una oración de ejemplo", "Cada oración es convertida"]

model = SentenceTransformer('{MODEL_NAME}')
embeddings = model.encode(sentences)
print(embeddings)

Uso (HuggingFace Transformers)

Sin sentence-transformers, puedes usar el modelo de esta manera: Primero, pasas tu entrada por el modelo transformer, luego debes aplicar la operación de pooling correcta sobre las embeddings de palabras contextualizadas.

from transformers import AutoTokenizer, AutoModel
import torch

#Mean Pooling - Tener en cuenta la máscara de atención para promediar correctamente

#Pool significa hacer promedios, y Attention_mask se refiere a la máscara de atención que pone a 1 donde haya una palabra útil para el vector embedding

def mean_pooling(model_output, attention_mask):
    token_embeddings = model_output[0] #El primer elemento del output del modelo contiene todas las embeddings de los tokens
    input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
    return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9)

# Oraciones para las cuales queremos embeddings

sentences = ['Esta es una oración de ejemplo', 'Cada oración es convertida']

# Cargar el modelo desde HuggingFace Hub


#Distribuir la entrada por el modelo



## Crear attention_mask para asegurar que cada palabra importante tiene su vector

from transformers import AutoTokenizer, AutoModel
import torch

# Mean Pooling - Tener en cuenta la máscara de atención para el promedio correcto

def mean_pooling(model_output, attention_mask):
    token_embeddings = model_output[0] #El primer elemento del model_output contiene todas las embeddings de tokens
    input_mask_expanded = attention_mask.unsqueeze(-1).expand(token_embeddings.size()).float()
    return torch.sum(token_embeddings * input_mask_expanded, 1) / torch.clamp(input_mask_expanded.sum(1), min=1e-9), model_output

# Oraciones para las cuales queremos las embeddings de oraciones
sentences = ['Esta es una oración de ejemplo', 'Cada oración es convertida']

# Cargar modelo desde HuggingFace Hub


model = AutoModel.from_pretrained('HeHeYeast/bert_base_retriever')

# Tokenización de oraciones
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')

# Computar las embeddings de tokens
with torch.no_grad():
    model_output = model(**encoded_input)

# Realizar pooling. En este caso, mean pooling.
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])

print('Embeddings de oraciones:')
print(sentence_embeddings)

Resultados de Evaluación

Para una evaluación automatizada de este modelo, ver el Benchmark de Embeddings de Oraciones: https://seb.sbert.net

Entrenamiento

El modelo fue entrenado con los parámetros:

DataLoader: 
torch.utils.data.dataloader.DataLoader de longitud 6451 con parámetros:
{'batch_size': 32, 'sampler': 'torch.utils.data.sampler.RandomSampler', 'batch_sampler': 'torch.utils.data.sampler.BatchSampler'}

Pérdida:

sentence_transformers.losses.MultipleNegativesRankingLoss.MultipleNegativesRankingLoss con parámetros:
{'scale': 20.0, 'similarity_fct': 'cos_sim'}

Parámetros del Método fit():

{
    "epochs": 10,
    "evaluation_steps": 0,
    "evaluator": "api_evaluator.APIEvaluator",
    "max_grad_norm": 1,
    "optimizer_class": "",
    "optimizer_params": {
        "lr": 2e-05
    },
    "scheduler": "WarmupLinear",
    "steps_per_epoch": null,
    "warmup_steps": 500.0,
    "weight_decay": 0.01
}

Arquitectura Completa del Modelo

SentenceTransformer(
    (0): Transformer({'max_seq_length': 320, 'do_lower_case': False}) con modelo Transformer: BertModel
    (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False})
)