Skip to content

Commit f85019f

Browse files
committed
add roadmap
1 parent 4ca5875 commit f85019f

4 files changed

Lines changed: 45 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
<a href=#news>News</a> |
2323
<a href=#installation>Installation</a> |
2424
<a href=#quick-start>Quick Start</a> |
25+
<a href=#community>Community</a> |
2526
<a href="#projects">Projects</a> |
2627
<a href=#model-list>Model List</a> |
2728
<a href="#contributor">Contributor</a> |
@@ -117,6 +118,24 @@ similarity = embeddings_1 @ embeddings_2.T
117118
print(similarity)
118119
```
119120

121+
122+
## Community
123+
124+
We are actively maintaining the community of BGE and FlagEmbedding. Let us know if you have any suggessions or ideas!
125+
126+
Currently we are updating the [tutorials](./Tutorials/), we aim to create a comprehensive and detailed tutorial for beginners on text retrieval and RAG. Stay tuned!
127+
128+
The following contents are releasing in the upcoming weeks:
129+
130+
- BGE Intro
131+
- Evaluation on MTEB tasks
132+
133+
<details>
134+
<summary>The whole tutorial roadmap</summary>
135+
<img src="./Tutorials/tutorial_map.png"/>
136+
</details>
137+
138+
120139
## Projects
121140

122141
### BGE-M3 ([Paper](https://arxiv.org/pdf/2402.03216.pdf), [Code](https://github.com/FlagOpen/FlagEmbedding/tree/master/FlagEmbedding/BGE_M3))

README_zh.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
<a href=#更新>更新</a> |
2323
<a href=#安装>安装</a> |
2424
<a href=#快速开始>快速开始</a> |
25+
<a href=#社区>社区</a> |
2526
<a href="#项目">项目</a> |
2627
<a href="#模型列表">模型列表</a> |
2728
<a href=#贡献者>贡献者</a> |
@@ -113,6 +114,22 @@ similarity = embeddings_1 @ embeddings_2.T
113114
print(similarity)
114115
```
115116

117+
## 社区
118+
119+
我们将持续维护BGE及FlagEmbedding社区,有任何想法建议都欢迎告诉我们!
120+
121+
近期会持续更新[教学](./Tutorials/)中的内容,希望为文本检索以及RAG打造出完整且详细的教学,欢迎持续关注!
122+
123+
在未来两周左右将会更新以下内容:
124+
125+
- BGE模型介绍
126+
- 在MTEB的任务中的评测
127+
128+
<details>
129+
<summary>教程规划</summary>
130+
<img src="./Tutorials/tutorial_map.png"/>
131+
</details>
132+
116133

117134
## 项目
118135

Tutorials/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1-
# Tutorials
1+
# FlagEmbedding_tutorial
22

33
If you are new to here, check out the 5 minute [quick start](./quick_start.ipynb)!
44

5+
<details>
6+
<summary>Tutorial roadmap</summary>
7+
<img src="./tutorial_map.png"/>
8+
</details>
9+
510
## [Embedding](./1_Embedding)
611

712
This module includes tutorials and demos showing how to use BGE and Sentence Transformers, as well as other embedding related topics.
@@ -18,4 +23,6 @@ Although not included in the quick start, indexing is a very important part in p
1823

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

21-
## Reranking
26+
## [Reranking](./5_Reranking/)
27+
28+
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.

Tutorials/tutorial_map.png

236 KB
Loading

0 commit comments

Comments
 (0)