Skip to content

Commit 790255b

Browse files
committed
update readme
1 parent b354fb4 commit 790255b

3 files changed

Lines changed: 7 additions & 18 deletions

File tree

examples/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ print(scores)
8181

8282
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.
8383

84+
If you do not have the `deepspeed` and `flash-attn` packages installed, you can install them with the following commands:
8485
```shell
8586
pip install deepspeed
8687
pip install flash-attn --no-build-isolation

examples/finetune/embedder/README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,21 @@ In this example, we show how to finetune the embedder with your data.
1717
- **with pip**
1818

1919
```shell
20-
pip install -U FlagEmbedding
21-
pip install deepspeed
22-
pip install flash-attn --no-build-isolation
20+
pip install -U FlagEmbedding[finetune]
2321
```
2422

2523
- **from source**
2624

2725
```shell
2826
git clone https://github.com/FlagOpen/FlagEmbedding.git
2927
cd FlagEmbedding
30-
pip install .
31-
pip install deepspeed
32-
pip install flash-attn --no-build-isolation
28+
pip install .[finetune]
3329
```
3430

3531
For development, install as editable:
3632

3733
```shell
38-
pip install -e .
39-
pip install deepspeed
40-
pip install flash-attn --no-build-isolation
34+
pip install -e .[finetune]
4135
```
4236

4337
## 2. Data format

examples/finetune/reranker/README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,21 @@ In this example, we show how to finetune the reranker with your data.
1616
- **with pip**
1717

1818
```shell
19-
pip install -U FlagEmbedding
20-
pip install deepspeed
21-
pip install flash-attn --no-build-isolation
19+
pip install -U FlagEmbedding[finetune]
2220
```
2321

2422
- **from source**
2523

2624
```shell
2725
git clone https://github.com/FlagOpen/FlagEmbedding.git
2826
cd FlagEmbedding
29-
pip install .
30-
pip install deepspeed
31-
pip install flash-attn --no-build-isolation
27+
pip install .[finetune]
3228
```
3329

3430
For development, install as editable:
3531

3632
```shell
37-
pip install -e .
38-
pip install deepspeed
39-
pip install flash-attn --no-build-isolation
33+
pip install -e .[finetune]
4034
```
4135

4236
## 2. Data format

0 commit comments

Comments
 (0)