Skip to content

Commit 4977789

Browse files
[DAGE-115] updated README.md
1 parent d70576a commit 4977789

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

rre-tools/README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,29 @@
22

33
## Overview
44
- Dataset Generator
5-
- Embedding Model Evaluator
6-
- Approximate Search Evaluator
5+
- Vector Search Doctor
6+
- Embedding Model Evaluator
7+
- Approximate Search Evaluator
78

89
### [Dataset Generator](docs/dataset_generator/README.md)
910

1011
This tool provides a flexible command-line tool to generate relevance datasets for search evaluation. It can retrieve
1112
documents from a search engine, generate synthetic queries, and score the relevance of document-query pairs using LLMs.
1213

13-
### [Embedding Model Evaluator](docs/embedding_model_evaluator/README.md)
14+
### Vector Search Doctor
1415

15-
This tool extends MTEB benchmarking tool to test a HuggingFace embedding model performance on both Retrieval and Reranking
16+
This tool helps diagnose and optimize vector search performance by evaluating both embedding models and search
17+
configurations. It consists of two sub-tools that work together to identify bottlenecks and improve retrieval quality in
18+
your vector search pipeline.
19+
20+
#### [Embedding Model Evaluator](docs/embedding_model_evaluator/README.md)
21+
22+
This sub-tool extends MTEB benchmarking tool to test a HuggingFace embedding model performance on both Retrieval and Reranking
1623
tasks based on custom datasets.
1724

18-
### [Approximate Search Evaluator](docs/approximate_search_evaluator/README.md)
25+
#### [Approximate Search Evaluator](docs/approximate_search_evaluator/README.md)
1926

20-
This tool provides a flexible tool to deply RRE and extract metrics to test your search engine collection given a
27+
This sub-tool provides a flexible tool to deply RRE and extract metrics to test your search engine collection given a
2128
[template](https://github.com/SeaseLtd/rated-ranking-evaluator/wiki/What%20We%20Need%20To%20Provide#query-templates).
2229

2330
## Quickstart: tools installation

0 commit comments

Comments
 (0)