Kushagra8041 commited on
Commit
77f9e88
·
verified ·
1 Parent(s): dca7cbc

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +36 -1
README.md CHANGED
@@ -12,4 +12,39 @@ hf_oauth_scopes:
12
  - inference-api
13
  ---
14
 
15
- 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).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
  - inference-api
13
  ---
14
 
15
+ # 🎓 EEE-Educator: Specialized Pedagogical Agent
16
+ ### Powered by Llama-3.1-8B-Instant & Groq LPU™
17
+
18
+ **EEE-Educator** is an AI-driven tutoring system designed to assist students with the fundamentals of **Electrical and Electronics Engineering (EEE)**. This project serves as a bridge between high-performance LLM engineering and domain-specific educational technology.
19
+
20
+ ---
21
+
22
+ ## 🚀 The Technical "Core"
23
+ As an AIML student, I built this space to explore the limits of **low-latency inference** and **specialized guardrails**.
24
+
25
+ * **Inference Engine:** Optimized via **Groq LPU™**, achieving speeds of **500+ tokens per second**, making the tutoring experience feel instantaneous.
26
+ * **Model:** `llama-3.1-8b-instant` — chosen for its high-reasoning capabilities within a compact parameter count.
27
+ * **System Architecture:** A hybrid deployment using **Hugging Face Spaces** for the Gradio frontend and **Groq Cloud** for backend compute.
28
+
29
+ ## 🎯 Key Functionalities
30
+ * **Domain Focus:** Provides structured explanations on Circuit Theory, Semiconductor Devices, and Power Systems.
31
+ * **Interactive Tutoring:** The model is prompted to act as a Socratic tutor—asking follow-up questions to test user understanding rather than just giving answers.
32
+ * **Safety Guardrails:** Includes a custom instruction layer that prevents the model from deviating into non-engineering topics, ensuring it remains a dedicated study tool.
33
+
34
+ ## 🛠️ Tech Stack
35
+ * **Language:** Python
36
+ * **Interface:** Gradio
37
+ * **LLM Framework:** Groq API / Meta Llama 3.1
38
+ * **Deployment:** Hugging Face (Syncing with GitHub)
39
+
40
+ ## 📖 Sample Interactions
41
+ > **User:** "Explain KVL in simple terms."
42
+ > **EEE-AI:** [Provides explanation] + "Would you like a practice circuit problem to test this law?"
43
+
44
+ > **User:** "What's the best movie to watch tonight?"
45
+ > **EEE-AI:** "I am focused on your engineering success! Let's get back to EEE—perhaps we can discuss how Signal Processing is used in movie audio instead?"
46
+
47
+ ---
48
+ ## 👷 About the Developer
49
+ **Kushagra Gaur** | *Curious from Core*
50
+ This project was developed to master the integration of high-speed inference APIs and the implementation of domain-specific constraints in LLMs.