| --- |
| title: ByteBot |
| emoji: 🤖 |
| colorFrom: indigo |
| colorTo: red |
| sdk: gradio |
| sdk_version: 5.21.0 |
| app_file: app.py |
| pinned: false |
| --- |
| |
| # 🤖 ByteBot: Your CS Companion |
|
|
| ByteBot is a friendly and knowledgeable virtual assistant designed to simplify the complexities of Computer Science. From explaining algorithms to debugging code, ByteBot provides clear explanations and personalized guidance tailored to your learning needs. Whether you're a beginner or an expert, ByteBot is here to empower you on your coding journey. |
|
|
| ## 📝 Description |
|
|
| ByteBot serves as a comprehensive resource for users seeking clarity on various Computer Science topics. Employing a user-centric approach, it endeavors to elucidate queries and concepts using accessible language and practical examples. Following explanations, the chatbot proactively assesses user comprehension, ensuring clarity and understanding. By seamlessly integrating theory with real-world applications, it empowers users to grasp complex CS concepts with confidence and ease. |
|
|
| ## What it Does |
|
|
| ByteBot is an AI chatbot designed to simplify Computer Science concepts. It provides explanations, examples, and personalized guidance to users, helping them understand various topics in the field. |
|
|
| ## Features |
|
|
| - **GUI**: It has Graphical User Interface (GUI) for user convenience. |
| - **Personalized Assistance**: It tailors its responses to user queries, ensuring a customized learning experience. |
| - **Multi-turn Conversation**: It supports multi-turn conversations, allowing for deeper exploration of topics. |
| - **Easy Installation**: It can be easily installed using the provided instructions. |
|
|
| ## Installation |
|
|
| 1. **Clone the Repository**: |
|
|
| ```bash |
| git clone https://huggingface.co/spaces/CoderNoah/ByteBot |
| ``` |
|
|
| 2. **Create a Virtual Environment**: |
|
|
| ```bash |
| python -m venv .venv |
| ``` |
|
|
| 3. **Activate the Virtual Environment**: |
|
|
| - Linux: |
|
|
| ```bash |
| source .venv/bin/activate |
| ``` |
|
|
| - Windows: |
|
|
| ```bash |
| .venv/Scripts/activate |
| ``` |
|
|
| 4. **Install Dependencies**: |
|
|
| ```bash |
| pip install -r requirements.txt |
| ``` |
|
|
| ## Usage |
|
|
| 1. **Get Gemini API Key**: |
|
|
| Get your Gemini API key at [Gemini API Key](https://aistudio.google.com/). |
|
|
| 2. **Create `.env` File**: |
|
|
| ```bash |
| code .env |
| ``` |
|
|
| 3. **Add API Key to `.env`**: |
|
|
| ```bash |
| GOOGLE_API_KEY=YOUR_API_KEY |
| ``` |
|
|
| Replace `YOUR_API_KEY` with your Gemini API key. |
|
|
| 4. **Run the App**: |
|
|
| ```bash |
| python app.py |
| ``` |
|
|
| Open your web browser and visit [http://127.0.0.1:7860](http://127.0.0.1:7860). |
|
|
|
|
| ## Technologies Used |
|
|
| 1. **Python**: Programming language used for development. |
| 2. **Gemini API**: API for accessing additional features. |
| 3. **Gradio**: Library for creating GUI interfaces. |
|
|
| Happy coding! 🤖💻 |
|
|
| Made with ❤️ by Noah. |
|
|
|
|
