Instructions to use J-MADRAL/R-BiBERT with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use J-MADRAL/R-BiBERT with Transformers:
# Load model directly from transformers import AutoModel model = AutoModel.from_pretrained("J-MADRAL/R-BiBERT", dtype="auto") - Notebooks
- Google Colab
- Kaggle
R-BiBERT is a BERT-sized dense retriever initialized from BERT public checkpoint, further pre-trained on e-commerce review data, and fine-tuned on review search retrieval task on the Search ESCI dataset. It uses a symmetric encoder architecture, with a single shared encoder for both queries and products. The similarity function is dot product.
Paper and Repository
R-BiBERT has been described in the Multi-Aspect Joint Retrieval for E-Commerce: Bridging Product Catalogs and Customer Reviews paper. The associated GitHub repository is available at https://anonymous.4open.science/r/J-MADRAL-C4CC.
Usage (HuggingFace Transformers)
Using the model directly in HuggingFace transformers requires additional code available in the repository.
import modeling
import torch
import transformers
# We use a training query from Search ESCI as an example.
queries = [
"cotton summer dress care instructions"
]
reviews = [
"Cute, cool and comfy summer dress [...] Hand wash and line drys easily, material is crinkly so no ironing needed. [...]",
"Excellent machine JET J-2530 15-Inch 3/4-Horsepower Bench Drill Press. Two common Amazon reviewer complaints about higher-end drill presses [...]"
]
# Load the tokenizer and model.
tokenizer = transformers.AutoTokenizer.from_pretrained("J-MADRAL/R-BiBERT")
model = modeling.BiEncoderModel.from_pretrained("J-MADRAL/R-BiBERT")
# Tokenize the input data.
q_input = tokenizer(queries,
add_special_tokens=True,
truncation=True,
padding=True,
max_length=128,
return_tensors="pt")
r_input = tokenizer(reviews,
add_special_tokens=True,
truncation=True,
padding=True,
max_length=128,
return_tensors="pt")
# Compute embeddings: take the "pooled_output".
q_emb = model(**q_input).pooled_output
r_emb = model(**r_input).pooled_output
# Compute similarity scores, using dot product similarity.
scores = torch.matmul(q_emb, r_emb.transpose(0, 1))
Training Hyperparameters
| Training Stage | Num. Epochs | Learning Rate | AP Scaling Factor | Max Num Tokens | Batch Size | Num Negatives |
|---|---|---|---|---|---|---|
| Pre-training | 20 | 1e-4 | 0.10 | 128 | 64 | --- |
| Fine-tuning | 20 | 5e-6 | 0.05 | 128 | 64 | 7 |
The data used for fine-tuning is available at https://huggingface.co/datasets/J-MADRAL/TrainingData.
Evaluation Results
Search ESCI
- Downloads last month
- 5
Model tree for J-MADRAL/R-BiBERT
Base model
google-bert/bert-base-uncased