Skip to content

Commit 661d48c

Browse files
committed
update tutorial readme
1 parent c0c040f commit 661d48c

1 file changed

Lines changed: 29 additions & 2 deletions

File tree

Tutorials/README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# FlagEmbedding_tutorial
1+
# Tutorial
22

3-
If you are new to here, check out the 5 minute [quick start](./quick_start.ipynb)!
3+
FlagEmbedding holds a whole curriculum for retrieval, embedding models, RAG, etc. This section is currently being actively updated. No matter you are new to NLP or a veteran, we hope you can find something helpful!
4+
5+
If you are new to embedding and retrieval, check out the 5 minute [quick start](./quick_start.ipynb)!
46

57
<details>
68
<summary>Tutorial roadmap</summary>
@@ -11,18 +13,43 @@ If you are new to here, check out the 5 minute [quick start](./quick_start.ipynb
1113

1214
This module includes tutorials and demos showing how to use BGE and Sentence Transformers, as well as other embedding related topics.
1315

16+
- [x] Intro to embedding model
17+
- [x] BGE series
18+
- [x] Usage of BGE
19+
- [x] BGE-M3
20+
- [ ] BGE-ICL
21+
- ...
22+
1423
## [Similarity](./2_Similarity)
1524

1625
In this part, we show popular similarity functions and techniques about searching.
1726

27+
- [x] Similarity metrics
28+
- ...
29+
1830
## [Indexing](./3_Indexing)
1931

2032
Although not included in the quick start, indexing is a very important part in practical cases. This module shows how to use popular libraries like Faiss and Milvus to do indexing.
2133

34+
- [x] Intro to Faiss
35+
- [x] Using GPU in Faiss
36+
- [ ] Index and Quantizer
37+
- [ ] Milvus
38+
- ...
39+
2240
## [Evaluation](./4_Evaluation)
2341

2442
In this module, we'll show the full pipeline of evaluating an embedding model, as well as popular benchmarks like MTEB and C-MTEB.
2543

44+
- [x] Evaluate MSMARCO
45+
- [x] Intro to MTEB
46+
- [x] MTEB Leaderboard Eval
47+
- [ ] C-MTEB
48+
- ...
49+
2650
## [Reranking](./5_Reranking/)
2751

2852
To balance accuracy and efficiency tradeoff, many retrieval system use a more efficient retriever to quickly narrow down the candidates. Then use more accurate models do reranking for the final results.
53+
54+
- [x] Intro to reranker
55+
- ...

0 commit comments

Comments
 (0)