Skip to content

Commit

Permalink
Update README.md (#64)
Browse files Browse the repository at this point in the history
  • Loading branch information
janvanlooyml6 authored Jan 11, 2024
1 parent 5c69f29 commit b96304e
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
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

0 comments on commit b96304e

Please sign in to comment.