Skip to content

Commit

Permalink
Add Gradio app screenshot to ReadME
Browse files Browse the repository at this point in the history
  • Loading branch information
HamedMP committed Sep 29, 2023
1 parent dea2bdf commit dc85cc8
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@

**Find the best hyperparameters for Embedding your data in RAG Pipeline**

![vectorboard banner image](docs/images/benchmark.png)
Get a detailed report on differences between each hyperparameter combination:

- Performance and embedding time
- Quality of response on the Eval queries

> More benchmark properties, such as cost estimation and Automated accuracy metric is upcoming.
# TL;DR

Expand Down Expand Up @@ -105,6 +110,16 @@ Finally, view the results in a Gradio app using `.results()` method. To get a pu
search.results(share=True)
```

## What's included in the results?

Several metrics are included in the results page in the Gradio app:

- Total runtime and embedding time per experiment (a combination of hyperparameters in the `param_grid`)
![vectorboard banner image](docs/images/benchmark.png)

- Response on each `eval_query` per `Experiment` in a table format. This way you can see which experiment is giving the correct answer and you can easily compare them with each other.
![gradio image](docs/images/gradio-screenshot-001.png)

# Overview and Core Concepts

RAG (Retrieval-Augmented Generation) revolutionizes the way we approach question-answering and text generation tasks by combining the capabilities of retrieval-based and generative models. While it excels in many areas, one of the critical factors for its success is the quality of embeddings.
Expand Down
Binary file added docs/images/gradio-screenshot-001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dc85cc8

Please sign in to comment.