RAGTheDocs
Motivation
I built RAGTheDocs, an open-source library that allows you to one-click deploy retrieval augmented generation (RAG) on any readthedocs website on huggingface π€ spaces!
It leverages Buster π€, our open-source Retrieval Augmented Generation (RAG) library and gradio/huggingface for the UI.
Usage π
To use it, follow these 3 simple steps:
1) Go to the example space
2) Duplicate the space:
3) Set your environment variables:
OPENAI_API_KEY
(required): Needed for the app to work, e.g.sk-...
READTHEDOCS_URL
(required): The url of the website you are interested in scraping (must be built with sphinx/readthedocs). e.g.https://orion.readthedocs.io
READTHEDOCS_VERSION
(optional): This is important if there exist multiple versions of the docs (e.g.en/v0.2.7
oren/latest
). If left empty, it will scrape all available versions (there can be many for open-source projects!).
Comments