new

README.md

@@ -1,8 +1,68 @@
-title: HuggingFaceH4 Zephyr 7b Alpha
-emoji: ⚡
-colorFrom: purple
-colorTo: red
+---
+title: AnalyticsVidya Assignment
+emoji: 💬
+colorFrom: yellow
+colorTo: purple
 sdk: gradio
-sdk_version: 5.5.0
+sdk_version: 5.0.1
 app_file: app.py
-pinned: false
+pinned: false
+short_description: This smart search feature should now be live on Hugging Face
+license: mit
+---
+
+An example chatbot using [Gradio](https://gradio.app), [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/v0.22.2/en/index), and the [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index).
+
+Analytics Vidhya Course Chatbot
+
+This project is a chatbot interface designed to help users explore courses on Analytics Vidhya. The chatbot, built using Gradio and Python, provides information on course offerings, content, instructors, ratings, pricing, and more. This tool is useful for users seeking quick guidance on the Analytics Vidhya course catalog, making it easier to find courses based on specific learning objectives.
+Features
+
+    Course Information: Provides details on course titles, ratings, lesson counts, and prices.
+    Customized Responses: Bot assists users with tailored recommendations based on their queries about Analytics Vidhya courses.
+    Gradio Interface: A user-friendly UI built with Gradio for seamless interaction with the chatbot.
+    Data Scraping: Course data is scraped from the Analytics Vidhya website using BeautifulSoup.
+    Embedding Support: Uses embeddings for enhanced search capability, allowing users to receive more accurate course recommendations.
+
+Installation
+
+To run this project locally, follow these steps:
+
+    Clone the Repository
+
+git clone https://github.com/your-username/analytics-vidhya-course-chatbot.git
+cd analytics-vidhya-course-chatbot
+
+Install Dependencies This project requires Python 3.10+ and the following libraries:
+
+pip install -r requirements.txt
+
+Run the Application
+
+    python app.py
+
+Usage
+
+    Open the Gradio interface on your browser.
+    Enter a question or request information about a specific course.
+    The bot will respond with details such as course title, lesson count, review ratings, and price.
+
+Example Queries
+
+    "What are the top courses on Analytics Vidhya?"
+    "Can you recommend courses related to data science?"
+    "What’s the lesson count and rating for the 'Introduction to Business Analytics' course?"
+
+File Structure
+
+    app.py - Main application file that defines the Gradio interface and chatbot functionality.
+    scraper.py - Contains the code for scraping course data from the Analytics Vidhya website.
+    requirements.txt - Lists the dependencies required to run the project.
+    README.md - Project documentation.
+
+Dependencies
+
+    gradio: For building the user interface.
+    beautifulsoup4: For web scraping course details.
+    pandas: For handling scraped data.
+    sentence-transformers: For generating embeddings to enhance search relevance.