安装

我们推荐使用 **Python 3.9+**、**PyTorch 1.11.0+** 和 **transformers v4.41.0+**。安装 Sentence Transformers 有 5 个额外选项

  • **默认:** 允许加载、保存模型以及进行推理(即获取嵌入)。

  • **ONNX:** 允许使用 ONNX 后端加载、保存、推理、优化和量化模型。

  • **OpenVINO:** 允许使用 OpenVINO 后端加载、保存和推理模型。

  • **默认和训练:** 类似于**默认**,额外支持训练。

  • **开发:** 包括上述所有功能以及开发 Sentence Transformers 所需的一些依赖项,详见可编辑安装

请注意,您可以混合搭配各种额外选项,例如 pip install -U "sentence-transformers[train,onnx-gpu]"

使用 pip 安装

pip install -U sentence-transformers

适用于 GPU 和 CPU

pip install -U "sentence-transformers[onnx-gpu]"

仅适用于 CPU

pip install -U "sentence-transformers[onnx]"
pip install -U "sentence-transformers[openvino]"
pip install -U "sentence-transformers[train]"

要使用 Weights and Biases 跟踪您的训练日志,您还应该安装 wandb (推荐)

pip install wandb

为了在训练时跟踪您的碳排放并将此信息自动包含在您的模型卡中,您还应该安装 codecarbon (推荐)

pip install codecarbon
pip install -U "sentence-transformers[dev]"

使用 Conda 安装

conda install -c conda-forge sentence-transformers

适用于 GPU 和 CPU

pip install -U "sentence-transformers[onnx-gpu]"

仅适用于 CPU

pip install -U "sentence-transformers[onnx]"
pip install -U "sentence-transformers[openvino]"
conda install -c conda-forge sentence-transformers accelerate datasets

要使用 Weights and Biases 跟踪您的训练日志,您还应该安装 wandb (推荐)

pip install wandb

为了在训练时跟踪您的碳排放并将此信息自动包含在您的模型卡中,您还应该安装 codecarbon (推荐)

pip install codecarbon
conda install -c conda-forge sentence-transformers accelerate datasets pre-commit pytest ruff

从源代码安装

您可以直接从源代码安装 sentence-transformers,以利用最新的 master 分支,而不是最新的稳定版本

pip install git+https://github.com/UKPLab/sentence-transformers.git

适用于 GPU 和 CPU

pip install -U "sentence-transformers[onnx-gpu] @ git+https://github.com/UKPLab/sentence-transformers.git"

仅适用于 CPU

pip install -U "sentence-transformers[onnx] @ git+https://github.com/UKPLab/sentence-transformers.git"
pip install -U "sentence-transformers[openvino] @ git+https://github.com/UKPLab/sentence-transformers.git"
pip install -U "sentence-transformers[train] @ git+https://github.com/UKPLab/sentence-transformers.git"

要使用 Weights and Biases 跟踪您的训练日志,您还应该安装 wandb (推荐)

pip install wandb

为了在训练时跟踪您的碳排放并将此信息自动包含在您的模型卡中,您还应该安装 codecarbon (推荐)

pip install codecarbon
pip install -U "sentence-transformers[dev] @ git+https://github.com/UKPLab/sentence-transformers.git"

可编辑安装

如果您想修改 sentence-transformers,您需要进行可编辑安装。克隆存储库并使用以下命令进行安装

git clone https://github.com/UKPLab/sentence-transformers
cd sentence-transformers
pip install -e ".[train,dev]"

这些命令会将新的 sentence-transformers 文件夹链接到您的 Python 库路径,以便在导入 sentence-transformers 时使用此文件夹。

安装支持 CUDA 的 PyTorch

要使用 GPU/CUDA,您必须安装支持 CUDA 的 PyTorch。请按照 PyTorch - 入门 获取安装步骤。