安装

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

• 默认: 这允许加载、保存和模型的推理（即，获取嵌入）。

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

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

• 默认和训练: 类似 默认，加上训练。

• 开发: 以上所有加上一些用于开发 Sentence Transformers 的依赖项，请参阅 可编辑安装。

请注意，您可以混合和匹配各种附加功能，例如 pip install -U "sentence-transformers[train,onnx-gpu]"。

使用 pip 安装

默认

pip install -U sentence-transformers

ONNX

适用于 GPU 和 CPU

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

仅适用于 CPU

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

OpenVINO

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

ONNX

适用于 GPU 和 CPU

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

仅适用于 CPU

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

OpenVINO

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

ONNX

适用于 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"

OpenVINO

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 中的安装步骤进行操作。