Ashish08 commited on
Commit
28352d5
1 Parent(s): 6ece7e5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +44 -1
README.md CHANGED
@@ -10,4 +10,47 @@ pinned: false
10
  license: creativeml-openrail-m
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  license: creativeml-openrail-m
11
  ---
12
 
13
+
14
+ # GPT-3 Trip Scheduler
15
+
16
+ ## Overview
17
+ The GPT-3 Trip Scheduler is a Streamlit-based application that leverages the power of OpenAI's GPT-3.5 to assist users in planning their trips efficiently. By entering their destination, arrival, and departure details, users can generate a detailed trip schedule that respects their time and preferences.
18
+
19
+ ## Features
20
+ - **Destination Input:** Users can input their desired trip destination. The app provides a default random destination from a predefined list for convenience.
21
+ - **Arrival & Departure Details:** Users can specify detailed arrival and departure information, including the type of station (Airport, Train Station, Bus Station, etc.), date, and time.
22
+ - **Additional Information:** Users can input any additional information or specific requests they have for their trip, allowing the GPT-3 model to tailor the trip schedule to their needs.
23
+ - **Trip Schedule Generation:** The app utilizes OpenAI's GPT-3 model to generate a comprehensive trip schedule based on the user's input.
24
+
25
+ ## Installation
26
+
27
+ ### Requirements
28
+ - Python 3.8 or higher
29
+ - Streamlit
30
+ - OpenAI's GPT-3.5 API
31
+ - Other dependencies listed in `requirements.txt`
32
+
33
+ ### Setup
34
+ 1. **Clone the Repository:**
35
+ ```bash
36
+ git clone https://github.com/your-repository/gpt-3-trip-scheduler.git
37
+ cd gpt-3-trip-scheduler
38
+ ```
39
+
40
+ 2. **Install Dependencies:**
41
+ ```bash
42
+ pip install --no-cache-dir -r requirements.txt
43
+ ```
44
+
45
+ 3. **Environment Variables:**
46
+ Set the `OPENAI_API` environment variable in a `.env` file:
47
+ ```env
48
+ OPENAI_API=your_openai_api_key_here
49
+ ```
50
+ Make sure the `.env` file is in the root directory of the project.
51
+
52
+ ### Running the App
53
+ To run the app, navigate to the project directory and execute the following command:
54
+ ```bash
55
+ streamlit run app.py
56
+