Hugging Face's logo

Spaces:
jerpint
/
RAGTheDocs-mila-qc
Running

App Files Community
2
RAGTheDocs-mila-qc / README.md
jerpint's picture
jerpint
update README, add better docs
f8c09da
preview code
|
raw history blame contribute delete
No virus
1.48 kB

A newer version of the Gradio SDK is available: 4.36.1

Upgrade
metadata
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
  2. Duplicate the space:

image

  1. 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 🤖 our RAG agent.

  • Customization Options: Tailor RAGtheDocs to your needs with customizable settings and options.