Add 'sentence-transformers' tag for easier discoverability

#2
by tomaarsen HF staff - opened

Hello!

Pull Request overview

  • Add the sentence-transformers tag.

Details

The upcoming Sentence Transformers v3 update will introduce training directly with Dataset instances, e.g. like so:

from datasets import load_dataset
from sentence_transformers import SentenceTransformer, SentenceTransformerTrainer
from sentence_transformers.losses import MultipleNegativesRankingLoss

# 1. Load a model to finetune
model = SentenceTransformer("microsoft/mpnet-base")

# 2. Load a dataset to finetune on
dataset = load_dataset("WhereIsAI/github-issue-similarity", "positive")
train_dataset = dataset["train"]
eval_dataset = dataset["dev"]

# 3. Define a loss function
loss = MultipleNegativesRankingLoss(model)

# 4. Create a trainer & train
trainer = SentenceTransformerTrainer(
    model=model,
    train_dataset=train_dataset,
    eval_dataset=eval_dataset,
    loss=loss,
)
trainer.train()

# 5. Save the trained model
model.save("models/mpnet-base-GIS")

In preparation for the release, I'm going through and tagging some excellent datasets that immediately match one of the dataset formats required for one of the loss functions as sentence-transformers. Then I can link to datasets with this tag in the Sentence Transformers documentation.

This dataset in particular matches the (anchor, positive) pairs without any label, allowing this dataset to be used out of the box for CachedMultipleNegativesRankingLoss, MultipleNegativesRankingLoss, MultipleNegativesSymmetricRankingLoss, MegaBatchMarginLoss, CachedGISTEmbedLoss, and GISTEmbedLoss, as well as (sentence_A, sentence_B) pairs with class, (sentence_A, sentence_B) pairs with 1 if positive, 0 if negative and I think even (sentence_A, sentence_B) pairs with float similarity score.

  • Tom Aarsen
SeanLee97 changed pull request status to merged

Sign up or log in to comment