Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #64

Merged
merged 1 commit into from
Jan 11, 2024
Merged

Update README.md #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# RAG Data Pipeline Tuning
# Retrieval Augmented Generation (RAG) Tuning

<p align="center">
<a href="https://github.com/ml6team/fondant">
Expand All @@ -10,9 +10,8 @@

## Introduction

This repository contains RAG-related pipelines built with
[Fondant](https://github.com/ml6team/fondant), a hub and framework for easy and shareable data
processing.
This repository contains data pipelines and ready-to-use notebooks for tuning RAG systems both manually and automatically using parameter search.
To achieve this, it leverages [Fondant](https://github.com/ml6team/fondant), a free and open source framework for production-ready, easy and shareable data processing.

## Available notebooks

Expand All @@ -30,7 +29,16 @@ informed choices on which parameters to try.

### Auto-tuning of a RAG indexing pipeline

> 🚧 Coming soon
<p>
A <a href="./src/parameter_search.ipynb"><b>notebook</b></a> which allows you to automatically search for the
optimal parameter settings using different methods
</p>
<br>
<p align="center">
<a href="./src/parameter_search.ipynb">
<img src="./art/iteration.png" width="800px"/>
</a>
</p>

## Getting started

Expand Down