Spaces:
Sleeping
Sleeping
updated README
Browse files
README.md
CHANGED
|
@@ -1,11 +1,45 @@
|
|
| 1 |
---
|
| 2 |
title: Book Broomva Chat
|
| 3 |
-
emoji:
|
| 4 |
colorFrom: gray
|
| 5 |
-
colorTo:
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
license: mit
|
| 9 |
---
|
| 10 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
| 1 |
---
|
| 2 |
title: Book Broomva Chat
|
| 3 |
+
emoji: 🪼
|
| 4 |
colorFrom: gray
|
| 5 |
+
colorTo: blue
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
| 8 |
license: mit
|
| 9 |
---
|
| 10 |
|
| 11 |
+
# Broomva's Tech Book Chat
|
| 12 |
+
|
| 13 |
+
## Introduction
|
| 14 |
+
This chat application leverages the power of Langchain QA retriever to access and utilize the rich information from the Broomva's Tech Book repository. Aimed at providing instant, accurate responses to technical queries, our app serves as a valuable tool for professionals and enthusiasts in the tech field.
|
| 15 |
+
|
| 16 |
+
## Features and Functionality
|
| 17 |
+
- **Real-time QA**: Utilizes Langchain QA retriever for fetching answers from Broomva's repository.
|
| 18 |
+
- **Topic Coverage**: Broad range of topics from energy, oil, and gas industries to general tech queries.
|
| 19 |
+
- **Interactive Interface**: User-friendly chat for querying and receiving information.
|
| 20 |
+
- **Continuous Learning**: Regularly updated with the latest content from Broomva's Tech Book.
|
| 21 |
+
|
| 22 |
+
## Installation and Setup
|
| 23 |
+
1. Clone the repository: `git clone https://github.com/your-repo/chat-app.git`
|
| 24 |
+
2. Navigate to the app directory: `cd chat-app`
|
| 25 |
+
3. Install dependencies: `pip install -r requirements.txt`
|
| 26 |
+
4. Set up environment variables for Langchain credentials.
|
| 27 |
+
|
| 28 |
+
## Usage
|
| 29 |
+
- Start the app: `python app.py`
|
| 30 |
+
- Use the chat interface to ask questions like "What is MLFlow in Databricks?"
|
| 31 |
+
- Receive concise, accurate answers sourced from Broomva's Tech Book.
|
| 32 |
+
|
| 33 |
+
## Integrating Broomva's Tech Book
|
| 34 |
+
The app integrates the Tech Book by querying the repository's contents using the Langchain QA retriever. The retriever is configured to parse and understand technical documentation, making it ideal for fetching relevant information from the repository.
|
| 35 |
+
|
| 36 |
+
## Contributing
|
| 37 |
+
We welcome contributions! Please read our contributing guidelines on how to propose bugfixes, updates, or new features.
|
| 38 |
+
|
| 39 |
+
## License
|
| 40 |
+
This project is licensed under the MIT License - see the LICENSE file for details.
|
| 41 |
+
|
| 42 |
+
## Contact and Support
|
| 43 |
+
For support or queries, please reach out to us at [[email protected]](mailto:[email protected]).
|
| 44 |
+
|
| 45 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|