Update README.md
Browse files
README.md
CHANGED
@@ -8,5 +8,74 @@ sdk_version: 1.42.0
|
|
8 |
app_file: app.py
|
9 |
pinned: false
|
10 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
11 |
|
12 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
8 |
app_file: app.py
|
9 |
pinned: false
|
10 |
---
|
11 |
+
# Solar Industry AI Assistant
|
12 |
+
|
13 |
+
A Streamlit-based web application that provides AI-powered responses to solar energy-related queries using Google's Gemini Pro model. The application features a user-friendly interface, chat history management, and solar domain-specific query filtering.
|
14 |
+
|
15 |
+
## Features
|
16 |
+
|
17 |
+
- π€ AI-powered responses using Google's Gemini Pro model
|
18 |
+
- βοΈ Solar energy domain-specific query filtering
|
19 |
+
- π¬ Interactive chat interface with history tracking
|
20 |
+
- πΎ Export chat history functionality
|
21 |
+
- π¨ Modern and responsive UI design
|
22 |
+
- π€ Developer profile and contact information
|
23 |
+
|
24 |
+
## Installation
|
25 |
+
|
26 |
+
1. Clone the repository:
|
27 |
+
```bash
|
28 |
+
git clone https://github.com/yourusername/solar-industry-ai-assistant.git
|
29 |
+
cd solar-industry-ai-assistant
|
30 |
+
```
|
31 |
+
|
32 |
+
2. Install the required dependencies:
|
33 |
+
```bash
|
34 |
+
pip install -r requirements.txt
|
35 |
+
```
|
36 |
+
|
37 |
+
3. Create a `config.py` file with your Google API key:
|
38 |
+
```python
|
39 |
+
API_KEY = "your-google-api-key"
|
40 |
+
```
|
41 |
+
|
42 |
+
## Usage
|
43 |
+
|
44 |
+
1. Run the Streamlit application:
|
45 |
+
```bash
|
46 |
+
streamlit run test.py
|
47 |
+
```
|
48 |
+
|
49 |
+
2. Open your web browser and navigate to the local URL provided by Streamlit (typically http://localhost:8501)
|
50 |
+
|
51 |
+
3. Enter your solar energy-related questions in the text area and click "Get Answer"
|
52 |
+
|
53 |
+
## Project Structure
|
54 |
+
|
55 |
+
- `test.py`: Main application file containing the Streamlit UI and core functionality
|
56 |
+
- `filter.py`: Module for filtering solar energy-related queries
|
57 |
+
- `config.py`: Configuration file for API keys and other settings
|
58 |
+
- `requirements.txt`: List of Python dependencies
|
59 |
+
- `README.md`: Project documentation
|
60 |
+
|
61 |
+
## Contributing
|
62 |
+
|
63 |
+
1. Fork the repository
|
64 |
+
2. Create a new branch for your feature
|
65 |
+
3. Commit your changes
|
66 |
+
4. Push to the branch
|
67 |
+
5. Create a Pull Request
|
68 |
+
|
69 |
+
## License
|
70 |
+
|
71 |
+
This project is licensed under the MIT License - see the LICENSE file for details.
|
72 |
+
|
73 |
+
## Contact
|
74 |
+
|
75 |
+
- Uditanshu Pandey
|
76 |
+
- Email: [email protected]
|
77 |
+
- LinkedIn: [LinkedIn Profile](https://www.linkedin.com/in/uditanshupandey?lipi=urn%3Ali%3Apage%3Ad_flagship3_profile_view_base_contact_details%3BqqRVF%2FNpRheKgruh2Qy9aw%3D%3D)
|
78 |
+
- GitHub: [GitHub Profile](https://github.com/UditanshuPandey)
|
79 |
+
|
80 |
|
81 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|