Generated banner for Train Sentence Transformers
Generated logo for Train Sentence Transformers

Train Sentence Transformers

Hugging FaceOfficialPublished by Hugging Face

  • Skill
  • Workflow
  • Data and AI
  • Apache-2.0
  • Medium risk
  • Has scripts

From the author

Train or fine-tune sentence-transformers models across `SentenceTransformer` (bi-encoder, dense or static embedding model for retrieval, similarity, clustering, classification, paraphrase mining, dedup, multimodal), `CrossEncoder` (reranker, pair scoring for two-stage retrieval / pair classification), `SparseEncoder` (SPLADE, sparse embedding model for learned-sparse retrieval), and `MultiVectorEncoder` (ColBERT / late-interaction, per-token embeddings scored with MaxSim). Covers loss selection, hard-negative mining, evaluators, distillation, LoRA, Matryoshka, and Hugging Face Hub publishing. Use for any sentence-transformers training task.
— the description by Hugging Face

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a standardized approach to training various embedding and ranking models using the sentence-transformers framework. It acts as a routing system that directs users to specific production templates and technical references based on the chosen model architecture. The workflow covers the entire lifecycle from model selection and data preparation to loss function configuration, evaluation, and publishing to the Hugging Face Hub.

What it does

  • Routes users to appropriate training templates for bi-encoders, cross-encoders, sparse encoders, and multi-vector encoders.
  • Provides technical references for loss functions, evaluators, and model architectures.
  • Offers guidance on hard-negative mining and dataset formatting for training.
  • Includes instructions for hardware-specific configurations and Hugging Face Hub integration.
  • Defines mandatory script requirements such as smoke testing, logging, and verdict reporting.

When to use it

  • When you need to train or fine-tune a sentence-transformers model for retrieval, similarity, or ranking tasks.
  • When you are unsure which model architecture (e.g., bi-encoder vs. cross-encoder) is best suited for your specific use case.
  • When you require a structured, repeatable process for training and evaluating embedding models.
  • When you need to integrate advanced training techniques like distillation, LoRA, or Matryoshka embeddings.

Advantages

  • Enforces consistent training practices through standardized production templates.
  • Reduces common errors by providing specific references for loss-to-data-shape mapping.
  • Facilitates systematic experimentation with built-in logging and verdict reporting.
  • Supports a wide range of model types including modern late-interaction and sparse architectures.

Usage examples

“I need to train a bi-encoder for semantic search on my internal documentation.”
The agent will identify the [SentenceTransformer] type, provide the relevant loss and evaluator references, and guide you to the bi-encoder production template.
“How do I implement a two-stage retrieval system using a reranker?”
The agent will direct you to the [CrossEncoder] documentation and template, explaining how to use it to score pairs for two-stage retrieval.
“I want to train a SPLADE model for sparse retrieval.”
The agent will provide the [SparseEncoder] references, including the required SpladeLoss wrapper and specific evaluators for sparse retrieval.
“How can I improve my retrieval model using hard negatives?”
The agent will guide you to the hard-negative mining script and explain how to generate n-tuple datasets for training.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/huggingface/train-sentence-transformers/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip train-sentence-transformers.zip -d .agents/skills

Documentation by Hugging Face

Train a sentence-transformers Model

This SKILL.md is a router, not a manual. It tells you which references and example scripts to load for your task. The actual content (recommended losses, evaluators, training-script structure, model selection, training-arg knobs, troubleshooting) lives in references/ and scripts/.

Do not synthesize a training script from this file alone. Open the per-type production template (scripts/train_<type>_example.py) and copy it as your starting point. The templates contain load-bearing scaffolding (autocast helper, model-card class, logger silencing list, force=True, seed, TF32, version-compatible imports, named-evaluator metric handling) that prior agent runs have repeatedly missed when rolling their own from a synthesized snippet.

1. Identify the model type

TagClassWhat it doesWhen to pick
[SentenceTransformer]SentenceTransformer (bi-encoder)Maps each input to a fixed-dim dense vectorRetrieval, similarity, clustering, classification, paraphrase mining, dedup
[CrossEncoder]CrossEncoder (reranker)Scores (query, passage) pairs jointlyTwo-stage retrieval (rerank top-100 from bi-encoder), pair classification
[SparseEncoder]SparseEncoder (SPLADE)Sparse vectors over the vocabularyLearned-sparse retrieval, inverted-index backends (Elasticsearch / OpenSearch / Lucene)
[MultiVectorEncoder]MultiVectorEncoder (ColBERT)One embedding per token, scored with MaxSimLate-interaction retrieval, recall gains over bi-encoders at higher storage cost, multimodal (ColPali / ColQwen2)

Tiebreakers when the request is ambiguous: "embedding model" / "vector search" / "similarity" → [SentenceTransformer]. "rerank" / "ranker" / "two-stage" → [CrossEncoder]. "SPLADE" / "sparse" / "inverted index" → [SparseEncoder]. "ColBERT" / "late interaction" / "multi-vector" / "MaxSim" / "ColPali" / "ColQwen" → [MultiVectorEncoder]. If still unclear, ask.

2. Required reading

Read these in full before writing any code. Do not triage by perceived relevance.

Per-type: always required

[SentenceTransformer]

  • references/losses_sentence_transformer.md: loss-to-data-shape mapping, BatchSamplers.NO_DUPLICATES requirement for MNRL-family, Cached* ↔ gradient_checkpointing incompatibility.

  • references/evaluators_sentence_transformer.md: evaluator-to-task mapping, metric_for_best_model key construction (named vs unnamed), per-evaluator primary_metric values.

  • references/model_architectures.md: encoder vs decoder vs static vs Router pipelines, pooling rules (mean / cls / lasttoken), auto-mean-pooling behavior for fresh-start MLM bases.

  • scripts/train_sentence_transformer_example.py: production template. Copy this as your starting point.

[CrossEncoder]

  • references/losses_cross_encoder.md: pointwise / pairwise / listwise / distillation, pos_weight derivation, activation_fn=Identity() mandatory for non-BCE losses (silent eval-rank collapse otherwise).

  • references/evaluators_cross_encoder.md: CrossEncoderRerankingEvaluator recipe, named-evaluator key format eval_{name}_{primary_metric}.

  • scripts/train_cross_encoder_example.py: production template. Copy this as your starting point.

[SparseEncoder]

  • references/losses_sparse_encoder.md: SpladeLoss wrapper requirement, FLOPS regularizer weights, smoke-test active-dim ramp behavior.

  • references/evaluators_sparse_encoder.md: SparseNanoBEIREvaluator (English-only) and the in-domain alternative, eval_{name}_{primary_metric} key format.

  • scripts/train_sparse_encoder_example.py: production template. Copy this as your starting point.

[MultiVectorEncoder]

  • references/losses_multi_vector_encoder.md: MaxSim scoring, scale choice per scoring mode (scale=1.0 for MaxSim, roughly the average query length for MeanMaxSim), MNRL / CachedMNRL / MarginMSE / DistillKLDiv, XTR-vs-ColBERT scoring, CachedMNRL ↔ gradient_checkpointing incompatibility.

  • references/evaluators_multi_vector_encoder.md: MultiVectorNanoBEIREvaluator (English-only) and the in-domain alternative, eval_NanoBEIR_mean_maxsim_ndcg@10 key format, distillation-eval spearman variant.

  • scripts/train_multi_vector_encoder_example.py: production template. Copy this as your starting point.

Cross-cutting: always required (regardless of task)
  • references/training_args.md: TrainingArguments knobs, precision rules (load fp32 + autocast bf16/fp16, never torch_dtype=bfloat16), warmup_steps (float) vs deprecated warmup_ratio, save_steps must be a multiple of eval_steps for load_best_model_at_end, schedulers, HPO, tracker, resume, hub-push variants.

  • references/dataset_formats.md: column-matching rules (label name auto-detection, column-order-not-name), reshaping recipes, hard-negative mining options.

  • references/base_model_selection.md: discovery commands, per-type model namespaces, ModernBERT-family max_seq_length=8192 trap, datasets >= 4 script-loader rejection, non-English starting-point shortcuts.

  • references/troubleshooting.md: symptom-indexed failure recipes. Skim the section headings on every run, even a healthy one. The "Metrics don't improve" and "Hub push fails" entries cover bugs that bite frequently and are cheaper to recognize before they fire than to debug after.

Cross-cutting: load when applicable
  • references/hardware_guide.md: VRAM sizing, multi-GPU, FSDP / DeepSpeed, HF Jobs flavors. Required for >24GB models, multi-GPU, or HF Jobs runs.

  • references/hf_jobs_execution.md: required when running on HF Jobs.

  • references/prompts_and_instructions.md: required when using prompt-tuned bases (E5, BGE, GTE, Qwen3-Embedding, Instructor, Nomic, etc.) or adding query: / passage: style prefixes.

Variant scripts (open when the task matches)
  • [SentenceTransformer] scripts/train_sentence_transformer_<matryoshka|multi_dataset|with_lora|distillation|make_multilingual|static_embedding>_example.py.

  • [CrossEncoder] scripts/train_cross_encoder_<distillation|listwise>_example.py.

  • [SparseEncoder] scripts/train_sparse_encoder_distillation_example.py.

  • Hard-negative mining CLI: scripts/mine_hard_negatives.py.

3. Defaults

Override only if the user specifies otherwise:

  • Local execution. Pitch HF Jobs only if local hardware can't fit the job.

  • Single run. After it completes, propose experimentation if the user would benefit (weak/marginal verdict, "see how high you can push it" framing, etc.). Iteration rules in references/training_args.md (Experimentation section).

  • Public Hub push at end-of-run, wrapped in try-except. On HF Jobs (ephemeral env) ALSO enable in-trainer push (push_to_hub=True + hub_strategy="every_save"). Details in references/hf_jobs_execution.md.

4. Constraints the produced script must satisfy

These are non-negotiable contracts. Implementation lives in the production templates and references. Do not reinvent.

  • Capture the pre-training evaluator score as baseline_eval before trainer.train().

  • Emit a single end-of-run line: VERDICT: WIN|MARGINAL|REGRESSION | score=... | baseline=... | delta=.... A monitor scrapes for this.

  • Silence httpx, httpcore, huggingface_hub, urllib3, filelock, fsspec to WARNING (otherwise HF download URLs flood the agent's context).

  • Tee logs to logs/{RUN_NAME}.log.

  • End with model.push_to_hub(...) wrapped in try/except.

  • Smoke-test before any long run (max_steps=1 + tiny dataset slice). The production templates show one common pattern (SMOKE_TEST env var).

  • [CrossEncoder] Include EarlyStoppingCallback(patience>=3). CE rerankers often peak mid-training and regress.

  • [SparseEncoder] Log query_active_dims / corpus_active_dims on the verdict line. High nDCG with collapsed sparsity is not a win. The keys come back name-prefixed (e.g. ..._query_active_dims). Use suffix matching to pluck them. See the SPARSE production template for the exact pattern.

  • [MultiVectorEncoder] Match scale to the scoring mode on any MNRL-family loss: near 1.0 for unnormalized MaxSim (do not copy scale=20.0 from bi-encoder MNRL), roughly the average query length with length-normalized MeanMaxSim, since each score is divided by its query's token count. XTRScores is a train-only similarity_fct: the evaluators reject it, so evaluation always scores with MaxSim, including for XTR-trained models.

5. Workflow

  1. Identify the model type (§1). Ask if ambiguous.

  2. Load the §2 required-reading files for that type.

  3. Open scripts/train_<type>_example.py and copy it as your starting point.

  4. Replace MODEL_NAME, DATASET_NAME, RUN_NAME, the loss, and the evaluator with the user's task. Cross-check loss/data-shape match against references/losses_<type>.md. Cross-check the metric_for_best_model key against references/evaluators_<type>.md (named evaluators format the key as eval_{name}_{primary_metric}).

  5. Smoke-test (max_steps=1).

  6. Run.

  7. After the run, append to logs/experiments.md and propose iteration if the verdict is weak/marginal.

Prerequisites

pip install "sentence-transformers[train]>=5.0"        # add [train,image] / [audio] / [video] for [SentenceTransformer] multimodal
                                                       # [MultiVectorEncoder] requires >=6.0
pip install trackio                                    # optional tracker (or wandb / tensorboard / mlflow)
hf auth login                                          # or set HF_TOKEN with write scope (for Hub push)

GPU strongly recommended. CPU works only for demos and [SentenceTransformer] StaticEmbedding.

Files

references/losses_sentence_transformer.md

Bi-Encoder Losses (SentenceTransformer)

All losses live in sentence_transformers.sentence_transformer.losses.

Losses are grouped by data shape. The #1 rule: pick a loss that matches your data, not the other way around.

Top-line decision table

You haveUse
(anchor, positive) pairsMultipleNegativesRankingLoss (or Cached variant for large batches)
(anchor, positive, negative) tripletsMultipleNegativesRankingLoss (it handles triplets natively)
(text1, text2, score) with score ∈ [-1, 1] or [0, 1]CoSENTLoss (strongly recommended)
(text1, text2, label) with label ∈ {0, 1}OnlineContrastiveLoss
(text, class_id) single-column with integer classBatchAllTripletLoss
(query, positive, negative, score_diff)MarginMSELoss (distillation)
(text, teacher_embedding)MSELoss (embedding distillation)
Want multiple output dims from one trainingWrap any of the above in MatryoshkaLoss
No labels at all, just sentencesDenoisingAutoEncoderLoss or ContrastiveTensionLossInBatchNegatives

Contrastive losses (pairs + triplets, no labels)

MultipleNegativesRankingLoss (MNRL)

The default bi-encoder loss. Uses in-batch negatives: every other positive in the batch acts as a negative for the current anchor.

loss = MultipleNegativesRankingLoss(model, scale=20.0)  # similarity_fct defaults to cos_sim
  • Data: (anchor, positive) or (anchor, positive, negative). More columns = more explicit hard negatives per row.

  • Scale: temperature. Default scale=20.0 multiplies similarities by 20 (equivalent to softmax temperature 0.05). Tune only if cosine similarities end up saturated.

  • Critical: set batch_sampler=BatchSamplers.NO_DUPLICATES on training args. Otherwise duplicate anchors create false negatives.

  • Tip: batch size matters a lot. More in-batch negatives = better gradients.

CachedMultipleNegativesRankingLoss

Same loss, but with gradient caching (GradCache): forwards in mini-batches but computes the contrastive loss over the full batch. Use this when you want effective batch size of 256+ but your GPU can only fit 32 forwards.

loss = CachedMultipleNegativesRankingLoss(model, mini_batch_size=32)
  • Incompatible with gradient_checkpointing=True.

  • Set mini_batch_size to whatever per_device_train_batch_size would be if you couldn't use this. Then crank the actual per_device_train_batch_size to what you want the effective batch to be (256+, 1024+).

MultipleNegativesSymmetricRankingLoss

MNRL computed bidirectionally. Scores positives from both (anchor -> positive) and (positive -> anchor) directions. Slightly better on retrieval tasks where the "anchor" and "positive" distinctions are soft (paraphrase, deduplication).

CachedMultipleNegativesSymmetricRankingLoss

Cached variant of the above.

GISTEmbedLoss

Like MNRL, but uses a guide model (a separate pretrained Sentence Transformer) to filter out false negatives before computing the contrastive loss. The guide model scores each potential negative. If it looks too similar to the positive, it's excluded.

guide = SentenceTransformer("sentence-transformers/all-MiniLM-L6-v2")
loss = GISTEmbedLoss(model, guide=guide)
  • Expensive: guide model does a forward pass per batch.

  • Strong when your in-batch negatives are noisy (e.g. small corpus with many near-duplicates).

CachedGISTEmbedLoss

Cached + GIST.

MegaBatchMarginLoss

In-batch margin-based triplet: for each anchor, find the hardest negative in the batch and apply a margin loss. Older pattern, usually outperformed by MNRL.

TripletLoss

Classic triplet margin loss on explicit (anchor, positive, negative). Uses a fixed margin and the hardest in-batch is not considered, only the provided triplet.

loss = TripletLoss(model, distance_metric=TripletDistanceMetric.EUCLIDEAN, triplet_margin=5)
  • Simpler than MNRL, less powerful when the batch has useful negatives.

  • Good for cases where you have trusted pre-mined triplets and want to avoid in-batch noise.

Batch-triplet losses (single column + integer label)

These mine triplets within the batch from samples sharing a label.

BatchAllTripletLoss

For each anchor, form triplets with all positive/negative combinations in the batch. Max signal per batch.

loss = BatchAllTripletLoss(model, margin=5)
  • Data: single text column + integer label. Needs multiple samples per label in each batch (set batch_sampler=BatchSamplers.GROUP_BY_LABEL).

BatchHardTripletLoss

Same, but only the single hardest positive + hardest negative per anchor.

BatchSemiHardTripletLoss

Semi-hard mining: negatives harder than the positive but easier than the margin. Often more stable than fully-hard.

BatchHardSoftMarginTripletLoss

Variant with a soft margin (log-sum-exp) instead of a fixed margin hinge.

When to use batch-triplet losses: classification-style datasets (labels are class IDs, not pair annotations). E.g. "train an embedder where samples from the same class are close."

Scored regression losses (labeled pairs, float score)

CoSENTLoss

The recommended regression loss for (text1, text2, score). Trains on pairwise ranking: for any two pairs (a, b) and (c, d) with score(a,b) > score(c,d), the model should score (a, b) higher. Much better than squared error.

loss = CoSENTLoss(model, scale=20.0)
  • Data: (text1, text2, float_score). Labels can be [0, 1] or [-1, 1].

  • Works well with small datasets (STS-B, 5k pairs).

AnglELoss

Similar to CoSENT but uses angle-based optimization in complex space. Sometimes outperforms CoSENT on tasks with fine-grained similarity gradations. Strong alternative.

CosineSimilarityLoss

Squared-error loss on cosine similarity: mse(cos(text1, text2), label). Simpler than CoSENT, usually worse. Keep for legacy / reproducibility.

Contrastive labeled losses (labeled pairs, binary label)

ContrastiveLoss

For (text1, text2, label) where label ∈ {0, 1}. Minimizes distance for positives. Pushes negatives past a margin.

loss = ContrastiveLoss(model, margin=0.5, distance_metric=SiameseDistanceMetric.COSINE_DISTANCE)
OnlineContrastiveLoss

Same setup but ignores "easy" pairs (positives already close, negatives already far) and only optimizes hard ones. Much more robust to label noise.

loss = OnlineContrastiveLoss(model, margin=0.5)

Preferred over ContrastiveLoss for most practical labeled pair datasets.

SoftmaxLoss

A classifier head on concatenated (u, v, |u-v|) embeddings, trained with cross-entropy. Useful when you have NLI-style multi-class labels (entailment / neutral / contradiction) and want a categorical loss. Historically important (it trained the first popular sentence embedding models) but generally outperformed by MNRL.

Distillation losses

MSELoss

Regress the student's embedding to match a teacher's embedding.

  • Data: (text, teacher_embedding). The teacher embedding is a fixed vector per row.

  • Use when distilling a smaller bi-encoder from a larger one.

MarginMSELoss

For (query, positive, negative, score_diff): minimize mse(student_score_diff, teacher_score_diff). The teacher is typically a cross-encoder that produced the score differences.

  • Data: 3 text columns + 1 float column.

  • Workhorse of dense retriever training from cross-encoder teachers (ms-marco distillation).

DistillKLDivLoss

KL-divergence distillation: student's softmax distribution over candidates should match teacher's.

  • Data: (query, passages[], teacher_scores[]).

  • Good for list-wise distillation when you have multiple candidates per query.

See ../scripts/train_sentence_transformer_distillation_example.py for the end-to-end pattern (its docstring covers Embedding MSE / Margin MSE / Listwise KL with full recipes).

Regularizer / wrapper losses

These don't have their own data shape. They wrap another loss and add a regularization objective.

MatryoshkaLoss

Train once, deploy at any of several dimensions. Wraps any loss and computes it at multiple truncated dimensions, adding them weighted.

base_loss = MultipleNegativesRankingLoss(model)
loss = MatryoshkaLoss(
    model,
    base_loss,
    matryoshka_dims=[768, 512, 256, 128, 64],
    matryoshka_weights=[1, 1, 1, 1, 1],   # relative weighting per dim
)
  • At inference, SentenceTransformer(..., truncate_dim=128) gives 128-dim output with ~95% of full quality.

  • Default matryoshka_dims: pick the dims you want to deploy at. Smaller dims improve compression at the cost of slight quality drop.

Matryoshka2dLoss

2D-Matryoshka: reduce dimension and number of transformer layers in a single wrapper. Internally composes MatryoshkaLoss + AdaptiveLayerLoss, so you only need this one (don't wrap it in AdaptiveLayerLoss yourself). Deploy at any (dim, layer) pair at inference.

AdaptiveLayerLoss

Wrap any loss. Adds a term that trains each of the transformer's layers to be a valid exit point. Deploy with fewer layers at inference for faster encoding.

loss = AdaptiveLayerLoss(
    model,
    base_loss,
    n_layers_per_step=1,
    last_layer_weight=1.0,
    prior_layers_weight=1.0,
)
GlobalOrthogonalRegularizationLoss (GOR)

Stand-alone regularizer (not a wrapper, despite living in this section). Penalizes embedding pairs whose dot product deviates from orthogonality, encouraging the model to spread embeddings across the full vector space. Use it alongside a primary contrastive loss by summing the two outputs in your own training step. Can help with downstream retrieval diversity.

Unsupervised losses

DenoisingAutoEncoderLoss (TSDAE)

Sentence-level denoising autoencoder: corrupt a sentence (drop tokens), force the model to reconstruct it. Pretraining-style, useful for domain adaptation when you have unlabeled in-domain sentences.

ContrastiveTensionLoss

Unsupervised contrastive: two copies of the model encode the same sentence. They should agree. Pure self-supervised.

ContrastiveTensionLossInBatchNegatives

CT with in-batch negatives. Stronger than vanilla CT.

Gotchas

  • MultipleNegativesRankingLoss without BatchSamplers.NO_DUPLICATES will include duplicate anchors in the same batch, destroying training signal. Always set the sampler.

  • Any Cached* loss + gradient_checkpointing=True = crash. Pick one.

  • TripletLoss with bad negatives (too easy) = loss hits zero fast and model stops learning. Mine hard negatives first.

  • Matryoshka wrapping CachedMultipleNegativesRankingLoss: supported, but the cached-loss's mini-batch semantics apply to the base loss only. Think twice before combining.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs Python

Security

What our scanner noticed· Medium risk

  • Instructions that use the network
  • Downloads piped into a shell
  • Scripts that your agent may run

This skill includes scripts that your agent may run. Read them before you use it.

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by
Hugging Face
Publisher
Hugging Face (Official)
Source
huggingface/skills · skills/train-sentence-transformers · commit 25910b3
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Hugging Face or Hugging Face.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download train-sentence-transformers.zip