Skip to content

Commit c484e5a

Browse files
authored
Create README.md for 5min RAG
1 parent 2e4feb1 commit c484e5a

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

community/5_mins_rag_no_gpu/README.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# RAG in 5 Minutes
2+
3+
This implementation is tied to the [YouTube video on NVIDIA Developer](https://youtu.be/N_OOfkEWcOk).
4+
5+
This is a simple standalone implementation showing a minimal RAG pipeline that uses models available from [NVIDIA API Catalog](https://catalog.ngc.nvidia.com/ai-foundation-models).
6+
The catalog enables you to experience state-of-the-art LLMs accelerated by NVIDIA.
7+
Developers get free credits for 10K requests to any of the models.
8+
9+
The example uses an [integration package to LangChain](https://python.langchain.com/docs/integrations/providers/nvidia) to access the models.
10+
NVIDIA engineers develop, test, and maintain the open source integration.
11+
This example uses a simple [Streamlit](https://streamlit.io/) based user interface and has a one-file implementation.
12+
Because the example uses the models from the NVIDIA API Catalog, you do not need a GPU to run the example.
13+
14+
### Steps
15+
16+
1. Create a python virtual environment and activate it:
17+
18+
```comsole
19+
python3 -m virtualenv genai
20+
source genai/bin/activate
21+
```
22+
23+
1. From the root of this repository, `GenerativeAIExamples`, install the requirements:
24+
25+
```console
26+
pip install -r community/5_mins_rag_no_gpu/requirements.txt
27+
```
28+
29+
1. Add your NVIDIA API key as an environment variable:
30+
31+
```console
32+
export NVIDIA_API_KEY="nvapi-*"
33+
```
34+
35+
If you don't already have an API key, visit the [NVIDIA API Catalog](https://build.ngc.nvidia.com/explore/), select on any model, then click on `Get API Key`.
36+
37+
1. Run the example using Streamlit:
38+
39+
```console
40+
streamlit run community/5_mins_rag_no_gpu/main.py
41+
```
42+
43+
1. Test the deployed example by going to `http://<host_ip>:8501` in a web browser.
44+
45+
Click **Browse Files** and select your knowledge source.
46+
After selecting, click **Upload!** to complete the ingestion process.
47+
48+
You are all set now! Try out queries related to the knowledge base using text from the user interface.

0 commit comments

Comments
 (0)