Logo

开始入门

  • 安装
    • 使用 pip 安装
    • 使用 Conda 安装
    • 从源码安装
    • 可编辑安装
    • 安装支持 CUDA 的 PyTorch
  • 快速入门
    • Sentence Transformer
    • Cross Encoder
    • 下一步
  • 迁移指南
    • 从 v2.x 迁移到 v3.x
      • 从 SentenceTransformer.fit 迁移特定参数
      • 迁移在 SentenceTransformer.fit 中使用的自定义数据集和数据加载器
    • 从 v3.x 迁移到 v4.x
      • 迁移 CrossEncoder 初始化和方法上的参数
      • 从 CrossEncoder.fit 迁移特定参数
      • 迁移 CrossEncoder 评估器

Sentence Transformer

  • 用法
    • 计算嵌入
      • 初始化 Sentence Transformer 模型
      • 计算嵌入
      • Prompt 模板
      • 输入序列长度
      • 多进程 / 多 GPU 编码
    • 语义文本相似度
      • 相似度计算
    • 语义搜索
      • 背景
      • 对称 vs. 非对称语义搜索
      • 手动实现
      • 优化实现
      • 速度优化
      • Elasticsearch
      • 近似最近邻
      • 检索 & 重排序
      • 示例
    • 检索 & 重排序
      • 检索 & 重排序流水线
      • 检索:Bi-Encoder
      • 重排序器:Cross-Encoder
      • 示例脚本
      • 预训练 Bi-Encoders (检索)
      • 预训练 Cross-Encoders (重排序器)
    • 聚类
      • k-均值
      • 凝聚聚类
      • 快速聚类
      • 主题建模
    • 释义挖掘
      • paraphrase_mining()
    • 翻译句子挖掘
      • 基于 Margin 的挖掘
      • 示例
    • 图像搜索
      • 安装
      • 用法
      • 示例
    • 嵌入量化
      • 二值量化
      • 标量 (int8) 量化
      • 其他扩展
      • 演示
      • 亲自尝试
    • 创建自定义模型
      • Sentence Transformer 模型结构
      • 来自 Transformers 模型的 Sentence Transformer 模型
    • 加速推理
      • PyTorch
      • ONNX
      • OpenVINO
      • 基准测试
  • 预训练模型
    • 原始模型
    • 语义搜索模型
      • 多问答模型
      • MSMARCO Passage 模型
    • 多语言模型
      • 语义相似度模型
      • Bitext 挖掘
    • 图像 & 文本模型
    • INSTRUCTOR 模型
    • 科学相似度模型
  • 训练概述
    • 为什么要微调?
    • 训练组件
    • 数据集
      • 数据集格式
    • 损失函数
    • 训练参数
    • 评估器
    • 训练器
      • 回调
    • 多数据集训练
    • 已弃用的训练
    • 最佳基础嵌入模型
    • 与 CrossEncoder 训练的比较
  • 数据集概述
    • Hugging Face Hub 上的数据集
    • 预先存在的数据集
  • 损失概述
    • 损失表
    • 损失修改器
    • 蒸馏
    • 常用损失函数
    • 自定义损失函数
  • 训练示例
    • 语义文本相似度
      • 训练数据
      • 损失函数
    • 自然语言推理
      • 数据
      • SoftmaxLoss
      • MultipleNegativesRankingLoss
    • 释义数据
      • 预训练模型
    • Quora 重复问题
      • 训练
      • MultipleNegativesRankingLoss
      • 预训练模型
    • MS MARCO
      • Bi-Encoder
    • Matryoshka 嵌入
      • 用例
      • 结果
      • 训练
      • 推理
      • 代码示例
    • 自适应层
      • 用例
      • 结果
      • 训练
      • 推理
      • 代码示例
    • 多语言模型
      • 扩展您自己的模型
      • 训练
      • 数据集
      • 训练数据来源
      • 评估
      • 可用的预训练模型
      • 用法
      • 性能
      • 引用
    • 模型蒸馏
      • 知识蒸馏
      • 速度 - 性能权衡
      • 降维
      • 量化
    • 增强的 SBERT
      • 动机
      • 扩展到您自己的数据集
      • 方法论
      • 场景 1:有限或小型标注数据集(少量标注的句子对)
      • 场景 2:无标注数据集(仅未标注的句子对)
      • 训练
      • 引用
    • 使用 Prompts 训练
      • 什么是 Prompts?
      • 我们为什么要使用 Prompts 进行训练?
      • 我们如何使用 Prompts 进行训练?
    • 使用 PEFT 适配器进行训练
      • 兼容性方法
      • 添加新的适配器
      • 加载预训练的适配器
      • 训练脚本
    • 无监督学习
      • TSDAE
      • SimCSE
      • CT
      • CT (批内负采样)
      • Masked Language Model (MLM)
      • GenQ
      • GPL
      • 性能比较
    • 领域自适应
      • 领域自适应 vs. 无监督学习
      • 自适应预训练
      • GPL:生成式伪标签
    • 超参数优化
      • HPO 组件
      • 整合所有内容
      • 示例脚本
    • 分布式训练
      • 比较
      • FSDP

Cross Encoder

  • 用法
    • Cross-Encoder vs Bi-Encoder
      • Cross-Encoder vs. Bi-Encoder
      • 何时使用 Cross- / Bi-Encoders?
      • Cross-Encoders 用法
      • 结合 Bi- 和 Cross-Encoders
      • 训练 Cross-Encoders
    • 检索 & 重排序
      • 检索 & 重排序流水线
      • 检索:Bi-Encoder
      • 重排序器:Cross-Encoder
      • 示例脚本
      • 预训练 Bi-Encoders (检索)
      • 预训练 Cross-Encoders (重排序器)
    • 加速推理
      • PyTorch
      • ONNX
      • OpenVINO
      • 基准测试
  • 预训练模型
    • MS MARCO
    • SQuAD (QNLI)
    • STSbenchmark
    • Quora 重复问题
    • NLI
    • 社区模型
  • 训练概述
    • 为什么要微调?
    • 训练组件
    • 数据集
      • 数据集格式
      • Hard Negatives Mining
    • 损失函数
    • 训练参数
    • 评估器
    • 训练器
      • 回调
    • 多数据集训练
    • 训练技巧
    • 已弃用的训练
    • 与 SentenceTransformer 训练的比较
  • 损失概述
    • 损失表
    • 蒸馏
    • 常用损失函数
    • 自定义损失函数
  • 训练示例
    • 语义文本相似度
      • 训练数据
      • 损失函数
      • 推理
    • 自然语言推理
      • 数据
      • CrossEntropyLoss
      • 推理
    • Quora 重复问题
      • 训练
      • 推理
    • MS MARCO
      • Cross Encoder
      • 训练脚本
      • 推理
    • Rerankers
      • BinaryCrossEntropyLoss
      • CachedMultipleNegativesRankingLoss
      • 推理
    • 模型蒸馏
      • Cross Encoder 知识蒸馏
      • 推理
    • 分布式训练
      • 比较
      • FSDP

包参考

  • Sentence Transformer
    • SentenceTransformer
      • SentenceTransformer
      • SentenceTransformerModelCardData
      • SimilarityFunction
    • 训练器
      • SentenceTransformerTrainer
    • 训练参数
      • SentenceTransformerTrainingArguments
    • 损失
      • BatchAllTripletLoss
      • BatchHardSoftMarginTripletLoss
      • BatchHardTripletLoss
      • BatchSemiHardTripletLoss
      • ContrastiveLoss
      • OnlineContrastiveLoss
      • ContrastiveTensionLoss
      • ContrastiveTensionLossInBatchNegatives
      • CoSENTLoss
      • AnglELoss
      • CosineSimilarityLoss
      • DenoisingAutoEncoderLoss
      • GISTEmbedLoss
      • CachedGISTEmbedLoss
      • MSELoss
      • MarginMSELoss
      • MatryoshkaLoss
      • Matryoshka2dLoss
      • AdaptiveLayerLoss
      • MegaBatchMarginLoss
      • MultipleNegativesRankingLoss
      • CachedMultipleNegativesRankingLoss
      • MultipleNegativesSymmetricRankingLoss
      • CachedMultipleNegativesSymmetricRankingLoss
      • SoftmaxLoss
      • TripletLoss
    • 采样器
      • BatchSamplers
      • MultiDatasetBatchSamplers
    • 评估
      • BinaryClassificationEvaluator
      • EmbeddingSimilarityEvaluator
      • InformationRetrievalEvaluator
      • NanoBEIREvaluator
      • MSEEvaluator
      • ParaphraseMiningEvaluator
      • RerankingEvaluator
      • SentenceEvaluator
      • SequentialEvaluator
      • TranslationEvaluator
      • TripletEvaluator
    • 数据集
      • ParallelSentencesDataset
      • SentenceLabelDataset
      • DenoisingAutoEncoderDataset
      • NoDuplicatesDataLoader
    • 模型
      • 主要类
      • 更多类
    • 量化
      • quantize_embeddings()
      • semantic_search_faiss()
      • semantic_search_usearch()
  • Cross Encoder
    • CrossEncoder
      • CrossEncoder
      • CrossEncoderModelCardData
    • 训练器
      • CrossEncoderTrainer
    • 训练参数
      • CrossEncoderTrainingArguments
    • 损失
      • BinaryCrossEntropyLoss
      • CrossEntropyLoss
      • LambdaLoss
      • ListMLELoss
      • PListMLELoss
      • ListNetLoss
      • MultipleNegativesRankingLoss
      • CachedMultipleNegativesRankingLoss
      • MSELoss
      • MarginMSELoss
      • RankNetLoss
    • 评估
      • CrossEncoderRerankingEvaluator
      • CrossEncoderNanoBEIREvaluator
      • CrossEncoderClassificationEvaluator
      • CrossEncoderCorrelationEvaluator
  • util
    • 辅助函数
      • community_detection()
      • http_get()
      • is_training_available()
      • mine_hard_negatives()
      • normalize_embeddings()
      • paraphrase_mining()
      • semantic_search()
      • truncate_embeddings()
    • 模型优化
      • export_dynamic_quantized_onnx_model()
      • export_optimized_onnx_model()
      • export_static_quantized_openvino_model()
    • 相似度指标
      • cos_sim()
      • dot_score()
      • euclidean_sim()
      • manhattan_sim()
      • pairwise_cos_sim()
      • pairwise_dot_score()
      • pairwise_euclidean_sim()
      • pairwise_manhattan_sim()
Sentence Transformers
  • 训练示例
  • 在 GitHub 上编辑

训练示例

监督学习

  • 语义文本相似度
  • 自然语言推理
  • 释义数据
  • Quora 重复问题
  • MS MARCO
  • Matryoshka 嵌入
  • 自适应层
  • 多语言模型
  • 模型蒸馏
  • 增强的 SBERT
  • 使用 Prompts 训练
  • 使用 PEFT 适配器进行训练

无监督学习

  • 无监督学习
  • 领域自适应

高级用法

  • 超参数优化
  • 分布式训练
上一个 下一个

© 版权所有 2025 年。

使用 Sphinx 构建,主题由 theme 提供,托管于 Read the Docs。