daveckw commited on
Commit
ca27c3a
·
1 Parent(s): b4b021f

Edit README.md

Browse files
Files changed (1) hide show
  1. README.md +55 -2
README.md CHANGED
@@ -9,5 +9,58 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
13
- gpt-3.5-turbo
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  pinned: false
10
  ---
11
 
12
+ # Custom-trained AI Chatbot
13
+
14
+ This repository contains a custom-trained AI chatbot that uses OpenAI's GPT-3.5 Turbo model to provide responses based on a user's input. The chatbot utilizes an index of documents to generate relevant and informative responses.
15
+
16
+ ## Prerequisites
17
+
18
+ Before you begin, ensure you have the following installed on your machine:
19
+
20
+ - Python 3.6 or higher
21
+ - [pip](https://pip.pypa.io/en/stable/installation/)
22
+
23
+ ## Installation
24
+
25
+ 1. Clone the repository:
26
+ `git clone https://github.com/yourusername/your-repo-name.git`
27
+ `cd your-repo-name`
28
+
29
+ 2. Install the required packages:
30
+ `pip install -r requirements.txt`
31
+
32
+ 3. Create a `.env` file in the project's root directory and add your OpenAI API key:
33
+ `OPENAI_API_KEY=your_openai_api_key`
34
+
35
+ ## ChatGPT model name
36
+
37
+ `model_name="gpt-3.5-turbo"`
38
+
39
+ _Most capable GPT-3.5 model and optimized for chat at 1/10th the cost of text-davinci-003._
40
+
41
+ or
42
+
43
+ `model_name="text-davinci-003"`
44
+
45
+ ## Usage
46
+
47
+ 1. Place your documents in the `docs` directory.
48
+
49
+ 2. Run the `app.py` script:
50
+
51
+ `python app.py`
52
+
53
+ 3. Open the Gradio interface in your web browser, enter your text in the input textbox, and click "Submit" to get a response from the chatbot.
54
+
55
+ ## Contributing
56
+
57
+ Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
58
+
59
+ ## Setup at Hugging Face
60
+
61
+ Check out the configuration reference at
62
+ https://huggingface.co/docs/hub/spaces-config-reference
63
+
64
+ ## License
65
+
66
+ [MIT](https://choosealicense.com/licenses/mit/)