FlagEmbedding

环境要求

• 已安装 Python 与 pip 环境
• 已安装 git 用于克隆仓库
• 如需微调模型，需额外安装 finetune 附加依赖
• 首次加载模型需要能访问 HuggingFace 下载权重

安装与启动步骤

1. 1克隆代码仓库

   从 GitHub 拉取 FlagEmbedding 源码，后续的安装与示例都在这个目录里进行。

   git clone https://github.com/FlagOpen/FlagEmbedding.git

   复制

2. 2进入项目目录

   切换到刚克隆下来的 FlagEmbedding 目录，pip 安装命令需要在该目录下执行。

   cd FlagEmbedding

   复制

3. 3安装基础依赖

   只做推理、不微调模型时，直接安装基础包即可，无需 finetune 相关依赖。

   pip install .

   复制

4. 4安装微调依赖

   需要微调模型时，改用带 finetune 附加依赖的安装方式；README 中该命令默认被注释。

   pip install .[finetune]

   复制

5. 5可编辑模式安装

   开发调试时可用 -e 可编辑安装，改源码立即生效；若要微调则加 .[finetune]。

   pip install -e .

   复制

6. 6加载嵌入模型

   用 FlagAutoModel 加载 BGE 模型，首次运行会下载权重，GPU 上可开启 use_fp16 加速。

   from FlagEmbedding import FlagAutoModel
   
   model = FlagAutoModel.from_finetuned('BAAI/bge-base-en-v1.5',
                                         query_instruction_for_retrieval="Represent this sentence for searching relevant passages:",
                                         use_fp16=True)

   复制

7. 7编码并算相似度

   对两组句子做 encode 得到向量，再用矩阵内积计算相似度，确认模型工作正常。

   sentences_1 = ["I love NLP", "I love machine learning"]
   sentences_2 = ["I love BGE", "I love text retrieval"]
   embeddings_1 = model.encode(sentences_1)
   embeddings_2 = model.encode(sentences_2)
   similarity = embeddings_1 @ embeddings_2.T
   print(similarity)

   复制

关键配置

如何确认成功

示例代码运行后能正常打印出 embeddings_1 与 embeddings_2 的内积相似度矩阵，且过程中无报错。

常见问题

注意事项

• README 未指定 Python 版本，请使用带 pip 的 Python 3 环境。
• 首次加载 BAAI/bge-base-en-v1.5 会联网下载模型权重，需保证网络可达 HuggingFace。
• query_instruction_for_retrieval 使用英文指令前缀，注意与模型语言匹配。