Spaces:
Sleeping
Sleeping
File size: 1,481 Bytes
2c02b68 48603c2 2c02b68 4a4bbfd 2c02b68 4a4bbfd 2c02b68 4a4bbfd 2c02b68 4a4bbfd 2c02b68 4a4bbfd f8c09da 2c02b68 4a4bbfd 2c02b68 4a4bbfd 2c02b68 4a4bbfd 2c02b68 f8c09da 2c02b68 4a4bbfd |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
---
title: RAGTheDocs
emoji: 👀
colorFrom: gray
colorTo: yellow
sdk: gradio
sdk_version: 3.50.2
app_file: app.py
pinned: false
license: mit
---
# RAGtheDocs
## Introduction 📚
RAGTheDocs is an open-source library that allows you to deploy retrieval augmented generation (RAG) on any readthedocs documentation with a one-click deploy on huggingface spaces!
## Usage
1) Go to the [example space](https://huggingface.co/spaces/jerpint/RAGTheDocs)
2) Duplicate the space:
3) Set your environment variables:
* `OPENAI_API_KEY`: Needed for the app to work, e.g. `sk-...`
* `READTHEDOCS_URL`: The url of the website you are interested in scraping
* `READTHEDOCS_VERSION`: This is important only if there exist multiple versions of the docs (e.g. "en/v0.2.7" or "en/latest"). If left empty, it will scrape all available versions.
**WARNING** This library is experimental and automatically calls OpenAI APIs for you. Use at your own risk! ⚠️
## Features 🚀
- **Web Scraping and embeddings:** RAGtheDocs automatically scrapes and embeds documentation from any website generated by ReadTheDocs/Sphinx using OpenAI embeddings
- **RAG Interface:** It comes built-in with a gradio UI for users to interact with [Buster 🤖](https://github.com/jerpint/buste) our RAG agent.
- **Customization Options:** Tailor RAGtheDocs to your needs with customizable settings and options.
|