Omar Solano commited on
Commit
30e4265
Β·
1 Parent(s): ec243e8

update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -7
README.md CHANGED
@@ -4,14 +4,16 @@ emoji: πŸ§‘πŸ»β€πŸ«
4
  colorFrom: gray
5
  colorTo: pink
6
  sdk: gradio
7
- sdk_version: 4.19.2
8
  app_file: scripts/gradio-ui.py
9
  pinned: false
10
  ---
11
- ---
12
- This project creates a helpful and accurate AI Tutor chatbot, leveraging GPT-3.5-Turbo and a RAG system. We design it to address student questions about AI with precision and clarity.
13
 
14
- ### Installation
 
 
 
 
15
 
16
  1. **Create a new Python environment:**
17
 
@@ -35,15 +37,14 @@ This project creates a helpful and accurate AI Tutor chatbot, leveraging GPT-3.5
35
  pip install -r requirements.txt
36
  ```
37
 
38
- ### Usage
39
 
40
  1. **Set environment variables:**
41
 
42
- Before running the application, you need to set up your OpenAI API key and MongoDB URI as environment variables:
43
 
44
  ```bash
45
  export OPENAI_API_KEY=your_openai_api_key_here
46
- export MONGODB_URI=your_mongodb_uri_here
47
  ```
48
 
49
  2. **Run the application:**
 
4
  colorFrom: gray
5
  colorTo: pink
6
  sdk: gradio
7
+ sdk_version: 4.31.3
8
  app_file: scripts/gradio-ui.py
9
  pinned: false
10
  ---
 
 
11
 
12
+ This repository contains the notebooks for the RAG AI tutor course in [notebooks](./notebooks).
13
+
14
+ A Gradio UI for an AI tutor chatbot is available in [scripts](./scripts/gradio-ui.py).
15
+
16
+ ### Installation (for Gradio UI)
17
 
18
  1. **Create a new Python environment:**
19
 
 
37
  pip install -r requirements.txt
38
  ```
39
 
40
+ ### Usage (for Gradio UI)
41
 
42
  1. **Set environment variables:**
43
 
44
+ Before running the application, you need to set up your OpenAI API key:
45
 
46
  ```bash
47
  export OPENAI_API_KEY=your_openai_api_key_here
 
48
  ```
49
 
50
  2. **Run the application:**