GitHub - jerpint/RAGTheDocs: RAG for any docs hosted on readthedocs

RAGTheDocs is an open-source library that enables users to deploy retrieval augmented generation (RAG) on any readthedocs documentation on huggingface spaces with just one click. To use it, users need to duplicate the example space, set their environment variables including `OPENAI_API_KEY` and `READTHEDOCS_URL`, and optionally, `READTHEDOCS_VERSION` if there are multiple versions of the docs.

The library offers features such as web scraping and embeddings, a built-in gradio UI for interaction with the RAG agent, and customizable settings and options. However, it's important to note that this is a side-project and the code is experimental. The library will automatically call OpenAI APIs for embeddings and chatGPT, so users are advised to use it at their own risk.

Key takeaways:

RAGTheDocs is an open-source library that allows users to deploy retrieval augmented generation on any readthedocs documentation on huggingface spaces.
The library requires the setting of environment variables such as OPENAI_API_KEY and READTHEDOCS_URL for it to function properly.
RAGTheDocs comes with features such as web scraping and embeddings, a RAG interface, and customization options.
Users should be aware that the library will automatically call OpenAI APIs for embeddings and chatGPT, and should be used at one's own risk.

GitHub - jerpint/RAGTheDocs: RAG for any docs hosted on readthedocs

Key takeaways:

Comments (0)

Newsletter