Merge pull request #1176 from 545999961/master

Update pip

Author: 545999961

README.md

@@ -92,20 +92,31 @@ It is the first embedding model which supports all three retrieval methods, achi
 
 ## Installation
 ### Using pip:
+If you do not want to finetune the models, you can install the package without the finetune dependency:
 ```
 pip install -U FlagEmbedding
 ```
+If you want to finetune the models, you can install the package with the finetune dependency:
+```
+pip install -U FlagEmbedding[finetune]
+```
 ### Install from sources:
 
 Clone the repository and install
 ```
 git clone https://github.com/FlagOpen/FlagEmbedding.git
 cd FlagEmbedding
+# If you do not want to finetune the models, you can install the package without the finetune dependency:
 pip install  .
+# If you want to finetune the models, you can install the package with the finetune dependency:
+# pip install  .[finetune]
 ```
 For development in editable mode:
 ```
+# If you do not want to finetune the models, you can install the package without the finetune dependency:
 pip install -e .
+# If you want to finetune the models, you can install the package with the finetune dependency:
+# pip install -e .[finetune]
 ```
 
 ## Quick Start

README_zh.md

@@ -33,7 +33,8 @@
         <a href="#license">License</a> 
     <p>
 </h4>
-[English](README.md) | [中文](README_zh.md)
+
+[English](https://github.com/FlagOpen/FlagEmbedding/blob/master/README.md) | [中文](https://github.com/FlagOpen/FlagEmbedding/blob/master/README_zh.md)
 
 BGE (BAAI General Embedding) 专注于检索增强llm领域，目前包括以下项目:
 
@@ -85,20 +86,31 @@ BGE (BAAI General Embedding) 专注于检索增强llm领域，目前包括以下
 
 ## 安装
 ### 使用pip:
+如果你不想微调模型，你可以直接安装包，不用finetune依赖：
 ```
 pip install -U FlagEmbedding
 ```
+如果你想微调模型，你可以用finetune依赖安装：
+```
+pip install -U FlagEmbedding[finetune]
+```
 ### 从源文件安装部署:
 
 克隆并安装FlagEmbedding：
 ```
 git clone https://github.com/FlagOpen/FlagEmbedding.git
 cd FlagEmbedding
+# 如果你不想微调模型，你可以直接安装包，不用finetune依赖：
 pip install  .
+# 如果你想微调模型，你可以用finetune依赖安装：
+# pip install  .[finetune]
 ```
 在可编辑模式下安装:
 ```
+# 如果你不想微调模型，你可以直接安装包，不用finetune依赖：
 pip install -e .
+# 如果你想微调模型，你可以用finetune依赖安装：
+# pip install -e .[finetune]
 ```
 
 ## 快速开始

examples/README.md

@@ -81,6 +81,7 @@ print(scores)
 
 We support fine-tuning a variety of BGE series models, including `bge-large-en-v1.5`, `bge-m3`, `bge-en-icl`, `bge-multilingual-gemma2`, `bge-reranker-v2-m3`, `bge-reranker-v2-gemma`, and `bge-reranker-v2-minicpm-layerwise`, among others. As examples, we use the basic models `bge-large-en-v1.5` and `bge-reranker-large`. For more details, please refer to the [embedder](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/finetune/embedder) and [reranker](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/finetune/reranker) sections.
 
+If you do not have the `deepspeed` and `flash-attn` packages installed, you can install them with the following commands:
 ```shell
 pip install deepspeed
 pip install flash-attn --no-build-isolation

examples/finetune/embedder/README.md

@@ -17,27 +17,21 @@ In this example, we show how to finetune the embedder with your data.
 - **with pip**
 
 ```shell
-pip install -U FlagEmbedding
-pip install deepspeed
-pip install flash-attn --no-build-isolation
+pip install -U FlagEmbedding[finetune]
 ```
 
 - **from source**
 
 ```shell
 git clone https://github.com/FlagOpen/FlagEmbedding.git
 cd FlagEmbedding
-pip install  .
-pip install deepspeed
-pip install flash-attn --no-build-isolation
+pip install  .[finetune]
 ```
 
 For development, install as editable:
 
 ```shell
-pip install -e .
-pip install deepspeed
-pip install flash-attn --no-build-isolation
+pip install -e .[finetune]
 ```
 
 ## 2. Data format

examples/finetune/reranker/README.md

@@ -16,27 +16,21 @@ In this example, we show how to finetune the reranker with your data.
 - **with pip**
 
 ```shell
-pip install -U FlagEmbedding
-pip install deepspeed
-pip install flash-attn --no-build-isolation
+pip install -U FlagEmbedding[finetune]
 ```
 
 - **from source**
 
 ```shell
 git clone https://github.com/FlagOpen/FlagEmbedding.git
 cd FlagEmbedding
-pip install  .
-pip install deepspeed
-pip install flash-attn --no-build-isolation
+pip install  .[finetune]
 ```
 
 For development, install as editable:
 
 ```shell
-pip install -e .
-pip install deepspeed
-pip install flash-attn --no-build-isolation
+pip install -e .[finetune]
 ```
 
 ## 2. Data format