Omar Solano commited on
Commit
defa98b
1 Parent(s): cebdf84

add installation instructions (#41)

Browse files

* add installation instructions

* remove title

* add divider

Files changed (1) hide show
  1. README.md +34 -0
README.md CHANGED
@@ -8,3 +8,37 @@ sdk_version: 3.50.2
8
  app_file: app.py
9
  pinned: false
10
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  app_file: app.py
9
  pinned: false
10
  ---
11
+ ---
12
+ This project creates a helpful and accurate AI chatbot, leveraging GPT-3.5-Turbo and a RAG pipeline, specifically designed to address student questions about artificial intelligence with precision and clarity.
13
+
14
+ ## Installation
15
+
16
+ Create a new Python environment
17
+
18
+ ```bash
19
+ python -m venv .venv
20
+ ```
21
+
22
+ Activate the environment
23
+
24
+ ```bash
25
+ source .venv/bin/activate
26
+ ```
27
+
28
+ Install the dependencies
29
+
30
+ ```bash
31
+ pip install -r requirements.txt
32
+ ```
33
+
34
+ ## Usage
35
+
36
+ ```bash
37
+ export ACTIVELOOP_TOKEN=...
38
+ export OPENAI_API_KEY=...
39
+ export MONGODB_URI=...
40
+ ```
41
+
42
+ ```bash
43
+ python app.py
44
+ ```