Group2255 commited on
Commit
24bb362
Β·
verified Β·
1 Parent(s): 2c577f7

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +19 -58
README.md CHANGED
@@ -1,89 +1,50 @@
1
  ---
2
- title: Unified AI Chatbot (AML-3304)
3
  emoji: πŸ€–
4
  colorFrom: blue
5
  colorTo: indigo
6
  sdk: streamlit
7
- sdk_version: "1.20.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
13
 
14
- ---
15
-
16
- # Unified AI Chatbot πŸ€–
17
 
18
- This is an **MVP AI chatbot project** for the **AML-3304 course assignment** titled:
 
 
 
19
 
20
- **β€œFrom Tokens to Transformers: Building AI Systems with Embeddings, Generative Models, and MLOps.”**
21
 
22
  ---
23
 
24
  ## πŸ”„ Supported Modes
25
 
26
- | Mode | Description | Model Used |
27
- |------|-------------|------------|
28
- | πŸ§‘β€πŸ’» Code Generator | Generate Python code from natural language | `Salesforce/codegen-350M-mono` |
29
- | πŸ“˜ General Q&A | Answer factual questions with reasoning | `google/flan-t5-base` |
30
- | πŸ“Š Bayesian Q&A | Sample-based Q&A with top-k decoding | `google/flan-t5-base` |
31
 
32
  ---
33
 
34
- ## πŸš€ Hosted on Hugging Face Spaces
35
 
36
- πŸ‘‰ [Live Demo](https://huggingface.co/spaces/YOUR_USERNAME/unified-chatbot)
37
- *(Replace YOUR_USERNAME after deployment)*
38
 
39
  ---
40
 
41
  ## πŸ’» Local Installation
42
 
43
- Clone the project and run locally with Python or Docker:
44
-
45
  ### Option 1: Python + Streamlit
46
 
47
  ```bash
48
- git clone https://github.com/YOUR_USERNAME/unified-chatbot
49
- cd unified-chatbot
50
  pip install -r requirements.txt
51
  streamlit run app.py
52
- ```
53
-
54
- ### Option 2: Docker
55
-
56
- ```bash
57
- docker build -t unified-chatbot .
58
- docker run -p 8501:8501 unified-chatbot
59
- ```
60
-
61
- Then open your browser at: `http://localhost:8501`
62
-
63
- ---
64
-
65
- ## πŸ“¦ Project Structure
66
-
67
- ```bash
68
- β”œβ”€β”€ app.py # Streamlit application
69
- β”œβ”€β”€ requirements.txt # Python dependencies
70
- β”œβ”€β”€ Dockerfile # Optional Docker support
71
- β”œβ”€β”€ README.md # This file
72
- └── space.yaml # (Optional) Hugging Face metadata
73
- ```
74
-
75
- ---
76
-
77
- ## πŸ“š Assignment Goals Covered
78
-
79
- - βœ… MVP AI chatbot with multiple generative models
80
- - βœ… Embeddings + Bayesian-style sampling
81
- - βœ… PyTorch backend (via Hugging Face Transformers)
82
- - βœ… MLOps-ready with Docker and GitHub Actions-ready design
83
- - βœ… Deployable on Hugging Face Spaces (CPU Basic)
84
-
85
- ---
86
-
87
- ## πŸ“œ License
88
-
89
- MIT License – Free for educational and non-commercial use.
 
1
  ---
2
+ title: RepoSage AI Chatbot (AML-3304)
3
  emoji: πŸ€–
4
  colorFrom: blue
5
  colorTo: indigo
6
  sdk: streamlit
7
+ sdk_version: 1.20.0
8
  app_file: app.py
9
  pinned: false
10
  ---
11
 
12
+ # πŸ€– RepoSage Unified Chatbot – AML-3304 Final Submission
13
 
14
+ This is our **MVP AI chatbot** for the AML-3304 course assignment:
15
+ **"From Tokens to Transformers: Building AI Systems with Embeddings, Generative Models, and MLOps."**
 
16
 
17
+ It brings together:
18
+ - 🧠 Bayesian-style Q&A
19
+ - πŸ“˜ General Q&A using FLAN-T5
20
+ - πŸ§‘β€πŸ’» Code Generation using CodeGen
21
 
22
+ All in a single unified Streamlit application β€” hosted live on Hugging Face Spaces.
23
 
24
  ---
25
 
26
  ## πŸ”„ Supported Modes
27
 
28
+ | Mode | Description | Model Used |
29
+ |-----------------|---------------------------------------|----------------------------------|
30
+ | πŸ§‘β€πŸ’» Code Generator | Generate Python code via prompt | `Salesforce/codegen-350M-mono` |
31
+ | πŸ“˜ General Q&A | Factual Q&A with FLAN reasoning | `google/flan-t5-base` |
32
+ | πŸ“Š Bayesian Q&A | Top-k sampling from embedding space | FLAN + custom Bayesian logic |
33
 
34
  ---
35
 
36
+ ## πŸš€ Live Demo
37
 
38
+ πŸ”— Hugging Face Space: [https://huggingface.co/spaces/Group2255/programming-help-chatbot](https://huggingface.co/spaces/Group2255/programming-help-chatbot)
 
39
 
40
  ---
41
 
42
  ## πŸ’» Local Installation
43
 
 
 
44
  ### Option 1: Python + Streamlit
45
 
46
  ```bash
47
+ git clone https://huggingface.co/spaces/Group2255/programming-help-chatbot
48
+ cd programming-help-chatbot
49
  pip install -r requirements.txt
50
  streamlit run app.py