hephaestusonfire commited on
Commit
f857211
·
verified ·
1 Parent(s): a390d6a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +14 -23
README.md CHANGED
@@ -4,48 +4,39 @@ emoji: ✍️
4
  colorFrom: blue
5
  colorTo: green
6
  sdk: gradio
7
- sdk_version: "4.0.0"
8
- python_version: "3.10"
9
  app_file: app.py
10
  pinned: false
11
  ---
12
 
13
  # ✍️ AI-Aware Writing Assistant
14
 
15
- A hybrid NLP + Transformer writing assistant. Fixes grammar and spelling, paraphrases in multiple styles, and shows optional text statistics.
16
 
17
  ## Features
18
 
19
- - **Grammar mode** — spelling correction → regex rules → neural GEC model (per-sentence, no truncation)
20
- - **Paraphrase mode** — rewrites in Neutral / Formal / Casual / Student essay / Technical style with synonym replacement and sentence-length variation
21
- - **Both** — grammar first, then paraphrase the cleaned result
22
- - **Diff highlighting** — red strikethrough for removed tokens, green underline for added tokens
23
- - **Dark / Light mode** — toggle in the header, preference saved across sessions
24
- - **Copy result** — one click to copy the accepted version to clipboard
25
- - **Text statistics** — word count, sentence count, Flesch readability, burstiness
26
 
27
  ## Models
28
 
29
  | Task | Model |
30
  |---|---|
31
- | Grammar correction | `vennify/t5-base-grammar-correction` (fallback: `prithivida/grammar_error_correcter_v1`) |
32
- | Paraphrasing | `Vamsi/T5_Paraphrase_Paws` |
33
-
34
- Both models fall back gracefully if unavailable.
35
 
36
  ## Running locally
37
 
38
  ```bash
39
  python -m venv .venv
40
- source .venv/bin/activate
41
  pip install -r requirements.txt
42
  python app.py
43
  # → http://127.0.0.1:7860
44
- ```
45
-
46
- ## Tuning
47
-
48
- - **Grammar rules** — edit `CUSTOM_GRAMMAR_RULES` in `config.py`
49
- - **Spelling dictionary** — extend `CUSTOM_SPELLING_RULES` in `config.py`
50
- - **Swap models** — change `GRAMMAR_MODEL_NAME` / `PARAPHRASE_MODEL_NAME` in `config.py`
51
- - **Decoding aggressiveness** — increase `T5_NUM_BEAMS` for more thorough (slower) search
 
4
  colorFrom: blue
5
  colorTo: green
6
  sdk: gradio
7
+ sdk_version: 6.15.2
8
+ python_version: '3.10'
9
  app_file: app.py
10
  pinned: false
11
  ---
12
 
13
  # ✍️ AI-Aware Writing Assistant
14
 
15
+ A hybrid NLP + Transformer writing assistant with a Docs-meets-Grammarly UI.
16
 
17
  ## Features
18
 
19
+ - **Grammar mode** — spelling correction → regex rules → neural GEC (per-sentence, no truncation)
20
+ - **Paraphrase mode** — Neutral / Formal / Casual / Student essay / Technical styles with synonym replacement and sentence-length variation
21
+ - **Both** — grammar first, then paraphrase
22
+ - **Diff highlighting** — red strikethrough for removals, green underline for additions
23
+ - **Dark / Light mode** — toggle in header, saved across sessions
24
+ - **Copy result** — one-click copy of the corrected text
25
+ - **Text statistics** — word count, Flesch readability, burstiness
26
 
27
  ## Models
28
 
29
  | Task | Model |
30
  |---|---|
31
+ | Grammar | `vennify/t5-base-grammar-correction` (fallback: `prithivida/grammar_error_correcter_v1`) |
32
+ | Paraphrase | `Vamsi/T5_Paraphrase_Paws` |
 
 
33
 
34
  ## Running locally
35
 
36
  ```bash
37
  python -m venv .venv
38
+ source .venv/bin/activate # Windows: .venv\Scripts\activate
39
  pip install -r requirements.txt
40
  python app.py
41
  # → http://127.0.0.1:7860
42
+ ```