安装

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

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

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

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

  • 默认和训练 (Default and Training): 与默认选项功能相同,外加训练功能。

  • 开发 (Development): 包含上述所有功能,以及一些用于开发 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 - Get Started 中的步骤进行安装。