Skip to content

Commit 7c05577

Browse files
committed
update pip
1 parent fc78c70 commit 7c05577

2 files changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,20 +92,31 @@ It is the first embedding model which supports all three retrieval methods, achi
9292

9393
## Installation
9494
### Using pip:
95+
If you do not want to finetune the models, you can install the package without the finetune dependency:
9596
```
9697
pip install -U FlagEmbedding
9798
```
99+
If you want to finetune the models, you can install the package with the finetune dependency:
100+
```
101+
pip install -U FlagEmbedding[finetune]
102+
```
98103
### Install from sources:
99104

100105
Clone the repository and install
101106
```
102107
git clone https://github.com/FlagOpen/FlagEmbedding.git
103108
cd FlagEmbedding
109+
# If you do not want to finetune the models, you can install the package without the finetune dependency:
104110
pip install .
111+
# If you want to finetune the models, you can install the package with the finetune dependency:
112+
# pip install .[finetune]
105113
```
106114
For development in editable mode:
107115
```
116+
# If you do not want to finetune the models, you can install the package without the finetune dependency:
108117
pip install -e .
118+
# If you want to finetune the models, you can install the package with the finetune dependency:
119+
# pip install -e .[finetune]
109120
```
110121

111122
## Quick Start

README_zh.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,20 +85,31 @@ BGE (BAAI General Embedding) 专注于检索增强llm领域,目前包括以下
8585

8686
## 安装
8787
### 使用pip:
88+
如果你不想微调模型,你可以直接安装包,不用finetune依赖:
8889
```
8990
pip install -U FlagEmbedding
9091
```
92+
如果你想微调模型,你可以用finetune依赖安装:
93+
```
94+
pip install -U FlagEmbedding[finetune]
95+
```
9196
### 从源文件安装部署:
9297

9398
克隆并安装FlagEmbedding:
9499
```
95100
git clone https://github.com/FlagOpen/FlagEmbedding.git
96101
cd FlagEmbedding
102+
# 如果你不想微调模型,你可以直接安装包,不用finetune依赖:
97103
pip install .
104+
# 如果你想微调模型,你可以用finetune依赖安装:
105+
# pip install .[finetune]
98106
```
99107
在可编辑模式下安装:
100108
```
109+
# 如果你不想微调模型,你可以直接安装包,不用finetune依赖:
101110
pip install -e .
111+
# 如果你想微调模型,你可以用finetune依赖安装:
112+
# pip install -e .[finetune]
102113
```
103114

104115
## 快速开始

0 commit comments

Comments
 (0)