README.md

metadata

pipeline_tag: sentence-similarity
tags:
  - sentence-transformers
  - feature-extraction
  - sentence-similarity
  - transformers
license: cc-by-4.0
language: pa
widget:
  - source_sentence: ਪੇਂਟਿੰਗ ਮੇਰਾ ਸ਼ੌਕ ਹੈ
    sentences:
      - ਨੱਚਣਾ ਮੇਰਾ ਸ਼ੌਕ ਹੈ
      - ਮੇਰੇ ਬਹੁਤ ਸਾਰੇ ਸ਼ੌਕ ਹਨ
      - ਮੈਨੂੰ ਪੇਂਟਿੰਗ ਅਤੇ ਡਾਂਸ ਦੋਵਾਂ ਦਾ ਆਨੰਦ ਆਉਂਦਾ ਹੈ
    example_title: Example 1
  - source_sentence: ਕੁਝ ਲੋਕ ਗਾ ਰਹੇ ਹਨ
    sentences:
      - ਲੋਕਾਂ ਦਾ ਇੱਕ ਸਮੂਹ ਗਾ ਰਿਹਾ ਹੈ
      - ਇੱਕ ਬਿੱਲੀ ਦੁੱਧ ਪੀ ਰਹੀ ਹੈ
      - ਦੋ ਆਦਮੀ ਲੜ ਰਹੇ ਹਨ
    example_title: Example 2
  - source_sentence: ਮੇਰੇ ਘਰ ਵਿੱਚ ਤੁਹਾਡਾ ਸੁਆਗਤ ਹੈ
    sentences:
      - ਮੈਂ ਤੁਹਾਡੇ ਘਰ ਵਿੱਚ ਤੁਹਾਡਾ ਸੁਆਗਤ ਕਰਾਂਗਾ
      - ਮੇਰਾ ਘਰ ਕਾਫੀ ਵੱਡਾ ਹੈ
      - ਅੱਜ ਮੇਰੇ ਘਰ ਵਿੱਚ ਰਹੋ
    example_title: Example 3

PunjabiSBERT

This is a PunjabiBERT model (l3cube-pune/punjabi-bert) trained on the NLI dataset.
Released as a part of project MahaNLP: https://github.com/l3cube-pune/MarathiNLP

A better sentence similarity model (fine-tuned version of this model) is shared here: https://huggingface.co/l3cube-pune/punjabi-sentence-similarity-sbert

More details on the dataset, models, and baseline results can be found in our [paper] (https://arxiv.org/abs/2211.11187)

@article{joshi2022l3cubemahasbert,
  title={L3Cube-MahaSBERT and HindSBERT: Sentence BERT Models and Benchmarking BERT Sentence Representations for Hindi and Marathi},
  author={Joshi, Ananya and Kajale, Aditi and Gadre, Janhavi and Deode, Samruddhi and Joshi, Raviraj},
  journal={arXiv preprint arXiv:2211.11187},
  year={2022}
}

Usage (Sentence-Transformers)

Using this model becomes easy when you have sentence-transformers installed:

pip install -U sentence-transformers

Then you can use the model like this:

from sentence_transformers import SentenceTransformer
sentences = ["This is an example sentence", "Each sentence is converted"]

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

Usage (HuggingFace Transformers)

Without sentence-transformers, you can use the model like this: First, you pass your input through the transformer model, then you have to apply the right pooling-operation on-top of the contextualized word embeddings.

from transformers import AutoTokenizer, AutoModel
import torch


#Mean Pooling - Take attention mask into account for correct averaging
def mean_pooling(model_output, attention_mask):
    token_embeddings = model_output[0] #First element of model_output contains all token embeddings
    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)


# Sentences we want sentence embeddings for
sentences = ['This is an example sentence', 'Each sentence is converted']

# Load model from HuggingFace Hub
tokenizer = AutoTokenizer.from_pretrained('{MODEL_NAME}')
model = AutoModel.from_pretrained('{MODEL_NAME}')

# Tokenize sentences
encoded_input = tokenizer(sentences, padding=True, truncation=True, return_tensors='pt')

# Compute token embeddings
with torch.no_grad():
    model_output = model(**encoded_input)

# Perform pooling. In this case, mean pooling.
sentence_embeddings = mean_pooling(model_output, encoded_input['attention_mask'])

print("Sentence embeddings:")
print(sentence_embeddings)