安装

我们推荐使用 Python 3.8+、PyTorch 1.11.0+ 和 transformers v4.34.0+。安装 Sentence Transformers 有三种选项：

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

  • 默认和培训：以上所有内容加上培训。

  • 开发：以上所有内容加上一些用于开发 Sentence Transformers 的依赖项，参见可编辑安装。

使用 pip 安装

pip install -U sentence-transformers

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

要使用 Weights and Biases <https://wandb.ai/>_ 来跟踪你的训练日志，你应该也安装 wandb (推荐)::

pip install wandb

并且要在训练过程中跟踪你的碳排放，并将这些信息自动包含在你的模型卡片中，还可以安装 codecarbon （推荐）::

pip install codecarbon

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

使用 Conda 安装

conda install -c conda-forge sentence-transformers

conda install -c conda-forge sentence-transformers accelerate datasets

要使用 Weights and Biases <https://wandb.ai/>_ 来跟踪你的训练日志，你应该也安装 wandb (推荐)::

pip install wandb

并且要在训练过程中跟踪你的碳排放，并将这些信息自动包含在你的模型卡片中，还可以安装 codecarbon （推荐）::

pip install codecarbon

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

从源码安装

你可以直接从源码安装 sentence-transformers，以利用最新的主分支而不是最新的稳定版本：

pip install 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 <https://wandb.ai/>_ 来跟踪你的训练日志，你应该也安装 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 - 入门指南进行安装步骤。