wanshiiii commited on
Commit
c901d01
Β·
verified Β·
1 Parent(s): c7de626

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +41 -11
README.md CHANGED
@@ -1,14 +1,44 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- title: Grammar Assistant
3
- emoji: πŸ“Š
4
- colorFrom: indigo
5
- colorTo: pink
6
- sdk: streamlit
7
- sdk_version: 1.44.0
8
- app_file: app.py
9
- pinned: false
10
- license: mit
11
- short_description: An AI-powered grammar correction tool built with Streamlit a
 
 
 
 
 
12
  ---
13
 
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
1
+ # πŸ“ AI Grammar Assistant
2
+
3
+ A real-time grammar correction tool powered by **Hugging Face Transformers** and built with **Streamlit**.
4
+ Just type your sentence and get corrected output instantly β€” no API key needed!
5
+
6
+ ---
7
+
8
+ ## πŸš€ Features
9
+
10
+ - βœ… Grammar correction using `vennify/t5-base-grammar-correction`
11
+ - 🧠 Built with `transformers`, `torch`, and `streamlit`
12
+ - πŸ’» 100% local execution β€” runs directly in Hugging Face Spaces
13
+ - 🎯 Lightweight and fast for instant feedback
14
+
15
+ ---
16
+
17
+ ## πŸ“Έ Screenshot
18
+
19
+ ![App Screenshot](https://github.com/wanshika/grammar-assistant?tab=readme-ov-file#-screenshot)
20
+
21
  ---
22
+
23
+ ## πŸ› οΈ Tech Stack
24
+
25
+ - Streamlit
26
+ - Hugging Face Transformers
27
+ - Python (T5 Model: Text2Text Generation)
28
+
29
+ ---
30
+
31
+ ## πŸ“Œ How to Use
32
+
33
+ 1. Enter a grammatically incorrect sentence
34
+ 2. Click **Correct Grammar**
35
+ 3. See the corrected output instantly!
36
+
37
  ---
38
 
39
+ ## πŸ‘©β€πŸ’» Made by
40
+
41
+ **[Wanshika Patro](https://github.com/wanshika)**
42
+ Let’s connect on [GitHub](https://github.com/wanshika) or [LinkedIn](https://linkedin.com)
43
+
44
+ ---